diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOAppPrioritizationPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOAppPrioritizationPolicy.md new file mode 100644 index 000000000..d99791678 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Add-SPOAppPrioritizationPolicy.md @@ -0,0 +1,138 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Add-SPOAppPrioritizationPolicy +applicable: SharePoint Online +title: Add-SPOAppPrioritizationPolicy +schema: 2.0.0 +author: killerewok2000 +ms.author: Sibourda +ms.reviewer: +--- + +# Add-SPOAppPrioritizationPolicy + +## SYNOPSIS + +Adds a new SPO app prioritization Policy to your tenancy. + +## SYNTAX + +``` +Add-SPOAppPrioritizationPolicy -AppId -AzureSubscriptionId -ResourceGroup -Account -QuotaMultiplier [] +``` + +## DESCRIPTION + +This cmdlet adds a new SPO app prioritization billing policies to your tenancy. Ensure that you do not add a new billing policy to an app that already has one. + +## EXAMPLES + +### Example 1 + +```powershell +Add-SPOAppPrioritizationPolicies -AppId 48ab2ba9-5713-47d6-88a1-f6e3a0730833 -AzureSubscriptionId 48ab1ba4-9813-47d6-88a1-f6e3a0730822 -ResourceGroup newResourceGroup -Account newAccountName -QuotaMultiplier 5 +``` + +Example 1 adds the billing policy to your tenancy. It will not add the policy on invalid inputs or for apps that already have an associated policy. + + +## PARAMETERS + +### -AppId + +This parameter specifies the app ID of the application to onboard. +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AzureSubscriptionId + +This parameter describes the Azure subscription ID to which the container type needs to be associated. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -ResourceGroup + +This parameter describes the resource group to be used for the associated container type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Account + +This parameter describes the account to which the billing profile of the container type is associated with. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -QuotaMultiplier + +This parameter specifies the multiplier for the scaling feature. + +```yaml +Type: int +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md) + +[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md) + +[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppPrioritizationPolicies.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppPrioritizationPolicies.md new file mode 100644 index 000000000..1673f04cf --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppPrioritizationPolicies.md @@ -0,0 +1,55 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Get-SPOAppPrioritizationPolicies +applicable: SharePoint Online +title: Get-SPOAppPrioritizationPolicies +schema: 2.0.0 +author: killerewok2000 +ms.author: Sibourda +ms.reviewer: +--- + +# Get-SPOAppPrioritizationPolicies + +## SYNOPSIS + +Gets all existing SPO app prioritization policies of your tenancy. + +## SYNTAX + +``` +Get-SPOAppPrioritizationPolicies [] +``` + + +## DESCRIPTION + +This cmdlet gets all existing SPO App prioritization billing policies for your tenancy. + +## EXAMPLES + +### Example 1 + +```powershell +Get- SPOAppPrioritizationPolicies +``` + +Example 1 returns a collection of all existing SPO app prioritization policies. Each policy will contain PolicyId, AppId, AzureSubscription, ResourceGroup, Account, Enabled (status of this policy i.e true or false) and QuotaMultiplier + + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md) + +[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md) + +[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppPrioritizationPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppPrioritizationPolicy.md new file mode 100644 index 000000000..57cd71cd3 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppPrioritizationPolicy.md @@ -0,0 +1,68 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Remove-SPOAppPrioritizationPolicy +applicable: SharePoint Online +title: Remove-SPOAppPrioritizationPolicy +schema: 2.0.0 +author: killerewok2000 +ms.author: Sibourda +ms.reviewer: +--- + +# Remove-SPOAppPrioritizationPolicy + +## SYNOPSIS + +Deletes an existing SPO app prioritization policy in your tenancy. + +## SYNTAX + +``` +Remove-SPOAppPrioritizationPolicy -PolicyId [] +``` + +## DESCRIPTION + +This cmdlet lets you delete an existing SPO app prioritization policy. + +## EXAMPLES + +### Example 1 + +```powershell +Remove-SPOAppPrioritizationPolicy -PolicyId 48abxxa9 +``` + +Example 1 deletes the policy bearing the policyId 48abxxa9. Running the `Get-SPOAppPrioritizationPolicies` command will no longer show the policy in the result. + +## PARAMETERS + +### -PolicyId + +This parameter specifies the ID of policy. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md) + +[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md) + +[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOAppPrioritizationPolicy.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOAppPrioritizationPolicy.md new file mode 100644 index 000000000..941bd8ecd --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOAppPrioritizationPolicy.md @@ -0,0 +1,120 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOAppPrioritizationPolicy +applicable: SharePoint Online +title: Set-SPOAppPrioritizationPolicy +schema: 2.0.0 +author: killerewok2000 +ms.author: Sibourda +ms.reviewer: +--- + +# Set-SPOAppPrioritizationPolicy + +## SYNOPSIS + +Edits an existing SPO app prioritization policy in your tenancy. + +## SYNTAX + +``` +Set-SPOAppPrioritizationPolicy -PolicyId [-Enabled ] [-QuotaMultiplier ] [] +``` + +## DESCRIPTION + +This cmdlet lets you enable or disable an existing policy and/or change the quota multiplier limit associated with the policy. Note that disabling the policy does not delete the policy. If you need to change only one of the two parameters, retain the value of the non-changing parameter from the `Get-SPOAppPrioritizationPolicies` commandlet. + +## EXAMPLES + +### Example 1 + +```powershell +Set-SPOAppPrioritizationPolicies -PolicyId 48abxxa9 -Enabled $false +``` + +Example 1 disables the policy bearing the policyId 48abxxa9 + +### Example 2 + +```powershell +Set-SPOAppPrioritizationPolicies -PolicyId 48abxxa9 -Enabled $true -QuotaMultiplier 7 +``` + +Example 2 enables the policy bearing the policyId 48abxxa9 and also sets the quota multiplier limit to 7. + +### Example 3 + +```powershell +Set-SPOAppPrioritizationPolicies -PolicyId 48abxxa9 -QuotaMultiplier 8 +``` + +Example 3 set the quota multiplier limit to 7 of the policy bearing the policyId 48abxxa9. + +## PARAMETERS + +### -PolicyId + +This parameter specifies the ID of policy. +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled + +This parameter described the state wanted of the policy. + +```yaml +Type: Bool +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -QuotaMultiplier + +This parameter specifies the quota multiplier limit for the scaling feature. Value must be between 1 and 10. + +```yaml +Type: int +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md) + +[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md) + +[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md index fd6ade65d..30ee801e0 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md @@ -15,6 +15,10 @@ The following cmdlet references are for SharePoint Online. ## sharepoint-online Cmdlets +### [Add-SPOAppPrioritizationPolicy](Add-SPOAppPrioritizationPolicy.md) + +{{Adds a new SPO app prioritization policy to your tenancy.}} + ### [Add-SPOContainerTypeBilling](Add-SPOContainerTypeBilling.md) {{Adds a Azure billing subscription to a new standard billed container type.}} @@ -107,6 +111,10 @@ The following cmdlet references are for SharePoint Online. {{Manually Enter Get-SPOAppInfo Description Here}} +### [Get-SPOAppPrioritizationPolicies](Get-SPOAppPrioritizationPolicies.md) + +{{Gets all existing SPO app prioritization policies of your tenancy}} + ### [Get-SPOBuiltInFontPackageSettings](Get-SPOBuiltInFontPackageSettings.md) {{Gets settings of built-in font packages.}} @@ -420,6 +428,10 @@ This cmdlet is not currently active in production and may be removed in the futu {{Manually Enter Register-SPOHubSite Description Here}} +### [Remove-SPOAppPrioritizationPolicy](Remove-SPOAppPrioritizationPolicy.md) + +{{Deletes an existing SPO app prioritization policy in your tenancy.}} + ### [Remove-SPODataConnectionSetting](Remove-SPODataConnectionSetting.md) {{Manually Enter Remove-SPODataConnectionSetting Description Here}} @@ -544,6 +556,10 @@ This cmdlet is not currently active in production and may be removed in the futu {{Manually Enter Revoke-SPOUserSession Description Here}} +### [Set-SPOAppPrioritizationPolicy](Set-SPOAppPrioritizationPolicy.md) + +{{Edits an existing SPO app prioritization policy in your tenancy. }} + ### [Set-SPOBuiltInFontPackageSettings](Set-SPOBuiltInFontPackageSettings.md) {{Sets settings of built-in font packages.}}