Skip to content

Latest commit

 

History

History
633 lines (503 loc) · 11.8 KB

Set-KshSite.md

File metadata and controls

633 lines (503 loc) · 11.8 KB
Raw
external help file Module Name online version schema
SPClientCore.dll-Help.xml
SPClientCore
2.0.0

Set-KshSite

SYNOPSIS

Updates a site.

SYNTAX

Set-KshSite [[-Identity] <Site>] [-AllowAutomaticASPXPageIndexing <Boolean>] [-AlternateCssUrl <String>]
 [-CommentsOnSitePagesDisabled <Boolean>] [-ContainsConfidentialInfo <Boolean>] [-CustomMasterUrl <String>]
 [-DisableAppViews <Boolean>] [-DisableFlows <Boolean>] [-Description <String>]
 [-EnableMinimalDownload <Boolean>] [-ExcludeFromOfflineClient <Boolean>] [-FooterEnabled <Boolean>]
 [-FooterLayout <FooterLayoutType>] [-HeaderEmphasis <VariantThemeType>] [-HeaderLayout <HeaderLayoutType>]
 [-HorizontalQuickLaunch <Boolean>] [-LogoAlignment <LogoAlignment>] [-MasterUrl <String>]
 [-MembersCanShare <Boolean>] [-MegaMenuEnabled <Boolean>] [-NavAudienceTargetingEnabled <Boolean>]
 [-NoCrawl <Boolean>] [-ObjectCacheEnabled <Boolean>] [-OverwriteTranslationsOnChange <Boolean>]
 [-QuickLaunchEnabled <Boolean>] [-RequestAccessEmail <String>] [-SaveSiteAsTemplateEnabled <Boolean>]
 [-SearchScope <SearchScopeType>] [-ServerRelativeUrl <String>] [-SiteLogoDescription <String>]
 [-SiteLogoUrl <String>] [-SyndicationEnabled <Boolean>] [-ThemedCssFolderUrl <String>] [-Title <String>]
 [-TreeViewEnabled <Boolean>] [-UIVersion <Int32>] [-UIVersionConfigurationEnabled <Boolean>] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

The Set-KshSite cmdlet updates properties of the site.

EXAMPLES

Example 1

PS C:\> Set-KshSite -Identity (Get-KshSite -SiteId 'd298e576-6985-4119-9796-050b9f371872') -NoCrawl $true

Updates property values of the site.

PARAMETERS

-AllowAutomaticASPXPageIndexing

Specifies whether to allow automatic indexing of ASPX pages.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AlternateCssUrl

Specifies the alternate CSS URL.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CommentsOnSitePagesDisabled

Specifies whether to disable comment on site pages.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ContainsConfidentialInfo

Specifies whether to allow to contain confidential information.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CustomMasterUrl

Specifies the custom master URL.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Specifies the description.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisableAppViews

Specifies whether to disable the app views.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DisableFlows

Specifies whether to disable the Microsoft Flow.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableMinimalDownload

Specifies whether to enable minimal download.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludeFromOfflineClient

Specifies whether to exclude from offline client.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FooterEnabled

Specifies whether to enable footer.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FooterLayout

Specifies the footer layout type.

Type: FooterLayoutType
Parameter Sets: (All)
Aliases:
Accepted values: Simple, Extended, Stacked

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderEmphasis

Specifies the header emphasis type.

Type: VariantThemeType
Parameter Sets: (All)
Aliases:
Accepted values: None, Neutral, Soft, Strong

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HeaderLayout

Specifies the header layout type.

Type: HeaderLayoutType
Parameter Sets: (All)
Aliases:
Accepted values: None, Standard, Compact, Minimal

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HorizontalQuickLaunch

Specifies whether to show horizontal quick launch.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Specifies the site.

Type: Site
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-LogoAlignment

Specifies the logo alignment.

Type: LogoAlignment
Parameter Sets: (All)
Aliases:
Accepted values: Left, Middle, Right

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MasterUrl

Specifies the master URL.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MegaMenuEnabled

Specifies whether to enable mega menu.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MembersCanShare

Specify whether members are allowed to share.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NavAudienceTargetingEnabled

Specify whether to enable navigation audience targeting.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoCrawl

Specifies whether to suppress to search crawling.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ObjectCacheEnabled

Specifies whether to enable object cache.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OverwriteTranslationsOnChange

Specifies whether to overwrite translations.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

If specified, returns the updated object.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-QuickLaunchEnabled

Specifies whether to enable quick launch.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RequestAccessEmail

Specifies the e-mail address for access request.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SaveSiteAsTemplateEnabled

Specifies whether to enable saving the site as a template.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SearchScope

Specifies the search scope.

Type: SearchScopeType
Parameter Sets: (All)
Aliases:
Accepted values: DefaultScope, Tenant, Hub, Site

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ServerRelativeUrl

Specifies the site relative URL.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SiteLogoDescription

Specifies the site logo description.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SiteLogoUrl

Specifies the site logo URL.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SyndicationEnabled

Specifies whether to enable syndication.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThemedCssFolderUrl

Specifies the themed CSS folder URL.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Title

Specifies the title.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TreeViewEnabled

Specifies whether to enable tree view.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UIVersion

Specifies the UI Version.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UIVersionConfigurationEnabled

Specifies whether to enable UI version configuration.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Karamem0.SharePoint.PowerShell.Models.V1.Site

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.V1.Site

NOTES

RELATED LINKS