-
Notifications
You must be signed in to change notification settings - Fork 196
Add/update SPO Service Prioritization cmdlet docs #1127
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
Changes from 4 commits
cb99294
8cdc0e6
dd346a3
2c25cef
f5b1c21
e4e177e
34b8ac3
db6ac89
5c1ed62
b05e1da
68fa57b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,29 +13,69 @@ ms.reviewer: speedta | |
| # Get-SPOServicePrioritizationAppRegistrations | ||
|
|
||
| ## SYNOPSIS | ||
| Retrieves the list of app registrations configured for service prioritization in SharePoint Online. | ||
|
|
||
| Returns app registrations enrolled in SharePoint Online Service Prioritization. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| ### All (Default) | ||
|
|
||
| ```powershell | ||
| Get-SPOServicePrioritizationAppRegistrations [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ### ByPolicy | ||
|
|
||
| ```powershell | ||
| Get-SPOServicePrioritizationAppRegistrations -PolicyId <Guid> [<CommonParameters>] | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
| This cmdlet retrieves all app registrations that have been configured for service prioritization in SharePoint Online. This cmdlet is useful for administrators who need to review or audit the current app registrations and their associated policies. | ||
|
|
||
| This cmdlet retrieves all app registrations enrolled in SharePoint Online Service Prioritization for the tenant. | ||
|
|
||
| When `-PolicyId` is specified, only registrations linked to that billing policy are returned. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| Get-SPOServicePrioritizationAppRegistrations | ||
| ``` | ||
| This example retrieves all app registrations configured for service prioritization in SharePoint Online. | ||
|
|
||
| Example 1 returns all app registrations enrolled in SharePoint Online Service Prioritization for the tenant. | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```powershell | ||
| Get-SPOServicePrioritizationAppRegistrations -PolicyId 11111111-1111-1111-1111-111111111111 | ||
| ``` | ||
|
|
||
| Example 2 returns only app registrations linked to the specified billing policy. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -PolicyId | ||
|
|
||
| The unique identifier of the SPO Service Prioritization billing policy to filter by. | ||
| When specified, only app registrations linked to this policy are returned. | ||
| When omitted, all app registrations for the tenant are returned. | ||
|
|
||
| ```yaml | ||
| Type: Guid | ||
| Parameter Sets: ByPolicy | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this doesn't match the backend code -- backend code has no ParameteSetNames #Closed |
||
| Aliases: | ||
|
|
||
| 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 | ||
|
|
@@ -50,14 +90,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable | |
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) | ||
|
|
||
| [Add-SPOServicePrioritizationAppRegistration](./Add-SPOServicePrioritizationAppRegistration.md) | ||
|
|
||
| [Remove-SPOServicePrioritizationAppRegistration](./Remove-SPOServicePrioritizationAppRegistration.md) | ||
| [Add-SPOServicePrioritizationAppRegistration](Add-SPOServicePrioritizationAppRegistration.md) | ||
|
|
||
| [New-SPOServicePrioritizationBillingPolicy](./New-SPOServicePrioritizationBillingPolicy.md) | ||
| [Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md) | ||
|
|
||
| [Get-SPOServicePrioritizationBillingPolicies](./Get-SPOServicePrioritizationBillingPolicies.md) | ||
| [Remove-SPOServicePrioritizationAppRegistrationsByPolicy](Remove-SPOServicePrioritizationAppRegistrationsByPolicy.md) | ||
|
|
||
| [Set-SPOServicePrioritizationAppRegistration](./Set-SPOServicePrioritizationAppRegistration.md) | ||
| [Get-SPOServicePrioritizationBillingPolicies](Get-SPOServicePrioritizationBillingPolicies.md) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| --- | ||
|
JuanOriana marked this conversation as resolved.
|
||
| external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml | ||
| Module Name: Microsoft.Online.SharePoint.PowerShell | ||
| online version: https://learn.microsoft.com/powershell/module/sharepoint-online/remove-sposerviceprioritizationappregistrationsbypolicy | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| title: Remove-SPOServicePrioritizationAppRegistrationsByPolicy | ||
| schema: 2.0.0 | ||
| author: juanoriana | ||
| ms.author: | ||
| ms.reviewer: | ||
| --- | ||
|
|
||
| # Remove-SPOServicePrioritizationAppRegistrationsByPolicy | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Removes all app registrations linked to a specific SharePoint Online Service Prioritization billing policy. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId <Guid> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This cmdlet removes all app registrations associated with the specified billing policy. | ||
|
|
||
| Before deletion, the cmdlet verifies that the billing policy exists and that at least one app registration is linked to it. If neither condition is met, the cmdlet exits silently. | ||
|
|
||
| By default, the cmdlet prompts for confirmation before deleting. Use `-Force` to suppress the confirmation prompt. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId 11111111-1111-1111-1111-111111111111 | ||
| ``` | ||
|
|
||
| Example 1 prompts for confirmation, then removes all app registrations linked to the specified billing policy. | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId 11111111-1111-1111-1111-111111111111 -Force | ||
| ``` | ||
|
|
||
| Example 2 removes all app registrations linked to the specified billing policy without prompting for confirmation. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -PolicyId | ||
|
|
||
| The unique identifier of the SPO Service Prioritization billing policy whose app registrations should be removed. | ||
|
|
||
| ```yaml | ||
| Type: Guid | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Force | ||
|
|
||
| Suppresses the confirmation prompt. Without this switch, the cmdlet displays the number of app registrations that will be deleted and requires confirmation before proceeding. | ||
|
|
||
| ```yaml | ||
| Type: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: False | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -WhatIf | ||
|
|
||
| Shows what would happen if the cmdlet runs. The cmdlet is not run. | ||
|
|
||
| ```yaml | ||
| Type: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: wi | ||
|
|
||
| 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: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: cf | ||
|
|
||
| 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 | ||
|
|
||
| [Get-SPOServicePrioritizationAppRegistrations](Get-SPOServicePrioritizationAppRegistrations.md) | ||
|
|
||
| [Add-SPOServicePrioritizationAppRegistration](Add-SPOServicePrioritizationAppRegistration.md) | ||
|
|
||
| [Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md) | ||
|
|
||
| [Remove-SPOServicePrioritizationBillingPolicy](Remove-SPOServicePrioritizationBillingPolicy.md) | ||
|
|
||
| [Get-SPOServicePrioritizationBillingPolicies](Get-SPOServicePrioritizationBillingPolicies.md) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| --- | ||
|
JuanOriana marked this conversation as resolved.
|
||
| external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml | ||
| Module Name: Microsoft.Online.SharePoint.PowerShell | ||
| online version: https://learn.microsoft.com/powershell/module/sharepoint-online/remove-sposerviceprioritizationbillingpolicy | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| title: Remove-SPOServicePrioritizationBillingPolicy | ||
| schema: 2.0.0 | ||
| author: juanoriana | ||
| ms.author: | ||
| ms.reviewer: | ||
| --- | ||
|
|
||
| # Remove-SPOServicePrioritizationBillingPolicy | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Removes all app registrations linked to a SharePoint Online Service Prioritization billing policy and then deletes the billing policy itself. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationBillingPolicy -PolicyId <Guid> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| This cmdlet removes all app registrations associated with the specified billing policy in a single server-side operation, and then deletes the billing policy from Azure Resource Manager. | ||
|
|
||
| The billing policy is only deleted if all linked app registrations were successfully removed. If any registrations could not be confirmed as deleted, the billing policy is left intact and the unconfirmed app IDs are reported in `FailedAppIds`. | ||
|
|
||
| By default, the cmdlet prompts for confirmation before deleting. Use `-Force` to suppress the confirmation prompt. | ||
|
|
||
| You must be a SharePoint Online administrator to run this cmdlet. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationBillingPolicy -PolicyId 11111111-1111-1111-1111-111111111111 | ||
| ``` | ||
|
|
||
| Example 1 prompts for confirmation, then removes all app registrations linked to the specified billing policy and deletes the billing policy. | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationBillingPolicy -PolicyId 11111111-1111-1111-1111-111111111111 -Force | ||
| ``` | ||
|
|
||
| Example 2 removes all app registrations linked to the specified billing policy and deletes the billing policy without prompting for confirmation. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -PolicyId | ||
|
|
||
| The unique identifier of the SPO Service Prioritization billing policy to remove. | ||
|
|
||
| ```yaml | ||
| Type: Guid | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: True | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Force | ||
|
|
||
| Suppresses the confirmation prompt. Without this switch, the cmdlet displays the number of app registrations and billing policy that will be deleted and requires confirmation before proceeding. | ||
|
|
||
| ```yaml | ||
| Type: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: False | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -WhatIf | ||
|
|
||
| Shows what would happen if the cmdlet runs. The cmdlet is not run. | ||
|
|
||
| ```yaml | ||
| Type: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: wi | ||
|
|
||
| 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: SwitchParameter | ||
| Parameter Sets: (All) | ||
| Aliases: cf | ||
|
|
||
| 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 | ||
|
|
||
| If `BillingPolicyDeleted` is `false` and `FailedAppIds` is `null`, the app registrations were removed but the billing policy itself could not be deleted. The billing policy may need to be removed manually. | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Get-SPOServicePrioritizationAppRegistrations](Get-SPOServicePrioritizationAppRegistrations.md) | ||
|
|
||
| [Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md) | ||
|
|
||
| [Remove-SPOServicePrioritizationAppRegistrationsByPolicy](Remove-SPOServicePrioritizationAppRegistrationsByPolicy.md) | ||
|
|
||
| [New-SPOServicePrioritizationBillingPolicy](New-SPOServicePrioritizationBillingPolicy.md) | ||
|
|
||
| [Get-SPOServicePrioritizationBillingPolicies](Get-SPOServicePrioritizationBillingPolicies.md) | ||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this cmdlet doesn't have any parametersetnames, according to the backend code, so this shouldn't be here.
I'd suggest you re-generate templates for your cmdlet implementation. tapswiki should have details, but copying snapshot here:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samkabue not sure I follow this one - the PolicyId param was added as part of the backend code change (the templates were regenerated based on the last dll).
Do let me know if I'm missing something
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JuanOriana I'm specifically talking about
ParameteSetNamenotParam(2 different things :))