Skip to content

Commit 8d3b8b6

Browse files
padmagit77padmagit77
authored
Merge pull request #1127 from JuanOriana/user/juanoriana/spsp-service-prioritization-cmdlet-docs
Add/update SPO Service Prioritization cmdlet docs
2 parents 55d4d88 + 68fa57b commit 8d3b8b6

4 files changed

Lines changed: 331 additions & 13 deletions

File tree

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

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,61 @@ ms.reviewer: speedta
1313
# Get-SPOServicePrioritizationAppRegistrations
1414

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

17+
Returns app registrations enrolled in SharePoint Online Service Prioritization.
1818

1919
## SYNTAX
2020

2121
```
22-
Get-SPOServicePrioritizationAppRegistrations [<CommonParameters>]
22+
Get-SPOServicePrioritizationAppRegistrations [-PolicyId <Guid>] [<CommonParameters>]
2323
```
2424

2525
## 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.
26+
27+
This cmdlet retrieves all app registrations enrolled in SharePoint Online Service Prioritization for the tenant.
28+
29+
When `-PolicyId` is specified, only registrations linked to that billing policy are returned.
2730

2831
## EXAMPLES
2932

3033
### Example 1
34+
3135
```powershell
3236
Get-SPOServicePrioritizationAppRegistrations
3337
```
34-
This example retrieves all app registrations configured for service prioritization in SharePoint Online.
38+
39+
Example 1 returns all app registrations enrolled in SharePoint Online Service Prioritization for the tenant.
40+
41+
### Example 2
42+
43+
```powershell
44+
Get-SPOServicePrioritizationAppRegistrations -PolicyId 11111111-1111-1111-1111-111111111111
45+
```
46+
47+
Example 2 returns only app registrations linked to the specified billing policy.
3548

3649
## PARAMETERS
3750

51+
### -PolicyId
52+
53+
The unique identifier of the SPO Service Prioritization billing policy to filter by.
54+
When specified, only app registrations linked to this policy are returned.
55+
When omitted, all app registrations for the tenant are returned.
56+
57+
```yaml
58+
Type: Guid
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: False
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
3869
### CommonParameters
70+
3971
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).
4072
4173
## INPUTS
@@ -50,14 +82,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
5082
5183
## RELATED LINKS
5284
53-
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
54-
55-
[Add-SPOServicePrioritizationAppRegistration](./Add-SPOServicePrioritizationAppRegistration.md)
56-
57-
[Remove-SPOServicePrioritizationAppRegistration](./Remove-SPOServicePrioritizationAppRegistration.md)
85+
[Add-SPOServicePrioritizationAppRegistration](Add-SPOServicePrioritizationAppRegistration.md)
5886
59-
[New-SPOServicePrioritizationBillingPolicy](./New-SPOServicePrioritizationBillingPolicy.md)
87+
[Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md)
6088
61-
[Get-SPOServicePrioritizationBillingPolicies](./Get-SPOServicePrioritizationBillingPolicies.md)
89+
[Remove-SPOServicePrioritizationAppRegistrationsByPolicy](Remove-SPOServicePrioritizationAppRegistrationsByPolicy.md)
6290
63-
[Set-SPOServicePrioritizationAppRegistration](./Set-SPOServicePrioritizationAppRegistration.md)
91+
[Get-SPOServicePrioritizationBillingPolicies](Get-SPOServicePrioritizationBillingPolicies.md)

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,13 @@ Removes a given public CDN origin based on its identity (id) in your SharePoint
576576
Removes Software-Defined Networking (SDN) Support in your SharePoint Online tenant
577577

578578
### [Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md)
579-
Removes an app registration from service prioritization in SharePoint Online.
579+
Removes an app registration from service prioritization in SharePoint Online.
580+
581+
### [Remove-SPOServicePrioritizationAppRegistrationsByPolicy](Remove-SPOServicePrioritizationAppRegistrationsByPolicy.md)
582+
Removes all app registrations linked to a specific SharePoint Online Service Prioritization billing policy.
583+
584+
### [Remove-SPOServicePrioritizationBillingPolicy](Remove-SPOServicePrioritizationBillingPolicy.md)
585+
Removes all app registrations linked to a SharePoint Online Service Prioritization billing policy and then deletes the billing policy itself.
580586

581587
### [Remove-SPOSite](Remove-SPOSite.md)
582588
Sends a SharePoint Online site collection to the SharePoint Online Recycle Bin.

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

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

‎sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOServicePrioritizationBillingPolicy.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/microsoft.online.sharepoint.powershell/Remove-SPOServicePrioritizationBillingPolicy
5+
title: Remove-SPOServicePrioritizationBillingPolicy
6+
schema: 2.0.0
7+
author: juanoriana
8+
ms.author: juanoriana
9+
ms.reviewer:
10+
---
11+
12+
# Remove-SPOServicePrioritizationBillingPolicy
13+
14+
## SYNOPSIS
15+
16+
Removes all app registrations linked to a SharePoint Online Service Prioritization billing policy and then deletes the billing policy itself.
17+
18+
## SYNTAX
19+
20+
```
21+
Remove-SPOServicePrioritizationBillingPolicy -PolicyId <Guid> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
26+
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.
27+
28+
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`.
29+
30+
By default, the cmdlet prompts for confirmation before deleting. Use `-Force` to suppress the confirmation prompt.
31+
32+
You must be a SharePoint Online administrator to run this cmdlet.
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
38+
```powershell
39+
Remove-SPOServicePrioritizationBillingPolicy -PolicyId 11111111-1111-1111-1111-111111111111
40+
```
41+
42+
Example 1 prompts for confirmation, then removes all app registrations linked to the specified billing policy and deletes the billing policy.
43+
44+
### Example 2
45+
46+
```powershell
47+
Remove-SPOServicePrioritizationBillingPolicy -PolicyId 11111111-1111-1111-1111-111111111111 -Force
48+
```
49+
50+
Example 2 removes all app registrations linked to the specified billing policy and deletes the billing policy without prompting for confirmation.
51+
52+
## PARAMETERS
53+
54+
### -PolicyId
55+
56+
The unique identifier of the SPO Service Prioritization billing policy to remove.
57+
58+
```yaml
59+
Type: Guid
60+
Parameter Sets: (All)
61+
Aliases:
62+
63+
Required: True
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### -Force
71+
72+
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.
73+
74+
```yaml
75+
Type: SwitchParameter
76+
Parameter Sets: (All)
77+
Aliases:
78+
79+
Required: False
80+
Position: Named
81+
Default value: False
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -WhatIf
87+
88+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
89+
90+
```yaml
91+
Type: SwitchParameter
92+
Parameter Sets: (All)
93+
Aliases: wi
94+
95+
Required: False
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -Confirm
103+
104+
Prompts you for confirmation before running the cmdlet.
105+
106+
```yaml
107+
Type: SwitchParameter
108+
Parameter Sets: (All)
109+
Aliases: cf
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
118+
### CommonParameters
119+
120+
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).
121+
122+
## INPUTS
123+
124+
### None
125+
126+
## OUTPUTS
127+
128+
### System.Object
129+
130+
## NOTES
131+
132+
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.
133+
134+
## RELATED LINKS
135+
136+
[Get-SPOServicePrioritizationAppRegistrations](Get-SPOServicePrioritizationAppRegistrations.md)
137+
138+
[Remove-SPOServicePrioritizationAppRegistration](Remove-SPOServicePrioritizationAppRegistration.md)
139+
140+
[Remove-SPOServicePrioritizationAppRegistrationsByPolicy](Remove-SPOServicePrioritizationAppRegistrationsByPolicy.md)
141+
142+
[New-SPOServicePrioritizationBillingPolicy](New-SPOServicePrioritizationBillingPolicy.md)
143+
144+
[Get-SPOServicePrioritizationBillingPolicies](Get-SPOServicePrioritizationBillingPolicies.md)

0 commit comments

Comments
 (0)