Skip to content

Commit debcd30

Browse files
aditisrivastava07aditisrivastava07
authored
Merge pull request #882 from ShreyasSar26/patch-1
Changes to Set-SPOContainerType cmdlet
2 parents 62c7567 + 405b2dd commit debcd30

File tree

1 file changed

+91
-41
lines changed

1 file changed

+91
-41
lines changed

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

Lines changed: 91 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,44 @@ ms.reviewer:
1111
---
1212

1313
# Set-SPOContainerType
14-
14+
1515
## SYNOPSIS
16-
17-
Sets or updates one or more property values of a trial or standard container type.
18-
16+
17+
Sets or updates one or more property values of a trial, standard or a direct to customer billed container type.
18+
1919
## SYNTAX
20-
21-
### ParamSet1
22-
23-
```powershell
24-
Set-SPOContainerType -ContainerTypeId <ContainerTypeId> -OwningApplicationId <OwningApplicationId> -ContainerTypeName <ContainerTypeName>
20+
21+
### ContainerTypeName
2522
```
26-
### ParamSet2
27-
```powershell
28-
Set-SPOContainerType -ContainerTypeId <ContainerTypeId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup>
23+
Set-SPOContainerType -ContainerTypeId <Guid> [-ContainerTypeName] <String> [-WhatIf] [-Confirm]
24+
[<CommonParameters>]
2925
```
30-
26+
27+
### AzureSubscriptionId
28+
```
29+
Set-SPOContainerType -ContainerTypeId <Guid> [[-AzureSubscriptionId] <Guid>] [-ResourceGroup] <String>
30+
[-WhatIf] [-Confirm] [<CommonParameters>]
31+
```
32+
33+
### ApplicationRedirectUrl
34+
```
35+
Set-SPOContainerType -ContainerTypeId <Guid> [-ApplicationRedirectUrl] <String> [-WhatIf] [-Confirm]
36+
[<CommonParameters>]
37+
```
38+
3139
## DESCRIPTION
32-
This cmdlet is used to reset the parameters associated with a container type - both trial and standard. The cmdlet can be used to change the basic information of a container type such as container type name, owning application ID or the billing information of the container type.
40+
41+
This cmdlet updates the existing property of a container type with the new value provided. The cmdlet can be used to change the basic information of a container type such as container type name or the billing information of the container type.
3342

3443
You must be a SharePoint Embedded Administrator to run the cmdlet.
3544

36-
While you only need to be a SharePoint Embedded Administrator to change the basic information of a container type, you need owner or contributor access on the existing billing subscription associated with the container type and also on the new billing subscription, to change the billing information of the container type.
45+
While you only need to be a SharePoint Embedded Administrator to set the basic information of a container type, you need owner or contributor access on the existing billing subscription associated with the container type and also on the new billing subscription, to change the billing information of the container type. List of parameters that cannot be updated includes container type ID and owning application ID.
3746

3847
For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).
3948

49+
4050
## EXAMPLES
41-
51+
4252
### Example 1
4353

4454
```powershell
@@ -64,78 +74,117 @@ Set-SPOContainerType -ContainerTypeId 01f62754-0873-4ec6-ab4a-3eed48ba8be7 -Owni
6474
In Example 3, the trial container type name is updated as 'Blue Container Type'
6575

6676

67-
6877
## PARAMETERS
69-
70-
71-
### -ContainerTypeName
7278

73-
This parameter names your container type for your SharePoint Embedded application.
79+
### -ApplicationRedirectUrl
80+
This parameter sets the application redirect Url for the container type.
7481

7582
```yaml
7683
Type: String
77-
Parameter Sets: (All)
84+
Parameter Sets: ApplicationRedirectUrl
7885
Aliases:
79-
Applicable: SharePoint Online
8086

8187
Required: True
82-
Position: Named
88+
Position: 0
8389
Default value: None
8490
Accept pipeline input: False
8591
Accept wildcard characters: False
8692
```
8793
88-
### -OwningApplicationId
89-
90-
This parameter specifies the ID of the SharePoint Embedded application.
94+
### -AzureSubscriptionId
95+
Use this parameter to set the Azure billing subscription ID you wish to attach to the container type.
9196
9297
```yaml
93-
Type: String
94-
Parameter Sets:
98+
Type: Guid
99+
Parameter Sets: AzureSubscriptionId
95100
Aliases:
96-
Applicable: SharePoint Online
97101

98-
Required: True
99-
Position: Named
102+
Required: False
103+
Position: 1
100104
Default value: None
101105
Accept pipeline input: False
102106
Accept wildcard characters: False
103107
```
104108
105-
### -AzureSubscriptionId
109+
### -Confirm
110+
Prompts you for confirmation before running the cmdlet.
111+
112+
```yaml
113+
Type: SwitchParameter
114+
Parameter Sets: (All)
115+
Aliases: cf
116+
117+
Required: False
118+
Position: Named
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
106123
107-
This parameter describes the Azure subscription ID to which the container type needs to be associated.
124+
### -ContainerTypeId
125+
Use this parameter to enter the container type ID
108126
109127
```yaml
110-
Type: String
128+
Type: Guid
111129
Parameter Sets: (All)
112130
Aliases:
113-
Applicable: SharePoint Online
114131

115-
Required: False
132+
Required: True
116133
Position: Named
117134
Default value: None
118135
Accept pipeline input: False
119136
Accept wildcard characters: False
120137
```
121138
139+
### -ContainerTypeName
140+
Use this parameter to pass the conatiner type name you intend to use for the container type
122141
123-
### -ResourceGroup
142+
```yaml
143+
Type: String
144+
Parameter Sets: ContainerTypeName
145+
Aliases:
124146

125-
This parameter describes the resource group to be used for the associated container type.
147+
Required: True
148+
Position: 0
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
154+
### -ResourceGroup
155+
Use this parameter to set the Azure resource group of the associated Azure billing subscription you intend to attach to the container type.
126156
127157
```yaml
128158
Type: String
129-
Parameter Sets:
159+
Parameter Sets: AzureSubscriptionId
130160
Aliases:
131-
Applicable: SharePoint Online
161+
162+
Required: True
163+
Position: 0
164+
Default value: None
165+
Accept pipeline input: False
166+
Accept wildcard characters: False
167+
```
168+
169+
### -WhatIf
170+
Shows what would happen if the cmdlet runs.
171+
The cmdlet is not run.
172+
173+
```yaml
174+
Type: SwitchParameter
175+
Parameter Sets: (All)
176+
Aliases: wi
132177

133178
Required: False
134179
Position: Named
135180
Default value: None
136181
Accept pipeline input: False
137182
Accept wildcard characters: False
138183
```
184+
185+
### CommonParameters
186+
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).
187+
139188
## RELATED LINKS
140189

141190
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
@@ -145,3 +194,4 @@ Accept wildcard characters: False
145194
[Get-SPOContainerType](./Get-SPOContainerType.md)
146195

147196
[Remove-SPOContainerType](./Remove-SPOContainerType.md)
197+

0 commit comments

Comments
 (0)