| external help file | Microsoft.Online.SharePoint.PowerShell.dll-Help.xml |
|---|---|
| Module Name | Microsoft.Online.SharePoint.PowerShell |
| online version | https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/Set-SPOContainerTypeConfiguration |
| applicable | SharePoint Online |
| title | Set-SPOContainerTypeConfiguration |
| schema | 2.0.0 |
| author | ShreyasSar26 |
| ms.author | shsaravanan |
| ms.reviewer |
Sets or updates the configuration settings of a container type in SharePoint Embedded.
Set-SPOContainerTypeConfiguration -ContainerTypeId <Guid> [-DiscoverabilityDisabled <Boolean>]
[-SharingRestricted <Boolean>] [-ApplicationRedirectUrl <String>] [-WhoCanShareAnonymousAllowList <Guid[]>]
[-WhoCanShareAuthenticatedGuestAllowList <Guid[]>] [-OverrideTenantWhoCanShareAnonymousAllowList <Boolean>]
[-OverrideTenantWhoCanShareAuthenticatedGuestAllowList <Boolean>]
[-CopilotEmbeddedChatHosts <System.Collections.Generic.List`1[System.String]>]
[-AnonymousLinkExpirationInDays <Int32>] [-IsArchiveEnabled <Boolean>] [-UseLegacyItemWebUrl <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
For any parameters passed in, the Set-SPOContainerTypeConfiguration cmdlet sets or updates the settings for a container type created under a SharePoint Embedded application.
You must be a SharePoint Embedded Administrator to run this cmdlet.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -DiscoverabilityDisabled $falseExample 1 turns on discoverability for this container type. All content created within this container type will be discoverable in the Microsoft 365 experience, including on office.com, onedrive.com, recommended files, and other intelligent discovery experiences.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -SharingRestricted $falseExample 2 turns on an open sharing model for this container type. Any container members and guest users with edit permissions can share files created within the container type.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -OverrideTenantWhoCanShareAnonymousAllowList $true -WhoCanShareAnonymousAllowList <guids>Example 3 overrides the tenant-level WhoCanShareAnonymousAllowList.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -OverrideTenantWhoCanShareAnonymousAllowList $true –WhoCanShareAnonymousAllowList $null -OverrideTenantWhoCanShareAuthenticatedGuestAllowList $true –WhoCanShareAuthenticatedGuestAllowList $nullExample 4 overrides the tenant-level WhoCanShareAnonymousAllowList and WhoCanShareAuthenticatedGuestAllowList with null values, which bypass the check. This has the effect of no longer restricting external sharing privileges to members of specific security groups.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -OverrideTenantWhoCanShareAuthenticatedGuestAllowList $true –WhoCanShareAuthenticatedGuestAllowList $nullExample 5 overrides the tenant-level WhoCanShareAuthenticatedGuestAllowList with a null value, while leaving the WhoCanShareAnonymousAllowList untouched. This has the effect of no longer restricting the privilege of sharing to authenticated guests to members of specific security groups.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -CopilotEmbeddedChatHosts "https://localhost:3000 https://contoso.sharepoint.com https://fabrikam.com"This example sets the host URLs for the container type with Id 4f0af585-8dcc-0000-223d-661eb2c604e4.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -IsArchiveEnabled $trueExample 7 enables support for archive and reactivate actions on all the containers of ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4.
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -UseLegacyItemWebUrl $trueExample 8 configures the containers of ContainerType ID 4f0af585-8dcc-0000-223d-661eb2c604e4 to temporarily continue using the legacy item WebUrl.
Specifies all anonymous links created after the value is set will expire after the set number of days.
The value can be from 1 to 730 days.
To defer to the tenant level setting, set the value to -1.
Type: System.Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter specifies the url of that the application should be redirected to.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter specifies the ID of the container type corresponding to the SharePoint Embedded application.
Type: System.Guid
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience.
Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Embedded
As a SharePoint Administrator in Microsoft 365, you can control how your content appears in the Microsoft 365 experience. When this value is true, the SharePoint Embedded application content is hidden throughout the Microsoft 365 environment, including on office.com, onedrive.com, in recommended sections, or through other Microsoft intelligent file discovery features. If you opt into the Microsoft 365 experience, your files will be integrated into Microsoft 365 environment, participating in intelligent file discovery.
PARAMVALUE: True | False
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseWhen enabled, temporarily uses the legacy item WebUrl format instead of the new SharePoint Embedded item WebUrl.
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseUse the -IsArchiveEnabled flag to enable archival of containers. Archival moves data to the cold tier, reducing storage costs. While archived, content is inaccessible until reactivated. Reactivation is immediate within the first seven days and can take up to 24 hours afterward. If you don't include this flag, the value defaults to False, and all archive API calls fail. After you update the flag, allow up to 24 hours for the change to take effect in the consuming tenant.
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis setting determines if the container type WhoCanShareAnonymousAllowList overrides the tenant-level WhoCanShareAnonymousAllowList.
PARAMVALUE: True | False
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis setting determines if the container type WhoCanShareAuthenticatedGuestAllowList overrides the tenant-level WhoCanShareAuthenticatedGuestAllowList.
PARAMVALUE: True | False
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Embedded
SharePoint Embedded offers a role-based sharing model that allows developers to configure file-sharing permissions based on container permission roles, offering a choice between a restrictive and an open sharing model. The open sharing model allows any container members and guest users with edit permissions to share files. The restrictive sharing model allows only container members who are either Owners or Managers to share files.
PARAMVALUE: True | False
Type: System.Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSets a container type-specific list of security groups who are allowed to share with anonymous (non-authenticated) users as well as authenticated guest users. This must be set in conjunction with OverrideTenantWhoCanShareAnonymousAllowList.
Note
This allow list only accepts security groups, and not Microsoft 365 Groups.
Each security group is denoted by its GUID object ID. To set this list to be a specific security group, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them. To skip the check and allow all security groups to share to anyone, set this allow list and the WhoCanShareAuthenticatedGuestAllowList to null arrays.
Type: System.Guid[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSets a container type-specific list of security groups who are allowed to share with authenticated guest users at the container level. This must be set in conjunction with OverrideTenantWhoCanShareAuthenticatedGuestAllowList.
Note
This allow list only accepts security groups, and not Microsoft 365 Groups.
Each security group is denoted by its GUID object ID. To set this list to be a specific security group, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them. To skip the check and allow all security groups to share to authenticated guests, set this allow list to a null array.
Type: System.Guid[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.