Skip to content

Commit 6265a4b

Browse files
aditisrivastava07aditisrivastava07
authored
Merge pull request #671 from ShreyasSar26/patch-1
Container type cmdlets PR
2 parents 3907141 + 081a764 commit 6265a4b

File tree

4 files changed

+486
-0
lines changed

4 files changed

+486
-0
lines changed

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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-spocontainertype
5+
applicable: SharePoint Online
6+
title: Get-SPOContainerType
7+
schema: 2.0.0
8+
author: ShreyasSar26
9+
ms.author: shsaravanan
10+
ms.reviewer:
11+
---
12+
13+
# Get-SPOContainerType
14+
15+
## SYNOPSIS
16+
17+
Returns one or more container types created in the tenant.
18+
19+
## SYNTAX
20+
21+
### ParamSet1
22+
23+
```powershell
24+
Get-SPOContainerType
25+
```
26+
### ParamSet2
27+
```powershell
28+
Get-SPOContainerType [-ContainerTypeId <ContainerTypeId>]
29+
```
30+
31+
## DESCRIPTION
32+
33+
This cmdlet returns all the container types present in the tenant or details of a specific container type when paired with the containertype ID parameter.
34+
35+
You must be a SharePoint Embedded Administrator to run the cmdlet.
36+
37+
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).
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
43+
```powershell
44+
Get-SPOContainerType
45+
```
46+
47+
Example 1 retrieves all the container types present in the tenant and displays container type specific information.
48+
49+
### Example 2
50+
51+
```powershell
52+
Get-SPOContainerType -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4
53+
```
54+
Example 2 returns the detailed properties of container type 4f0af585-8dcc-0000-223d-661eb2c604e4
55+
56+
## PARAMETERS
57+
58+
### -ContainerTypeId
59+
60+
This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application.
61+
```yaml
62+
Type: String
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: SharePoint Online
66+
67+
Required: True
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
## RELATED LINKS
74+
75+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
76+
77+
[New-SPOContainerType](./New-SPOContainerType.md)
78+
79+
[Set-SPOContainerType](./Set-SPOContainerType.md)
80+
81+
[Remove-SPOContainerType](./Remove-SPOContainerType.md)

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

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
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/new-spocontainertype
5+
applicable: SharePoint Online
6+
title: New-SPOContainerType
7+
schema: 2.0.0
8+
author: ShreyasSar26
9+
ms.author: shsaravanan
10+
ms.reviewer:
11+
---
12+
13+
# New-SPOContainerType
14+
15+
## SYNOPSIS
16+
17+
This cmdlet creates a new container type of standard or trial status. The standard container type can be created with the regular billing structure or direct to customer billing structure.
18+
19+
## SYNTAX
20+
21+
### ParamSet1
22+
23+
```powershell
24+
New-SPOContainerType –ContainerTypeName <ContainerTypeName> -OwningApplicationId <OwningApplicationId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup> -Region <Region>
25+
```
26+
27+
### ParamSet2
28+
29+
```powershell
30+
New-SPOContainerType -ContainerTypeName <ContainerTypeName> -OwningApplicationId <OwningApplicationId> -IsPassThroughBilling
31+
```
32+
33+
### ParamSet3
34+
```powershell
35+
New-SPOContainerType –TrialContainerType -ContainerTypeName <ContainerTypeName> -OwningApplicationId <OwningApplicationId>
36+
```
37+
38+
## DESCRIPTION
39+
40+
This cmdlet creates a new container type of the standard or trial status. A trial container type does not have a billing profile associated with it and has a validity of 30 days. A standard container type has a billing profile associated with it. With the use of `-IsPassThroughBilling`, we can create a direct to customer billed container type.
41+
42+
You must be a SharePoint Embedded Administrator to run this cmdlet.
43+
44+
45+
## EXAMPLES
46+
47+
### Example 1
48+
49+
```powershell
50+
New-SPOContainerType -ContainerTypeName ContosoLegal -OwningApplicationId a735e4af-b86e-0000-93ba-1faded6c39e1 -AzureSubscriptionId 564e9025-f7f5-xxx9-9ddd-4cdxxxx1755 -ResourceGroup prod-resources -Region EastUS
51+
```
52+
In Example 1, the cmdlet creates a new container type 'ContosoLegal' that is standard billed and is attached to the billing profile mentioned.
53+
54+
### Example 2
55+
```powershell
56+
New-SPOContainerType –TrialContainerType - ContosoLegal -OwningApplicationId a735e4af-b86e-0000-93ba-1faded6c39e1
57+
```
58+
59+
In Example 2, the cmdlet creates a trial container type, 'ContosoLegal', valid for 30 days.
60+
61+
## PARAMETERS
62+
63+
### -ContainerTypeName
64+
65+
This parameter names your container type for your SharePoint Embedded application.
66+
67+
```yaml
68+
Type: String
69+
Parameter Sets: (All)
70+
Aliases:
71+
Applicable: SharePoint Online
72+
73+
Required: True
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -OwningApplicationId
81+
82+
This parameter specifies the ID of the SharePoint Embedded application.
83+
84+
```yaml
85+
Type: String
86+
Parameter Sets:
87+
Aliases:
88+
Applicable: SharePoint Online
89+
90+
Required: True
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -AzureSubscriptionId
98+
99+
This parameter describes the Azure subscription ID to which the container type needs to be associated.
100+
101+
```yaml
102+
Type: String
103+
Parameter Sets:
104+
Aliases:
105+
Applicable: SharePoint Online
106+
107+
Required: False
108+
Position: Named
109+
Default value: None
110+
Accept pipeline input: False
111+
Accept wildcard characters: False
112+
```
113+
114+
115+
### -ResourceGroup
116+
117+
This parameter describes the resource group to be used for the associated container type.
118+
119+
```yaml
120+
Type: String
121+
Parameter Sets:
122+
Aliases:
123+
Applicable: SharePoint Online
124+
125+
Required: False
126+
Position: Named
127+
Default value: None
128+
Accept pipeline input: False
129+
Accept wildcard characters: False
130+
```
131+
132+
### -Region
133+
134+
This parameter describes the region to which the billing profile of the container type is associated with.
135+
136+
```yaml
137+
Type: String
138+
Parameter Sets: ParamSet2, ParamSet3
139+
Aliases:
140+
Applicable: SharePoint Online
141+
142+
Required: False
143+
Position: Named
144+
Default value: None
145+
Accept pipeline input: False
146+
Accept wildcard characters: False
147+
```
148+
149+
### –TrialContainerType
150+
This parameter is used to specify that the cmdlet is used to create a trial container type and thereby the billing profile need not be provided.
151+
152+
```yaml
153+
Type: String
154+
Parameter Sets:
155+
Aliases:
156+
Applicable: SharePoint Online
157+
158+
Required: False
159+
Position: Named
160+
Default value: None
161+
Accept pipeline input: False
162+
Accept wildcard characters: False
163+
```
164+
165+
### –IsPassThroughBilling
166+
This parameter is used to create a direct to customer billed container type.
167+
168+
```yaml
169+
Type: String
170+
Parameter Sets:
171+
Aliases:
172+
Applicable: SharePoint Online
173+
174+
Required: False
175+
Position: Named
176+
Default value: None
177+
Accept pipeline input: False
178+
Accept wildcard characters: False
179+
```
180+
181+
182+
## RELATED LINKS
183+
184+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
185+
186+
[Get-SPOContainerType](./Get-SPOContainerType.md)
187+
188+
[Set-SPOContainerType](./Set-SPOContainerType.md)
189+
190+
[Remove-SPOContainerType](./Remove-SPOContainerType.md)

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

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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-spocontainertype
5+
applicable: SharePoint Online
6+
title: Remove-SPOContainerType
7+
schema: 2.0.0
8+
author: ShreyasSar26
9+
ms.author: shsaravanan
10+
ms.reviewer:
11+
---
12+
13+
# Remove-SPOContainerType
14+
15+
## SYNOPSIS
16+
This cmdlet removes the container type specified from the tenant.
17+
18+
## SYNTAX
19+
20+
### ParamSet1
21+
22+
```powershell
23+
Remove-SPOContainerType -ContainerTypeId <ContainerTypeId>
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet deletes only the trial container type in the tenant. To delete a container type in trial status, you must remove all containers of the container type first, including from the deleted container collection. To remove containers, refer to [Remove-SPOContainer](./Remove-SPOContainer.md). Once all the containers are deleted, trial container type can be deleted using this cmdlet.
29+
30+
You must be a SharePoint Embedded Administrator to run this cmdlet.
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
36+
```powershell
37+
Remove-SPOContainerTypeId -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604a8
38+
```
39+
In Example 1, the cmdlet asks for a confirmation on the remove action and on confirmation, deletes the trial container type.
40+
41+
Example 1 places the container with the given ID into the recycle bin. The container will be permanently deleted from the recycle bin after 93 days unless the deleted container is [restored](./Restore-SPODeletedContainer.md) before permanent deletion.
42+
43+
## PARAMETERS
44+
45+
### -ContainerTypeId
46+
47+
This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application. Use the `Get-SPOContainertype` command to retrieve the ID.
48+
49+
```yaml
50+
Type: String
51+
Parameter Sets: (All)
52+
Aliases:
53+
Applicable: SharePoint Online
54+
55+
Required: True
56+
Position: Named
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
## RELATED LINKS
62+
63+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
64+
65+
[New-SPOContainerType](./New-SPOContainerType.md)
66+
67+
[Set-SPOContainerType](./Set-SPOContainerType.md)
68+
69+
[Remove-SPOContainerType](./Get-SPOContainerType.md)
70+

0 commit comments

Comments
 (0)