-
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 2 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 |
|---|---|---|
| @@ -1,41 +1,78 @@ | ||
| --- | ||
| 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-SPOServicePrioritizationAppRegistrations | ||
| applicable: SharePoint Online | ||
| title: Get-SPOServicePrioritizationAppRegistrations | ||
| online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-sposerviceprioritizationappregistrations | ||
| schema: 2.0.0 | ||
| author: samkabue | ||
| ms.author: speedta | ||
| ms.reviewer: speedta | ||
|
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. revert or update these #Closed |
||
| --- | ||
|
|
||
| # 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) | ||
|
|
||
|
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 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:
Author
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. @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
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. @JuanOriana I'm specifically talking about |
||
| ```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. | ||
|
|
||
| The `Get-SPOServicePrioritizationAppRegistrations` cmdlet retrieves all app registrations enrolled in SharePoint Online Service Prioritization for the tenant. | ||
|
JuanOriana marked this conversation as resolved.
Outdated
|
||
|
|
||
| When `-PolicyId` is specified, only registrations linked to that billing policy are returned. The filtering is performed server-side, so only matching records are transferred. | ||
|
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. |
||
|
|
||
| You must be a SharePoint Online administrator to run this cmdlet. | ||
|
JuanOriana marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
| ### Example 1: Get all app registrations | ||
|
JuanOriana marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```powershell | ||
| Get-SPOServicePrioritizationAppRegistrations | ||
| ``` | ||
| This example retrieves all app registrations configured for service prioritization in SharePoint Online. | ||
|
|
||
| Returns all app registrations enrolled in SharePoint Online Service Prioritization for the tenant. | ||
|
|
||
| ### Example 2: Get app registrations for a specific billing policy | ||
|
|
||
| ```powershell | ||
| Get-SPOServicePrioritizationAppRegistrations -PolicyId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
|
JuanOriana marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| 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 | ||
|
|
@@ -44,20 +81,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable | |
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
| ### Microsoft.Online.SharePoint.PowerShell.SPOServicePrioritizationAppRegistrationCmdLetObj | ||
|
|
||
| ## NOTES | ||
| Each output object has the following properties: | ||
|
|
||
| ## RELATED LINKS | ||
| | Property | Type | Description | | ||
| |---|---|---| | ||
| | AppId | String | The application (client) ID of the registered app. | | ||
| | PolicyId | String | The billing policy ID the app is linked to. | | ||
| | Enabled | String | Whether the registration is currently active. | | ||
| | QuotaMultiplier | Int32 | The throttling quota multiplier applied to this app (2–10). | | ||
|
JuanOriana marked this conversation as resolved.
Outdated
|
||
|
|
||
| [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) | ||
| ## NOTES | ||
|
|
||
| [Add-SPOServicePrioritizationAppRegistration](./Add-SPOServicePrioritizationAppRegistration.md) | ||
| ## RELATED LINKS | ||
|
|
||
| [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,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-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. |
||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # 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 | ||
|
|
||
| The `Remove-SPOServicePrioritizationAppRegistrationsByPolicy` cmdlet removes all app registrations associated with the specified billing policy in a single server-side operation. | ||
|
|
||
| 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. | ||
|
|
||
| You must be a SharePoint Online administrator to run this cmdlet. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1: Remove all app registrations for a billing policy | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | ||
| ``` | ||
|
|
||
| Prompts for confirmation, then removes all app registrations linked to the specified billing policy. | ||
|
|
||
| ### Example 2: Remove without confirmation prompt | ||
|
|
||
| ```powershell | ||
| Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Force | ||
| ``` | ||
|
|
||
| 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 | ||
|
|
||
| ### Microsoft.Online.SharePoint.PowerShell.SPOServicePrioritizationBulkDeleteResult | ||
|
|
||
| | Property | Type | Description | | ||
| |---|---|---| | ||
| | SuccessCount | Int32 | The number of app registrations successfully removed. | | ||
| | FailedAppIds | List\<String\> | App IDs that could not be confirmed as deleted, populated only when the server reports fewer deletions than expected. `null` when all registrations were deleted successfully. | | ||
| | BillingPolicyDeleted | Boolean | Always `false` for this cmdlet. Use `Remove-SPOServicePrioritizationBillingPolicy` to delete the billing policy. | | ||
|
|
||
| ## 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) | ||
Uh oh!
There was an error while loading. Please reload this page.