diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreationForApps.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreationForApps.md new file mode 100644 index 000000000..312198c32 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPORestrictedSiteCreationForApps.md @@ -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 ] [] +``` + +## 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) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index 85890993c..50fe76c51 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -279,6 +279,9 @@ This cmdlet enables the administrator to check status of all active and availabl ### [Get-SPORestrictedSiteCreation](Get-SPORestrictedSiteCreation.md) This cmdlet allows SharePoint administrators to check the current configuration of the restricted site creation feature. +### [Get-SPORestrictedSiteCreationForApps](Get-SPORestrictedSiteCreationForApps.md) +This cmdlet allows SharePoint administrators to check the current configuration of the restricted site creation for apps feature. > [!NOTE] > This feature is currently in preview and may not be available in your tenant. + ### [Get-SPOServicePrioritizationAppRegistrations](Get-SPOServicePrioritizationAppRegistrations.md) Retrieves the list of app registrations configured for service prioritization in SharePoint Online. @@ -726,6 +729,9 @@ Marks a site as one of multiple possible tenant's organizational news sites. Req ### [Set-SPORestrictedSiteCreation](Set-SPORestrictedSiteCreation.md) Sets or updates one or more group configurations for restricting site creation. +### [Set-SPORestrictedSiteCreationForApps](Set-SPORestrictedSiteCreationForApps.md) +Sets or updates one or more group configurations for restricting site creation for apps. > [!NOTE] > This feature is currently in preview and may not be available in your tenant. + ### [Set-SPOServicePrioritizationAppRegistration](Set-SPOServicePrioritizationAppRegistration.md) Updates an existing app registration for service prioritization in SharePoint Online. diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreationForApps.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreationForApps.md new file mode 100644 index 000000000..04c29a2ed --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Set-SPORestrictedSiteCreationForApps.md @@ -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 ] [-Mode ] + [-SiteType ] [-RestrictedSiteCreationApps ] [-WhatIf] [-Confirm] + [] +``` + +## 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)