-
Notifications
You must be signed in to change notification settings - Fork 187
Documentation for Get and Set-SPORestrictedSiteCreationForApps cmdlets #1077
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
1fe9d59
Create Set-SPORestrictedSiteCreationForApps.md
vgaddam-pm f92280a
Create Get-SPORestrictedSiteCreationForApps
vgaddam-pm 1569bae
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm 8d57353
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm 0cd915c
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm 004509a
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm c1cab2f
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm 8dc9815
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm d5fb83b
Update Set-SPORestrictedSiteCreationForApps.md
vgaddam-pm b034fad
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm a4a1363
Update and rename Get-SPORestrictedSiteCreationForApps to Get-SPORest…
vgaddam-pm 3c458ca
Update sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShel…
vgaddam-pm 5828258
Update Get-SPORestrictedSiteCreationForApps.md
vgaddam-pm 7a4bcd2
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm 2bd5ca6
Update Set-SPORestrictedSiteCreationForApps.md
vgaddam-pm 9001f56
Update Set-SPORestrictedSiteCreationForApps.md
vgaddam-pm 28455a8
Update Get-SPORestrictedSiteCreationForApps.md
vgaddam-pm 82b3b61
Update Microsoft.Online.SharePoint.PowerShell.md
vgaddam-pm b714e02
Update Get-SPORestrictedSiteCreationForApps.md
vgaddam-pm 06888c0
Update Get-SPORestrictedSiteCreationForApps.md
vgaddam-pm 7c40627
Update Set-SPORestrictedSiteCreationForApps.md
vgaddam-pm a25ae98
Update Get-SPORestrictedSiteCreationForApps.md
vgaddam-pm 14d0063
Update Set-SPORestrictedSiteCreationForApps.md
vgaddam-pm 968bf99
Update Get-SPORestrictedSiteCreationForApps.md
vgaddam-pm 7de192c
Merge branch 'main' into patch-9
vgaddam-pm caa80ab
typo fix
Ruchika-mittal01 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
94 changes: 94 additions & 0 deletions
94
.../Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreationForApps.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| 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/get-sporestrictedsitecreationforapps | ||
| applicable: SharePoint Online | ||
| title: Get-SPORestrictedSiteCreationForApps | ||
| schema: 2.0.0 | ||
| author: vgaddam-pm | ||
| ms.author: vgaddam | ||
| ms.reviewer: | ||
| --- | ||
|
|
||
| # Get-SPORestrictedSiteCreationForApps | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| This cmdlet allows SharePoint Administrators to check the current configuration of the restricted site creation for apps feature. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Get-SPORestrictedSiteCreationForApps [-SiteType <RestrictedSiteCreationSiteType>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This cmdlet obtains the current configuration information for the restricted site creation for apps feature, including whether it is enabled, the current mode, and the current policies. | ||
|
|
||
| > [!Note] | ||
| > This feature is currently in preview and may not be available in your tenant. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| Get-SPORestrictedSiteCreationForApps | ||
| ``` | ||
|
|
||
| Example 1 returns all configuration information for the restricted site creation for apps feature. This includes whether the feature is enabled, the current mode (deny or allow), and the app IDs configured for each site type. | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```powershell | ||
| Get-SPORestrictedSiteCreation –SiteType Communication | ||
| ``` | ||
|
|
||
| Example 2 returns a comma-separated list of the app IDs for the `Communication` site type. Depending on whether restricted site creation is in allow or deny mode, these apps are either allowed or denied from creating SharePoint communication sites. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -SiteType | ||
|
|
||
| > Applicable: SharePoint Online | ||
| When provided, only return the Microsoft Entra security groups configured for the specified site type. | ||
|
|
||
| PARAMVALUE: All | SharePoint | OneDrive | Team | Communication | ||
| - All - OneDrive and all SharePoint sites | ||
| - SharePoint - All SharePoint sites (but not OneDrive) | ||
| - OneDrive - Only OneDrive | ||
| - Team - Only SharePoint team sites (group-connected and classic) | ||
| - Communication - Only SharePoint communication sites | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCreationSiteType | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Accepted values: All, SharePoint, OneDrive, Team, Communication | ||
|
|
||
| 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](https://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
|
|
||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) | ||
|
|
||
| [Set-SPORestrictedSiteCreationForApps](Set-SPORestrictedSiteCreationForApps.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
216 changes: 216 additions & 0 deletions
216
.../Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreationForApps.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| --- | ||
| 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-sporestrictedsitecreationforapps | ||
| applicable: SharePoint Online | ||
| title: Set-SPORestrictedSiteCreationForApps | ||
| schema: 2.0.0 | ||
| author: vgaddam-pm | ||
| ms.author: vgaddam | ||
| ms.reviewer: jmcdowe | ||
| --- | ||
|
|
||
| # Set-SPORestrictedSiteCreationForApps | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Sets or updates one or more app configurations for restricting site creation. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Set-SPORestrictedSiteCreationForApps [-Enabled <Boolean>] [-Mode <RestrictedSiteCreationMode>] | ||
| [-SiteType <RestrictedSiteCreationSiteType>] [-RestrictedSiteCreationApps <String>] [-WhatIf] [-Confirm] | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This cmdlet sets or updates the configuration or setting for the Restricted Site Creation For Apps feature. | ||
|
|
||
| > [!Note] | ||
| > This feature is currently in preview and may not be available in your tenant. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| Set-SPORestrictedSiteCreationForApps –Enabled:$true | ||
| ``` | ||
|
|
||
| Example 1 enables the restricted site creation for apps feature for the tenant. | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```powershell | ||
| Set-SPORestrictedSiteCreationForApps –Mode Allow | ||
| ``` | ||
|
|
||
| Example 2 sets restricted site creation for apps to allow mode. In this mode, an app is only able to create a site if that app is in the list specified for a matching site type. | ||
|
|
||
| ### Example 3 | ||
|
|
||
| ```powershell | ||
| Set-SPORestrictedSiteCreationForApps –SiteType "All" -RestrictedSiteCreationApps "281e395b-7316-4cb2-b5bb-8881426ee411" | ||
| ``` | ||
|
|
||
| Example 3 updates the policy for the `All` site type to apply to the app with the app ID 281e395b-7316-4cb2-b5bb-8881426ee411. This app is now either allowed or denied (depending on the current mode) from creating all OneDrive and SharePoint sites. | ||
|
|
||
| ### Example 4 | ||
|
|
||
| ```powershell | ||
| Set-SPORestrictedSiteCreationForApps –SiteType "Team" -RestrictedSiteCreationApps "78159241-04a9-41d2-8dd4-ac568e9766a3,1f95829b-e1c8-4406-b2be-508c36f4bca5" | ||
| ``` | ||
|
|
||
| Example 4 updates the policy for the `Team` site type to apply to the two apps specified. Both apps now either allowed or denied from creating Team sites, depending on the current mode. | ||
|
|
||
| ### Example 5 | ||
|
|
||
| ```powershell | ||
| Set-SPORestrictedSiteCreationForApps –SiteType "OneDrive" -RestrictedSiteCreationApps "" | ||
| ``` | ||
|
|
||
| Example 5 clears the policy for the `OneDrive` site type so that it no longer applies to any apps. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Enabled | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| PARAMVALUE: true | false | ||
| Enables or disables Restricted Site Creation For Apps feature in tenant. | ||
|
|
||
| ```yaml | ||
| Type: System.Boolean | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Mode | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| Specifies whether policies allow or deny apps from creating sites. | ||
| PARAMVALUE: Deny | Allow | ||
| - Deny – an app will be blocked from creating a site if any policy applies to them. | ||
| - Allow – an app will only be allowed to create a site if a policy applies to them. | ||
|
|
||
| > [!NOTE] | ||
| > The restricted site creation mode is shared across all site type policies. It is not possible to use deny mode for one site type and allow mode for a different site type. When the mode is changed, all policies are cleared. | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCreationMode | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Accepted values: Deny, Allow | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -RestrictedSiteCreationApps | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| A comma-separated list of up to 100 app IDs. When paired with the `–SiteType` parameter, defines a new policy which applies to the specified apps. | ||
| Set to the empty string `""` to clear the policy for a site type. | ||
|
|
||
| ```yaml | ||
| Type: System.String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -SiteType | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| When paired with the `–RestrictedSiteCreationApps` parameter, creates a new policy which applies to the specified types of sites. | ||
|
|
||
| PARAMVALUE: All | SharePoint | OneDrive | Team | Communication | ||
| - All - OneDrive and all SharePoint sites | ||
| - SharePoint - All SharePoint sites (but not OneDrive) | ||
| - OneDrive - Only OneDrive | ||
| - Team - Only SharePoint team sites (group-connected and classic) | ||
| - Communication - Only SharePoint communication sites | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.SharePoint.Administration.SPOnlineProvisioning.RestrictedSiteCreationSiteType | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Accepted values: All, SharePoint, OneDrive, Team, Communication | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Confirm | ||
| Prompts you for confirmation before running the cmdlet. | ||
|
|
||
| ```yaml | ||
| Type: System.Management.Automation.SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: cf | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -WhatIf | ||
| Shows what would happen if the cmdlet runs. | ||
| The cmdlet is not run. | ||
|
|
||
| ```yaml | ||
| Type: System.Management.Automation.SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: wi | ||
|
|
||
| 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](https://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
|
|
||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) | ||
|
|
||
| [Get-SPORestrictedSiteCreationForApps](Get-SPORestrictedSiteCreationForApps.md) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.