Skip to content

Commit da6591c

Browse files
authored
Merge branch 'main' into patch-1
2 parents 55cb50d + 47220f7 commit da6591c

File tree

5 files changed

+397
-0
lines changed

5 files changed

+397
-0
lines changed
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
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: killerewok2000
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+
```
22+
Add-SPOAppPrioritizationPolicy -AppId <Guid> -AzureSubscriptionId <Guid> -ResourceGroup <String> -Account <String> -QuotaMultiplier <Int32> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet adds a new SPO app prioritization billing policies to your tenancy. Ensure that you do not add a new billing policy to an app that already has one.
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: Guid
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: Guid
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+
### CommonParameters
126+
127+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
128+
129+
130+
## RELATED LINKS
131+
132+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
133+
134+
[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md)
135+
136+
[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md)
137+
138+
[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.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: killerewok2000
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+
```
22+
Get-SPOAppPrioritizationPolicies [<CommonParameters>]
23+
```
24+
25+
26+
## DESCRIPTION
27+
28+
This cmdlet gets all existing SPO App prioritization billing policies for your tenancy.
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+
### CommonParameters
44+
45+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
46+
47+
## RELATED LINKS
48+
49+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
50+
51+
[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md)
52+
53+
[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md)
54+
55+
[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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: killerewok2000
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+
```
22+
Remove-SPOAppPrioritizationPolicy -PolicyId <String> [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet lets you delete an existing SPO app prioritization 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-SPOAppPrioritizationPolicies` 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+
### CommonParameters
57+
58+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
59+
60+
## RELATED LINKS
61+
62+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
63+
64+
[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md)
65+
66+
[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md)
67+
68+
[Set-SPOAppPrioritizationPolicy](./Set-SPOAppPrioritizationPolicy.md)
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
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: killerewok2000
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+
```
22+
Set-SPOAppPrioritizationPolicy -PolicyId <String> [-Enabled <Boolean>] [-QuotaMultiplier <Int32>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet lets you enable or disable an existing policy and/or change the quota multiplier limit 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-SPOAppPrioritizationPolicies` commandlet.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
33+
```powershell
34+
Set-SPOAppPrioritizationPolicies -PolicyId 48abxxa9 -Enabled $false
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 quota multiplier limit to 7.
46+
47+
### Example 3
48+
49+
```powershell
50+
Set-SPOAppPrioritizationPolicies -PolicyId 48abxxa9 -QuotaMultiplier 8
51+
```
52+
53+
Example 3 set the quota multiplier limit to 7 of the policy bearing the policyId 48abxxa9.
54+
55+
## PARAMETERS
56+
57+
### -PolicyId
58+
59+
This parameter specifies the ID of policy.
60+
```yaml
61+
Type: String
62+
Parameter Sets: (All)
63+
Aliases:
64+
Applicable: SharePoint Online
65+
66+
Required: True
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### -Enabled
74+
75+
This parameter described the state wanted of the policy.
76+
77+
```yaml
78+
Type: Bool
79+
Parameter Sets: (All)
80+
Aliases:
81+
Applicable: SharePoint Online
82+
83+
Required: False
84+
Position: Named
85+
Default value: None
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
91+
### -QuotaMultiplier
92+
93+
This parameter specifies the quota multiplier limit for the scaling feature. Value must be between 1 and 10.
94+
95+
```yaml
96+
Type: int
97+
Parameter Sets: (All)
98+
Aliases:
99+
Applicable: SharePoint Online
100+
101+
Required: False
102+
Position: Named
103+
Default value: None
104+
Accept pipeline input: False
105+
Accept wildcard characters: False
106+
```
107+
108+
### CommonParameters
109+
110+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
111+
112+
## RELATED LINKS
113+
114+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
115+
116+
[Add-SPOAppPrioritizationPolicy](./Add-SPOAppPrioritizationPolicy.md)
117+
118+
[Get-SPOAppPrioritizationPolicies](./Get-SPOAppPrioritizationPolicies.md)
119+
120+
[Remove-SPOAppPrioritizationPolicy](./Remove-SPOAppPrioritizationPolicy.md)

0 commit comments

Comments
 (0)