Update-MgAdminSharepointSetting

Module:

Microsoft.Graph.Sites

Update one or more tenant-level settings for SharePoint and OneDrive.

Note

To view the beta release of this cmdlet, view Update-MgBetaAdminSharepointSetting

Syntax

Update-MgAdminSharepointSetting
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-AllowedDomainGuidsForSyncApp <String[]>]
      [-AvailableManagedPathsForSiteCreation <String[]>]
      [-DeletedUserPersonalSiteRetentionPeriodInDays <Int32>]
      [-ExcludedFileExtensionsForSyncApp <String[]>]
      [-Id <String>]
      [-IdleSessionSignOut <IMicrosoftGraphIdleSessionSignOut>]
      [-ImageTaggingOption <String>]
      [-IsCommentingOnSitePagesEnabled]
      [-IsFileActivityNotificationEnabled]
      [-IsLegacyAuthProtocolsEnabled]
      [-IsLoopEnabled]
      [-IsMacSyncAppEnabled]
      [-IsRequireAcceptingUserToMatchInvitedUserEnabled]
      [-IsResharingByExternalUsersEnabled]
      [-IsSharePointMobileNotificationEnabled]
      [-IsSharePointNewsfeedEnabled]
      [-IsSiteCreationEnabled]
      [-IsSiteCreationUiEnabled]
      [-IsSitePagesCreationEnabled]
      [-IsSitesStorageLimitAutomatic]
      [-IsSyncButtonHiddenOnPersonalSite]
      [-IsUnmanagedSyncAppForTenantRestricted]
      [-PersonalSiteDefaultStorageLimitInMb <Int64>]
      [-SharingAllowedDomainList <String[]>]
      [-SharingBlockedDomainList <String[]>]
      [-SharingCapability <String>]
      [-SharingDomainRestrictionMode <String>]
      [-SiteCreationDefaultManagedPath <String>]
      [-SiteCreationDefaultStorageLimitInMb <Int32>]
      [-TenantDefaultTimezone <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-MgAdminSharepointSetting
      -BodyParameter <IMicrosoftGraphSharepointSettings>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update one or more tenant-level settings for SharePoint and OneDrive.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	SharePointTenantSettings.ReadWrite.All,
Delegated (personal Microsoft account)	Not supported
Application	SharePointTenantSettings.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Sites

$params = @{
	deletedUserPersonalSiteRetentionPeriodInDays = 365
	excludedFileExtensionsForSyncApp = @(
	".mp3"
)
imageTaggingOption = "enhanced"
isLegacyAuthProtocolsEnabled = $true
isSitesStorageLimitAutomatic = $false
isSyncButtonHiddenOnPersonalSite = $false
isUnmanagedSyncAppForTenantRestricted = $false
personalSiteDefaultStorageLimitInMB = 120000
}

Update-MgAdminSharepointSetting -BodyParameter $params

This example shows how to use the Update-MgAdminSharepointSetting Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

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

-AllowedDomainGuidsForSyncApp

Collection of trusted domain GUIDs for the OneDrive sync app.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AvailableManagedPathsForSiteCreation

Collection of managed paths available for site creation. Read-only.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

sharepointSettings To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeletedUserPersonalSiteRetentionPeriodInDays

The number of days for preserving a deleted user's OneDrive.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExcludedFileExtensionsForSyncApp

Collection of file extensions not uploaded by the OneDrive sync app.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

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

-Id

The unique identifier for an entity. Read-only.

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

-IdleSessionSignOut

idleSessionSignOut To construct, see NOTES section for IDLESESSIONSIGNOUT properties and create a hash table.

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

-ImageTaggingOption

imageTaggingChoice

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

-IsCommentingOnSitePagesEnabled

Indicates whether comments are allowed on modern site pages in SharePoint.

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

-IsFileActivityNotificationEnabled

Indicates whether push notifications are enabled for OneDrive events.

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

-IsLegacyAuthProtocolsEnabled

Indicates whether legacy authentication protocols are enabled for the tenant.

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

-IsLoopEnabled

Indicates whether if Fluid Framework is allowed on SharePoint sites.

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

-IsMacSyncAppEnabled

Indicates whether files can be synced using the OneDrive sync app for Mac.

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

-IsRequireAcceptingUserToMatchInvitedUserEnabled

Indicates whether guests must sign in using the same account to which sharing invitations are sent.

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

-IsResharingByExternalUsersEnabled

Indicates whether guests are allowed to reshare files, folders, and sites they don't own.

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

-IsSharePointMobileNotificationEnabled

Indicates whether mobile push notifications are enabled for SharePoint.

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

-IsSharePointNewsfeedEnabled

Indicates whether the newsfeed is allowed on the modern site pages in SharePoint.

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

-IsSiteCreationEnabled

Indicates whether users are allowed to create sites.

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

-IsSiteCreationUiEnabled

Indicates whether the UI commands for creating sites are shown.

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

-IsSitePagesCreationEnabled

Indicates whether creating new modern pages is allowed on SharePoint sites.

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

-IsSitesStorageLimitAutomatic

Indicates whether site storage space is automatically managed or if specific storage limits are set per site.

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

-IsSyncButtonHiddenOnPersonalSite

Indicates whether the sync button in OneDrive is hidden.

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

-IsUnmanagedSyncAppForTenantRestricted

Indicates whether users are allowed to sync files only on PCs joined to specific domains.

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

-PersonalSiteDefaultStorageLimitInMb

The default OneDrive storage limit for all new and existing users who are assigned a qualifying license. Measured in megabytes (MB).

Type:	Int64
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SharingAllowedDomainList

Collection of email domains that are allowed for sharing outside the organization.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SharingBlockedDomainList

Collection of email domains that are blocked for sharing outside the organization.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SharingCapability

sharingCapabilities

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

-SharingDomainRestrictionMode

sharingDomainRestrictionMode

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

-SiteCreationDefaultManagedPath

The value of the team site managed path. This is the path under which new team sites will be created.

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

-SiteCreationDefaultStorageLimitInMb

The default storage quota for a new site upon creation. Measured in megabytes (MB).

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TenantDefaultTimezone

The default timezone of a tenant for newly created sites. For a list of possible values, see SPRegionalSettings.TimeZones property.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSharepointSettings

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSharepointSettings

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphSharepointSettings>: sharepointSettings

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Id <String>]: The unique identifier for an entity. Read-only.
• [AllowedDomainGuidsForSyncApp <String- []>]: Collection of trusted domain GUIDs for the OneDrive sync app.
• [AvailableManagedPathsForSiteCreation <String- []>]: Collection of managed paths available for site creation. Read-only.
• [DeletedUserPersonalSiteRetentionPeriodInDays <Int32?>]: The number of days for preserving a deleted user's OneDrive.
• [ExcludedFileExtensionsForSyncApp <String- []>]: Collection of file extensions not uploaded by the OneDrive sync app.
• [IdleSessionSignOut <IMicrosoftGraphIdleSessionSignOut>]: idleSessionSignOut
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [IsEnabled <Boolean?>]: Indicates whether the idle session sign-out policy is enabled.
  • [SignOutAfterInSeconds <Int64?>]: Number of seconds of inactivity after which a user is signed out.
  • [WarnAfterInSeconds <Int64?>]: Number of seconds of inactivity after which a user is notified that they'll be signed out.
• [ImageTaggingOption <String>]: imageTaggingChoice
• [IsCommentingOnSitePagesEnabled <Boolean?>]: Indicates whether comments are allowed on modern site pages in SharePoint.
• [IsFileActivityNotificationEnabled <Boolean?>]: Indicates whether push notifications are enabled for OneDrive events.
• [IsLegacyAuthProtocolsEnabled <Boolean?>]: Indicates whether legacy authentication protocols are enabled for the tenant.
• [IsLoopEnabled <Boolean?>]: Indicates whether if Fluid Framework is allowed on SharePoint sites.
• [IsMacSyncAppEnabled <Boolean?>]: Indicates whether files can be synced using the OneDrive sync app for Mac.
• [IsRequireAcceptingUserToMatchInvitedUserEnabled <Boolean?>]: Indicates whether guests must sign in using the same account to which sharing invitations are sent.
• [IsResharingByExternalUsersEnabled <Boolean?>]: Indicates whether guests are allowed to reshare files, folders, and sites they don't own.
• [IsSharePointMobileNotificationEnabled <Boolean?>]: Indicates whether mobile push notifications are enabled for SharePoint.
• [IsSharePointNewsfeedEnabled <Boolean?>]: Indicates whether the newsfeed is allowed on the modern site pages in SharePoint.
• [IsSiteCreationEnabled <Boolean?>]: Indicates whether users are allowed to create sites.
• [IsSiteCreationUiEnabled <Boolean?>]: Indicates whether the UI commands for creating sites are shown.
• [IsSitePagesCreationEnabled <Boolean?>]: Indicates whether creating new modern pages is allowed on SharePoint sites.
• [IsSitesStorageLimitAutomatic <Boolean?>]: Indicates whether site storage space is automatically managed or if specific storage limits are set per site.
• [IsSyncButtonHiddenOnPersonalSite <Boolean?>]: Indicates whether the sync button in OneDrive is hidden.
• [IsUnmanagedSyncAppForTenantRestricted <Boolean?>]: Indicates whether users are allowed to sync files only on PCs joined to specific domains.
• [PersonalSiteDefaultStorageLimitInMb <Int64?>]: The default OneDrive storage limit for all new and existing users who are assigned a qualifying license. Measured in megabytes (MB).
• [SharingAllowedDomainList <String- []>]: Collection of email domains that are allowed for sharing outside the organization.
• [SharingBlockedDomainList <String- []>]: Collection of email domains that are blocked for sharing outside the organization.
• [SharingCapability <String>]: sharingCapabilities
• [SharingDomainRestrictionMode <String>]: sharingDomainRestrictionMode
• [SiteCreationDefaultManagedPath <String>]: The value of the team site managed path. This is the path under which new team sites will be created.
• [SiteCreationDefaultStorageLimitInMb <Int32?>]: The default storage quota for a new site upon creation. Measured in megabytes (MB).
• [TenantDefaultTimezone <String>]: The default timezone of a tenant for newly created sites. For a list of possible values, see SPRegionalSettings.TimeZones property.

IDLESESSIONSIGNOUT <IMicrosoftGraphIdleSessionSignOut>: idleSessionSignOut

• [(Any) <Object>]: This indicates any property can be added to this object.
• [IsEnabled <Boolean?>]: Indicates whether the idle session sign-out policy is enabled.
• [SignOutAfterInSeconds <Int64?>]: Number of seconds of inactivity after which a user is signed out.
• [WarnAfterInSeconds <Int64?>]: Number of seconds of inactivity after which a user is notified that they'll be signed out.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.sites/update-mgadminsharepointsetting
• https://learn.microsoft.com/graph/api/sharepointsettings-update?view=graph-rest-1.0