Set-PnPSite
SYNOPSIS
Sets site collection properties.
SYNTAX
Set Properties
Set-PnPSite [-Identity <String>]
[-Classification <String>]
[-DisableFlows]
[-LogoFilePath <String>]
[-Sharing <SharingCapabilities>]
[-StorageMaximumLevel <Int64>]
[-StorageWarningLevel <Int64>]
[-AllowSelfServiceUpgrade]
[-NoScriptSite]
[-Owners <System.Collections.Generic.List<[System.String]>]
[-CommentsOnSitePagesDisabled]
[-DefaultLinkPermission <SharingPermissionType>]
[-DefaultSharingLinkType <SharingLinkType>]
[-DefaultLinkToExistingAccess <Boolean>]
[-DefaultLinkToExistingAccessReset]
[-DisableAppViews <AppViewsPolicy>]
[-DisableCompanyWideSharingLinks <CompanyWideSharingLinksPolicy>]
[-DisableSharingForNonOwners]
[-LocaleId <UInt32>]
[-RestrictedToGeo <RestrictedToRegion>]
[-SocialBarOnSitePagesDisabled]
[-AnonymousLinkExpirationInDays <Int32>]
[-RequestFilesLinkExpirationInDays <Int32>]
[-OverrideTenantAnonymousLinkExpirationPolicy]
[-MediaTranscription <MediaTranscriptionPolicyType>]
[-SensitivityLabel <Guid>]
[-RequestFilesLinkEnabled <Boolean>]
[-ScriptSafeDomainName <string>]
[-BlockDownloadPolicy <Boolean>] [-ExcludeBlockDownloadPolicySiteOwners <Boolean>]
[-ExcludedBlockDownloadGroupIds <Guid[]>]
[-ListsShowHeaderAndNavigation <Boolean>]
[-EnableAutoExpirationVersionTrim <Boolean>]
[-ExpireVersionsAfterDays <UInt32>]
[-MajorVersions <UInt32>]
[-MinorVersions <UInt32>]
[-InheritTenantVPForNewDocLibs]
[-ApplyForNewLibs]
[-ApplyForExistingLibs]
[-CancelVPForExistingLibs]
[-Connection <PnPConnection>]
Set Lock State
Set-PnPSite [-Identity <String>] [-LockState <SiteLockState>] [-Wait] [-Connection <PnPConnection>]
DESCRIPTION
Allows to modify a site properties.
EXAMPLES
EXAMPLE 1
Set-PnPSite -Classification "HBI"
Sets the current site classification tag to HBI
EXAMPLE 2
Set-PnPSite -Classification $null
Un-sets the current site classification tag
EXAMPLE 3
Set-PnPSite -DisableFlows
Disables Microsoft Flow for this site, and also hides the Flow button from the ribbon
EXAMPLE 4
Set-PnPSite -DisableFlows:$false
Enables Microsoft Flow for this site
EXAMPLE 5
Set-PnPSite -LogoFilePath c:\images\mylogo.png
Sets the logo if the site is a modern team site without a Microsoft 365 Group behind it. Check the notes below for options for other types of sites.
EXAMPLE 6
Set-PnPSite -NoScriptSite $false
Allows custom script on a specific site. See Allow or prevent custom script for more information.
EXAMPLE 7
Set-PnPSite -EnableAutoExpirationVersionTrim $true
Set AutoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
EXAMPLE 8
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 10 -ExpireVersionsAfterDays 200
Set ExpireAfter file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
EXAMPLE 9
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -MinorVersions 20 -ExpireVersionsAfterDays 0
Set NoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
EXAMPLE 10
Set-PnPSite -InheritTenantVPForNewDocLibs
Clear the file version setting on a site. The new document libraries will use the tenant level setting.
EXAMPLE 11
Set-PnPSite -EnableAutoExpirationVersionTrim $true -ApplyForNewLibs
Set AutoExpiration file version trim mode for a site. The new document libraries will use this version setting.
EXAMPLE 12
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -ExpireVersionsAfterDays 200 -ApplyForNewLibs
Set ExpireAfter file version trim mode for a site. The new document libraries will use this version setting.
EXAMPLE 13
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -ExpireVersionsAfterDays 0 -ApplyForNewLibs
Set NoExpiration file version trim mode for a site. The new document libraries will use this version setting.
EXAMPLE 14
Set-PnPSite -EnableAutoExpirationVersionTrim $true -ApplyForExistingLibs
Create a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
EXAMPLE 15
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 5 -ExpireVersionsAfterDays 200 -ApplyForExistingLibs
Create a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
EXAMPLE 16
Set-PnPSite -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MinorVersions 5 -ExpireVersionsAfterDays 0 -ApplyForExistingLibs
Create a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
EXAMPLE 17
Set-PnPSite -CancelVPForExistingLibs
Cancel the existing request which sets the file version trim mode for existing document libraries on a site.
PARAMETERS
-AllowSelfServiceUpgrade
Specifies if the site administrator can upgrade the site collection.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AnonymousLinkExpirationInDays
Specifies all anonymous/anyone links that have been created (or will be created) will expire after the set number of days. Only applies if OverrideTenantAnonymousLinkExpirationPolicy is set to true.
To remove the expiration requirement, set the value to zero (0).
Type: Int32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequestFilesLinkExpirationInDays
Specifies the number of days before a Request Files link expires for the site.
The value can be from 0 to 730 days.
Type: Int32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Classification
The classification tag to set. This is the old classification/labeling method. Set it to $null to remove the classification entirely.
Type: String
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SensitivityLabel
The Microsoft Purview sensitivity label to set. This is the new classification/labeling method.
Type: String
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CommentsOnSitePagesDisabled
Specifies if comments on site pages are enabled or disabled.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultLinkPermission
Specifies the default link permission for the site collection. None - Respect the organization default link permission. View - Sets the default link permission for the site to "view" permissions. Edit - Sets the default link permission for the site to "edit" permissions
Type: SharingPermissionType
Parameter Sets: Set Properties
Accepted values: None, View, Edit
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultSharingLinkType
Specifies the default link type for the site collection. None - Respect the organization default sharing link type. AnonymousAccess - Sets the default sharing link for this site to an Anonymous Access or Anyone link. Internal - Sets the default sharing link for this site to the "organization" link or company shareable link. Direct - Sets the default sharing link for this site to the "Specific people" link
Type: SharingLinkType
Parameter Sets: Set Properties
Accepted values: None, Direct, Internal, AnonymousAccess
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultLinkToExistingAccess
When set to $true, the DefaultSharingLinkType will be overridden and the default sharing link will be All People with Existing Access link (which does not modify permissions). When set to $false (the default), the default sharing link type is controlled by the DefaultSharingLinkType parameter
Type: Boolean
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DisableAppViews
Determines whether the App Views feature is disabled in the site collection.
Type: AppViewsPolicy
Parameter Sets: Set Properties
Accepted values: Unknown, Disabled, NotDisabled
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisableCompanyWideSharingLinks
Determines whether company-wide sharing links are disabled in collection.
Type: CompanyWideSharingLinksPolicy
Parameter Sets: Set Properties
Accepted values: Unknown, Disabled, NotDisabled
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisableFlows
Disables Microsoft Flow for this site.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisableSharingForNonOwners
Specifies whether non-owners should be prevented from inviting new users to the site. Setting this will also disable Access Request Emails.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The url of the site collection.
Type: String
Parameter Sets: (All)
Aliases: Url
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LocaleId
Specifies the language of this site collection.
Type: UInt32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LockState
Sets the lockState of a site collection.
Type: SiteLockState
Parameter Sets: Set Lock State
Accepted values: Unlock, NoAccess, ReadOnly
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LogoFilePath
Sets the logo of the site if it is a modern team site without a Microsoft 365 Group behind it. Provide a full path to a local image file on your disk which you want to use as the site logo. The logo will be uploaded automatically to SharePoint.
If you want to set the logo for a classic site, use Set-PnPWeb -SiteLogoUrl instead.
If the modern site has a Microsoft 365 Group behind it, use Set-PnPWebHeader -SiteLogoUrl instead.
Type: String
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NoScriptSite
Specifies if a site allows custom script or not. See Allow or prevent custom script for more information.
Type: SwitchParameter
Parameter Sets: Set Properties
Aliases: DenyAndAddCustomizePages
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OverrideTenantAnonymousLinkExpirationPolicy
Specifies whether to use company-wide or a site collection level anonymous links expiration policy. Set it to true to get advantage of AnonymousLinkExpirationInDays.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Owners
Specifies owner(s) to add as site collection administrators. They will be added as additional site collection administrators. Existing administrators will stay. Can be both users and groups.
Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RestrictedToGeo
Specifies the Geo/Region restrictions of this site.
Type: RestrictedToRegion
Parameter Sets: Set Properties
Accepted values: NoRestriction, BlockMoveOnly, BlockFull, Unknown
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Sharing
Specifies what the sharing capabilities are for the site. Possible values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly
Type: SharingCapabilities
Parameter Sets: Set Properties
Accepted values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SocialBarOnSitePagesDisabled
Disables or enables the Social Bar for site collection.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StorageMaximumLevel
Specifies the storage quota for this site collection in megabytes. This value must not exceed the company's available quota.
Type: Int64
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StorageWarningLevel
Specifies the warning level for the storage quota in megabytes. This value must not exceed the values set for the StorageMaximumLevel parameter
Type: Int64
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MediaTranscription
When the feature is enabled, videos can have transcripts generated on demand or generated automatically in certain scenarios. This is the default because the policy is default on. If a video owner decides they don’t want the transcript, they can always hide or delete it from that video.
Type: MediaTranscriptionPolicyType
Parameter Sets: Set Properties
Accepted values: Enabled, Disabled
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequestFilesLinkEnabled
Allows configuring whether users will be able to create anonymous requests for people to upload files regardless of the Share with anyone link configuration setting for this particular site collection.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ScriptSafeDomainName
Allow contributors to insert iframe only from the specified domains only
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RestrictedAccessControl
To enable restricted access control on a group-connected or Teams-connected site
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BlockDownloadPolicy
Set this to true to block download of files from SharePoint sites or OneDrive
Type: Boolean
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExcludeBlockDownloadPolicySiteOwners
Set this to true to exempts site owners from the block download policy so that they can fully download any content for the site.
Type: Boolean
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExcludedBlockDownloadGroupIds
Exempts users from the mentioned groups from this policy and they can fully download any content for the site.
Type: GUID[]
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ListsShowHeaderAndNavigation
Set a property on a site collection to make all lists always load with the site elements intact.
Type: Boolean
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Wait
Wait for the operation to complete
Type: SwitchParameter
Parameter Sets: Set Lock State
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableAutoExpirationVersionTrim
Enable or disable AutoExpiration version trim for the document libraries on the site. Set to $true to enable, $false to disable.
Parameter ExpireVersionsAfterDays is required when EnableAutoExpirationVersionTrim is false. Set it to 0 for NoExpiration, set it to greater or equal to 30 for ExpireAfter.
Parameter MajorVersions is required when EnableAutoExpirationVersionTrim is false.
Parameter MinorVersions is required when EnableAutoExpirationVersionTrim is false and the setting is for document libraries that including existing ones. It is used when minor version is enabled on the document libraries.
Type: Boolean
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpireVersionsAfterDays
Work with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
Type: UInt32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MajorVersions
Work with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
Type: UInt32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MinorVersions
Work with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
Type: UInt32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InheritTenantVPForNewDocLibs
Clear the file version setting on a site. The new document libraries will use the tenant level setting.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApplyForNewLibs
Set site version policy for new document libraries. Work with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MinorVersions.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApplyForExistingLibs
Create a request to set the file version trim mode for existing document libraries that enabled versioning. Work with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MinorVersions.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CancelVPForExistingLibs
Cancel the existing request which sets the file version trim mode for existing document libraries on a site.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False