-
Notifications
You must be signed in to change notification settings - Fork 190
Added SPO app priotization policy #840
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 14 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
4d926d1
Added commands for SPO app priortiziation policies
SimonBourdages 5c0b3a8
Merge branch 'MicrosoftDocs:main' into main
SimonBourdages 37666e8
fixed github author
SimonBourdages 9816514
Merge branch 'main' of https://github.com/killerewok2000/OfficeDocs-S…
SimonBourdages a5befb8
Fixed the word app priotization
SimonBourdages f51a72b
fixed feedback
SimonBourdages d50dc45
had missed a P->p
SimonBourdages 5b2b66f
attemp to address feedback about mandatory param for set spoapppriori…
SimonBourdages cc55578
fixed app priortization casing
SimonBourdages 638b800
changed param to guid for add
SimonBourdages f4376b4
fixed guid casing
SimonBourdages 371146a
fixed back ticks
SimonBourdages 543cc8e
fixed parameters to optionnal
SimonBourdages 2a1f0b6
fixed string for params
SimonBourdages 89e1a54
fixed value range
SimonBourdages 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
138 changes: 138 additions & 0 deletions
138
sharepoint/sharepoint-ps/sharepoint-online/Add-SPOAppPrioritizationPolicy.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,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 <Guid> -AzureSubscriptionId <Guid> -ResourceGroup <String> -Account <String> -QuotaMultiplier <Int32> [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## 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). | ||
|
|
||
|
|
||
SimonBourdages marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## 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) | ||
55 changes: 55 additions & 0 deletions
55
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppPrioritizationPolicies.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,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 [<CommonParameters>] | ||
| ``` | ||
|
|
||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This cmdlet gets all existing SPO App prioritization billing policies for your tenancy. | ||
|
|
||
SimonBourdages marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## 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 | ||
|
|
||
SimonBourdages marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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) | ||
68 changes: 68 additions & 0 deletions
68
sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppPrioritizationPolicy.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,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 <String> [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## 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). | ||
|
|
||
SimonBourdages marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## 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) | ||
120 changes: 120 additions & 0 deletions
120
sharepoint/sharepoint-ps/sharepoint-online/Set-SPOAppPrioritizationPolicy.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,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 <String> [-Enabled <Boolean>] [-QuotaMultiplier <Int32>] [<CommonParameters>] | ||
| ``` | ||
SimonBourdages marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 has to be a range of [1,10] | ||
SimonBourdages marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```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 | ||
SimonBourdages marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [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) | ||
Oops, something went wrong.
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.