Skip to content

Commit cb99294

Browse files
juanorianaclaude
juanoriana
and
claude
committed
Add/update SPO Service Prioritization cmdlet docs
Add Remove-SPOServicePrioritizationAppRegistrationsByPolicy and Remove-SPOServicePrioritizationBillingPolicy docs, and update Get-SPOServicePrioritizationAppRegistrations with ByPolicy parameter set. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 242879c commit cb99294

File tree

3 files changed

+352
-20
lines changed

3 files changed

+352
-20
lines changed

‎sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOServicePrioritizationAppRegistrations.md‎

Lines changed: 62 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,78 @@
11
---
22
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
33
Module Name: Microsoft.Online.SharePoint.PowerShell
4-
online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/Get-SPOServicePrioritizationAppRegistrations
5-
applicable: SharePoint Online
6-
title: Get-SPOServicePrioritizationAppRegistrations
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-sposerviceprioritizationappregistrations
75
schema: 2.0.0
8-
author: samkabue
9-
ms.author: speedta
10-
ms.reviewer: speedta
116
---
127

138
# Get-SPOServicePrioritizationAppRegistrations
149

1510
## SYNOPSIS
16-
Retrieves the list of app registrations configured for service prioritization in SharePoint Online.
1711

12+
Returns app registrations enrolled in SharePoint Online Service Prioritization.
1813

1914
## SYNTAX
2015

21-
```
16+
### All (Default)
17+
18+
```powershell
2219
Get-SPOServicePrioritizationAppRegistrations [<CommonParameters>]
2320
```
2421

22+
### ByPolicy
23+
24+
```powershell
25+
Get-SPOServicePrioritizationAppRegistrations -PolicyId <Guid> [<CommonParameters>]
26+
```
27+
2528
## DESCRIPTION
26-
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.
29+
30+
The `Get-SPOServicePrioritizationAppRegistrations` cmdlet retrieves all app registrations enrolled in SharePoint Online Service Prioritization for the tenant.
31+
32+
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.
33+
34+
You must be a SharePoint Online administrator to run this cmdlet.
2735

2836
## EXAMPLES
2937

30-
### Example 1
38+
### Example 1: Get all app registrations
39+
3140
```powershell
3241
Get-SPOServicePrioritizationAppRegistrations
3342
```
34-
This example retrieves all app registrations configured for service prioritization in SharePoint Online.
43+
44+
Returns all app registrations enrolled in SharePoint Online Service Prioritization for the tenant.
45+
46+
### Example 2: Get app registrations for a specific billing policy
47+
48+
```powershell
49+
Get-SPOServicePrioritizationAppRegistrations -PolicyId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
50+
```
51+
52+
Returns only app registrations linked to the specified billing policy.
3553

3654
## PARAMETERS
3755

56+
### -PolicyId
57+
58+
The unique identifier of the SPO Service Prioritization billing policy to filter by.
59+
When specified, only app registrations linked to this policy are returned.
60+
When omitted, all app registrations for the tenant are returned.
61+
62+
```yaml
63+
Type: Guid
64+
Parameter Sets: ByPolicy
65+
Aliases:
66+
67+
Required: False
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
3874
### CommonParameters
75+
3976
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).
4077
4178
## INPUTS
@@ -44,20 +81,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
4481
4582
## OUTPUTS
4683
47-
### System.Object
84+
### Microsoft.Online.SharePoint.PowerShell.SPOServicePrioritizationAppRegistrationCmdLetObj
4885
49-
## NOTES
86+
Each output object has the following properties:
5087
51-
## RELATED LINKS
88+
| Property | Type | Description |
89+
|---|---|---|
90+
| AppId | String | The application (client) ID of the registered app. |
91+
| PolicyId | String | The billing policy ID the app is linked to. |
92+
| Enabled | String | Whether the registration is currently active. |
93+
| QuotaMultiplier | Int32 | The throttling quota multiplier applied to this app (2–10). |
5294
53-
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
95+
## NOTES
5496
55-
[Add-SPOServicePrioritizationAppRegistration](./Add-SPOServicePrioritizationAppRegistration.md)
97+
## RELATED LINKS
5698
57-
[Remove-SPOServicePrioritizationAppRegistration](./Remove-SPOServicePrioritizationAppRegistration.md)
99+
[Add-SPOServicePrioritizationAppRegistration](Add-SPOServicePrioritizationAppRegistration.md)
58100
59-
[New-SPOServicePrioritizationBillingPolicy](./New-SPOServicePrioritizationBillingPolicy.md)
101+
[Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md)
60102
61-
[Get-SPOServicePrioritizationBillingPolicies](./Get-SPOServicePrioritizationBillingPolicies.md)
103+
[Remove-SPOServicePrioritizationAppRegistrationsByPolicy](Remove-SPOServicePrioritizationAppRegistrationsByPolicy.md)
62104
63-
[Set-SPOServicePrioritizationAppRegistration](./Set-SPOServicePrioritizationAppRegistration.md)
105+
[Get-SPOServicePrioritizationBillingPolicies](Get-SPOServicePrioritizationBillingPolicies.md)

‎sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOServicePrioritizationAppRegistrationsByPolicy.md‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/remove-sposerviceprioritizationappregistrationsbypolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-SPOServicePrioritizationAppRegistrationsByPolicy
9+
10+
## SYNOPSIS
11+
12+
Removes all app registrations linked to a specific SharePoint Online Service Prioritization billing policy.
13+
14+
## SYNTAX
15+
16+
```powershell
17+
Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId <Guid> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
22+
The `Remove-SPOServicePrioritizationAppRegistrationsByPolicy` cmdlet removes all app registrations associated with the specified billing policy in a single server-side operation.
23+
24+
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.
25+
26+
By default, the cmdlet prompts for confirmation before deleting. Use `-Force` to suppress the confirmation prompt.
27+
28+
You must be a SharePoint Online administrator to run this cmdlet.
29+
30+
## EXAMPLES
31+
32+
### Example 1: Remove all app registrations for a billing policy
33+
34+
```powershell
35+
Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
36+
```
37+
38+
Prompts for confirmation, then removes all app registrations linked to the specified billing policy.
39+
40+
### Example 2: Remove without confirmation prompt
41+
42+
```powershell
43+
Remove-SPOServicePrioritizationAppRegistrationsByPolicy -PolicyId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -Force
44+
```
45+
46+
Removes all app registrations linked to the specified billing policy without prompting for confirmation.
47+
48+
## PARAMETERS
49+
50+
### -PolicyId
51+
52+
The unique identifier of the SPO Service Prioritization billing policy whose app registrations should be removed.
53+
54+
```yaml
55+
Type: Guid
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: True
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Force
67+
68+
Suppresses the confirmation prompt. Without this switch, the cmdlet displays the number of app registrations that will be deleted and requires confirmation before proceeding.
69+
70+
```yaml
71+
Type: SwitchParameter
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: Named
77+
Default value: False
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -WhatIf
83+
84+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
85+
86+
```yaml
87+
Type: SwitchParameter
88+
Parameter Sets: (All)
89+
Aliases: wi
90+
91+
Required: False
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
### -Confirm
99+
100+
Prompts you for confirmation before running the cmdlet.
101+
102+
```yaml
103+
Type: SwitchParameter
104+
Parameter Sets: (All)
105+
Aliases: cf
106+
107+
Required: False
108+
Position: Named
109+
Default value: None
110+
Accept pipeline input: False
111+
Accept wildcard characters: False
112+
```
113+
114+
### CommonParameters
115+
116+
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).
117+
118+
## INPUTS
119+
120+
### None
121+
122+
## OUTPUTS
123+
124+
### Microsoft.Online.SharePoint.PowerShell.SPOServicePrioritizationBulkDeleteResult
125+
126+
| Property | Type | Description |
127+
|---|---|---|
128+
| SuccessCount | Int32 | The number of app registrations successfully removed. |
129+
| 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. |
130+
| BillingPolicyDeleted | Boolean | Always `false` for this cmdlet. Use `Remove-SPOServicePrioritizationBillingPolicy` to delete the billing policy. |
131+
132+
## NOTES
133+
134+
## RELATED LINKS
135+
136+
[Get-SPOServicePrioritizationAppRegistrations](Get-SPOServicePrioritizationAppRegistrations.md)
137+
138+
[Add-SPOServicePrioritizationAppRegistration](Add-SPOServicePrioritizationAppRegistration.md)
139+
140+
[Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md)
141+
142+
[Remove-SPOServicePrioritizationBillingPolicy](Remove-SPOServicePrioritizationBillingPolicy.md)
143+
144+
[Get-SPOServicePrioritizationBillingPolicies](Get-SPOServicePrioritizationBillingPolicies.md)

0 commit comments

Comments
 (0)