Skip to content

Commit 4d926d1

Browse files
SimonBourdagesSimonBourdages
committed
Added commands for SPO app priortiziation policies
1 parent 18a772d commit 4d926d1

5 files changed

Lines changed: 386 additions & 0 deletions

File tree

‎sharepoint/sharepoint-ps/sharepoint-online/Add-SPOAppPrioritizationPolicy.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Add-SPOAppPrioritizationPolicy
5+
applicable: SharePoint Online
6+
title: Add-SPOAppPrioritizationPolicy
7+
schema: 2.0.0
8+
author: Sibourda
9+
ms.author: Sibourda
10+
ms.reviewer:
11+
---
12+
13+
# Add-SPOAppPrioritizationPolicy
14+
15+
## SYNOPSIS
16+
17+
Adds a new SPO App Prioritization Policy to your tenancy.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Add-SPOAppPrioritizationPolicies -AppId <Guid string of the app you need SPAP enabled for> -AzureSubscriptionId <Guid string of the Azure Subscription Id> -ResourceGroup <String> -Account <String> -QuotaMultiplier <int>
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet adds a new SPO App Prioritization Billing policies to your tenancy. You must be a SharePoint you must be a SharePoint Tenant Admin to run the commandlet. You need to make sure you’re not adding a new billing policy for an app that already has a billing policy to it.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
33+
```powershell
34+
Add-SPOAppPrioritizationPolicies -AppId 48ab2ba9-5713-47d6-88a1-f6e3a0730833 -AzureSubscriptionId 48ab1ba4-9813-47d6-88a1-f6e3a0730822 -ResourceGroup newResourceGroup -Account newAccountName -QuotaMultiplier 5
35+
```
36+
37+
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.
38+
39+
40+
## PARAMETERS
41+
42+
### -AppId
43+
44+
This parameter specifies the app ID of the application to onboard.
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
Applicable: SharePoint Online
50+
51+
Required: True
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -AzureSubscriptionId
59+
60+
This parameter describes the Azure subscription ID to which the container type needs to be associated.
61+
62+
```yaml
63+
Type: String
64+
Parameter Sets: (All)
65+
Aliases:
66+
Applicable: SharePoint Online
67+
68+
Required: True
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
76+
### -ResourceGroup
77+
78+
This parameter describes the resource group to be used for the associated container type.
79+
80+
```yaml
81+
Type: String
82+
Parameter Sets: (All)
83+
Aliases:
84+
Applicable: SharePoint Online
85+
86+
Required: True
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### -Account
94+
95+
This parameter describes the account to which the billing profile of the container type is associated with.
96+
97+
```yaml
98+
Type: String
99+
Parameter Sets: (All)
100+
Aliases:
101+
Applicable: SharePoint Online
102+
103+
Required: True
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
### -QuotaMultiplier
110+
111+
This parameter specifies the multiplier for the scaling feature.
112+
113+
```yaml
114+
Type: int
115+
Parameter Sets: (All)
116+
Aliases:
117+
Applicable: SharePoint Online
118+
119+
Required: True
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
126+
127+
## RELATED LINKS
128+
129+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
130+
131+
[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md)
132+
133+
[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md)
134+
135+
[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md)
136+
137+
[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAppPrioritizationPolicies.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Get-SPOAppPrioritizationPolicies
5+
applicable: SharePoint Online
6+
title: Get-SPOAppPrioritizationPolicies
7+
schema: 2.0.0
8+
author: Sibourda
9+
ms.author: Sibourda
10+
ms.reviewer:
11+
---
12+
13+
# Get-SPOAppPrioritizationPolicies
14+
15+
## SYNOPSIS
16+
17+
Gets all existing SPO App Prioritization Policies of your tenancy
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Get-SPOAppPrioritizationPolicies
23+
```
24+
25+
26+
## DESCRIPTION
27+
28+
This cmdlet adds a new SPO App Prioritization Billing policies to your tenancy. You must be a SharePoint you must be a SharePoint Tenant Admin to run the commandlet. You need to make sure you’re not adding a new billing policy for an app that already has a billing policy to it.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Get- SPOAppPrioritizationPolicies
36+
```
37+
38+
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
39+
40+
41+
## PARAMETERS
42+
43+
44+
45+
## RELATED LINKS
46+
47+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
48+
49+
[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md)
50+
51+
[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md)
52+
53+
[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md)
54+
55+
[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOAppPrioritizationPolicy.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Remove-SPOAppPrioritizationPolicy
5+
applicable: SharePoint Online
6+
title: Remove-SPOAppPrioritizationPolicy
7+
schema: 2.0.0
8+
author: Sibourda
9+
ms.author: Sibourda
10+
ms.reviewer:
11+
---
12+
13+
# Remove-SPOAppPrioritizationPolicy
14+
15+
## SYNOPSIS
16+
17+
Deletes an existing SPO App Prioritization Policy in your tenancy.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Remove-SPOAppPrioritizationPolicy -PolicyId <string>
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet lets you delete an existing policy.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
33+
```powershell
34+
Remove-SPOAppPrioritizationPolicy -PolicyId 48abxxa9
35+
```
36+
37+
Example 1 deletes the policy bearing the policyId 48abxxa9. Running the Get command will no longer show the policy in the result.
38+
39+
## PARAMETERS
40+
41+
### -PolicyId
42+
43+
This parameter specifies the ID of policy.
44+
```yaml
45+
Type: String
46+
Parameter Sets: (All)
47+
Aliases:
48+
Applicable: SharePoint Online
49+
50+
Required: True
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
## RELATED LINKS
58+
59+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
60+
61+
[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md)
62+
63+
[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md)
64+
65+
[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md)
66+
67+
[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Set-SPOAppPrioritizationPolicy.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOAppPrioritizationPolicy
5+
applicable: SharePoint Online
6+
title: Set-SPOAppPrioritizationPolicy
7+
schema: 2.0.0
8+
author: Sibourda
9+
ms.author: Sibourda
10+
ms.reviewer:
11+
---
12+
13+
# Set-SPOAppPrioritizationPolicy
14+
15+
## SYNOPSIS
16+
17+
Edits an existing SPO App Prioritization Policy in your tenancy.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Set-SPOAppPrioritizationPolicy -PolicyId <string> -Enabled <boolean> -QuotaMultiplier <int>
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet lets you enable or disable an existing policy and/or change the quotaMultiplier 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 commandlet. Both the parameters are mandatory.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
33+
```powershell
34+
Set-SPOAppPrioritizationPolicies -PolicyId 48abxxa9 -Enabled $false -QuotaMultiplier 4
35+
```
36+
37+
Example 1 disables the policy bearing the policyId 48abxxa9
38+
39+
### Example 2
40+
41+
```powershell
42+
Set-SPOAppPrioritizationPolicies -PolicyId 48abxxa9 -Enabled $true -QuotaMultiplier 7
43+
```
44+
45+
Example 2 enables the policy bearing the policyId 48abxxa9 and also sets the QuotaMultiplier to 7.
46+
47+
48+
## PARAMETERS
49+
50+
### -PolicyId
51+
52+
This parameter specifies the ID of policy.
53+
```yaml
54+
Type: String
55+
Parameter Sets: (All)
56+
Aliases:
57+
Applicable: SharePoint Online
58+
59+
Required: True
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Enabled
67+
68+
This parameter described the state wanted of the policy.
69+
70+
```yaml
71+
Type: Bool
72+
Parameter Sets: (All)
73+
Aliases:
74+
Applicable: SharePoint Online
75+
76+
Required: True
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
84+
### -QuotaMultiplier
85+
86+
This parameter specifies the multiplier for the scaling feature.
87+
88+
```yaml
89+
Type: int
90+
Parameter Sets: (All)
91+
Aliases:
92+
Applicable: SharePoint Online
93+
94+
Required: True
95+
Position: Named
96+
Default value: None
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
## RELATED LINKS
102+
103+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
104+
105+
[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md)
106+
107+
[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md)
108+
109+
[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md)
110+
111+
[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md)

0 commit comments

Comments
 (0)