Skip to content

Commit d3ec517

Browse files
Merge branch 'main' into docs-editor/Get-SPOCopilotAgentInsightsRep-1738242299
2 parents d047d06 + 49f8ab5 commit d3ec517

File tree

7 files changed

+260
-101
lines changed

7 files changed

+260
-101
lines changed
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
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-spocontainertypebilling
5+
applicable: SharePoint Online
6+
title: Add-SPOContainerTypeBilling
7+
schema: 2.0.0
8+
author: ShreyasSar26
9+
ms.author: shsaravanan
10+
ms.reviewer:
11+
---
12+
13+
# Add-SPOContainerTypeBilling
14+
15+
## SYNOPSIS
16+
17+
Adds the mentioned billing profile details to a standard container type.
18+
19+
## SYNTAX
20+
21+
### ParamSet1
22+
23+
```powershell
24+
Add-SPOContainerTypeBilling –ContainerTypeId <ContainerTypeId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup> -Region <Region>
25+
```
26+
27+
28+
## DESCRIPTION
29+
30+
This cmdlet attaches the Azure subscription ID, resource group and region with the container type ID provided.
31+
32+
You must be a SharePoint Embedded Administrator to run this cmdlet. You also need to have owner or contributor permissions on an Azure subscription, with active time bound permission on billing, and on the Resource group.
33+
34+
If you don't have an Azure subscription, follow steps here to [create a subscription](/azure/cloud-adoption-framework/ready/azure-best-practices/initial-subscriptions).
35+
36+
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).
37+
38+
## EXAMPLES
39+
40+
### Example 1
41+
42+
```powershell
43+
Add-SPOContainerTypeBilling - ContainerTypeId aa1d89b3 -AzureSubscriptionId 5a8a4d9f -ResourceGroup "RG100" -Region "(US) East US"
44+
```
45+
46+
Example 1 attaches the billing profile of Azure subscription ID "5a8a4d9f", resource group "RG100" and region "(US) East US" to the container type ID "aa1d89b3".
47+
48+
49+
## PARAMETERS
50+
51+
### -ContainerTypeId
52+
53+
This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application.
54+
```yaml
55+
Type: String
56+
Parameter Sets: (All)
57+
Aliases:
58+
Applicable: SharePoint Online
59+
60+
Required: True
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -AzureSubscriptionId
68+
69+
This parameter describes the Azure subscription ID to which the container type needs to be associated.
70+
71+
```yaml
72+
Type: String
73+
Parameter Sets:
74+
Aliases:
75+
Applicable: SharePoint Online
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
85+
### -ResourceGroup
86+
87+
This parameter describes the resource group to be used for the associated container type.
88+
89+
```yaml
90+
Type: String
91+
Parameter Sets:
92+
Aliases:
93+
Applicable: SharePoint Online
94+
95+
Required: False
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -Region
103+
104+
This parameter describes the region to which the billing profile of the container type is associated with.
105+
106+
```yaml
107+
Type: String
108+
Parameter Sets: ParamSet2, ParamSet3
109+
Aliases:
110+
Applicable: SharePoint Online
111+
112+
Required: False
113+
Position: Named
114+
Default value: None
115+
Accept pipeline input: False
116+
Accept wildcard characters: False
117+
```
118+
119+
## RELATED LINKS
120+
121+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
122+
123+
[New-SPOContainerType](./New-SPOContainerType.md)
124+
125+
[Get-SPOContainerType](./Get-SPOContainerType.md)
126+
127+
[Set-SPOContainerType](./Set-SPOContainerType.md)
128+
129+
[Remove-SPOContainerType](./Remove-SPOContainerType.md)

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainer.md

Lines changed: 80 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,52 +5,66 @@ online version: https://learn.microsoft.com/powershell/module/sharepoint-online/
55
applicable: SharePoint Online
66
title: Get-SPOContainer
77
schema: 2.0.0
8-
author: cindylay
9-
ms.author: cindylay
8+
author: ShreyasSar26
9+
ms.author: shsaravanan
1010
ms.reviewer:
1111
---
1212

1313
# Get-SPOContainer
1414

1515
## SYNOPSIS
1616

17-
Returns one or more Containers in a SharePoint Embedded application.
17+
Returns one or more containers in a SharePoint Embedded application.
1818

1919
## SYNTAX
2020

2121
### ParamSet1
2222

2323
```powershell
24-
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [<CommonParameters>]
24+
Get-SPOContainer -Identity <ContainerId> [<CommonParameters>]
2525
```
2626

2727
### ParamSet2
28+
2829
```powershell
29-
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [-Paged]
30+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [<CommonParameters>]
3031
```
3132

3233
### ParamSet3
3334
```powershell
34-
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [-Paged] [-PagingToken <Token String>]
35+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [<CommonParameters>]
3536
```
3637

3738
### ParamSet4
38-
3939
```powershell
40-
Get-SPOContainer [[-Identity] <ContainerId>]
40+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
4141
```
4242

4343
### ParamSet5
4444

4545
```powershell
46-
Get-SPOContainer [[-Identity] <ContainerSiteURL>]
46+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [<CommonParameters>]
47+
```
48+
49+
### ParamSet6
50+
51+
```powershell
52+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [<CommonParameters>]
53+
```
54+
### ParamSet7
55+
56+
```powershell
57+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
4758
```
4859

4960
## DESCRIPTION
5061

51-
The `Get-SPOContainer` cmdlet retrieves and returns a list of Containers and details of an individual Container created under a SharePoint Embedded application. This command is available only in SharePoint Online Management Shell version 16.0.24211.12000 or higher to run this cmdlet.
62+
The `Get-SPOContainer` cmdlet retrieves and returns the details of an individual container when paired with `Identity` parameter, where the container ID needs to be mentioned. The cmdlet returns the list of containers belonging to a SharePoint Embedded application when paired with the `OwningApplicationId` parameter.
63+
64+
You must be a SharePoint Embedded Administrator to run this cmdlet.
65+
66+
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).
5267

53-
You must be a SharePoint Online Administrator to run this cmdlet.
5468

5569
> [!NOTE]
5670
> Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet.
@@ -62,47 +76,58 @@ You must be a SharePoint Online Administrator to run this cmdlet.
6276
### Example 1
6377

6478
```powershell
65-
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 | FT
79+
Get-SPOContainer -Identity b66f5b2e
6680
```
6781

68-
Example 1 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45-jikl-9bnm-b302-1234ghy56789`.
69-
70-
To retrieve Containers for the Microsoft Loop app, use OwningApplicationId: `a187e399-0c36-4b98-8f04-1edc167a0996`.
71-
72-
To retrieve Containers for the Microsoft Designer app, use OwningApplicationId: `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`.
82+
Example 1 returns the detailed properties of the Container with associated Container ID b66f5b2e.
7383

7484
### Example 2
7585

7686
```powershell
77-
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Identity b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
87+
Get-SPOContainer -OwningApplicationId 423poi45 | ft
7888
```
79-
80-
Example 2 returns the detailed properties of the Container with associated `ContainerId`.
89+
Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`.
8190

8291

8392
### Example 3
8493

8594
```powershell
86-
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Identity https://contoso.sharepoint.com/storagecontainers/CSP_b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
95+
Get-SPOContainer -OwningApplicationId 423poi45 -Paged | ft
8796
```
88-
89-
Example 3 gives the detailed properties of a Container using the site URL of a Container.
97+
Example 3 uses the `-Paged` command to retrieve a paging token.
9098

9199
### Example 4
92100

93101
```powershell
94-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Identity <ContainerId> -Paged | FT
102+
Get-SPOContainer -OwningApplicationId 423poi45 -Paged -PagingToken <zacad> | ft
95103
```
96104

97-
Example 4 uses the `-Paged` command to retrieve a paging token.
105+
Example 4 uses the `-PagingToken` parameter along with the `-Paged` parameter to view more containers that were not displayed in Example 3.
98106

99107
### Example 5
100108

101109
```powershell
102-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Identity <ContainerId> -Paged -PagingToken <Token String> | FT
110+
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending
111+
```
112+
113+
Example 5 displays the containers belonging to the application, sorted in ascending order of storage.
114+
115+
### Example 6
116+
117+
```powershell
118+
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending -Paged
119+
```
120+
121+
Example 6 displays a paged view of the the containers belonging to the application, sorted in ascending order of storage.
122+
123+
### Example 7
124+
125+
```powershell
126+
Get-SPOContainer -OwningApplicationId 423poi45-as -SortByStorage Ascending -Paged -PagingToken <zacad>
103127
```
104128

105-
Example 5 uses the `PagingToken` to view more Containers.
129+
Example 7 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
130+
106131

107132
## PARAMETERS
108133

@@ -125,7 +150,7 @@ Accept wildcard characters: False
125150
126151
### -Identity
127152
128-
Use this parameter to specify the Container in the given OwningApplicationId.
153+
Use this parameter to specify the Container ID.
129154
130155
```yaml
131156
Type: String
@@ -142,7 +167,7 @@ Accept wildcard characters: False
142167
143168
### -Paged
144169
145-
This parameter can be used when there are more than 200 Containers in a given SharePoint repository services application. Using `-Paged` will provide a `<Paging Token>` that will display the next 200 Containers.
170+
This parameter can be used when there are more than 200 Containers in a given SharePoint Embedded application. Using `-Paged` will provide a paging token that will display the next 200 Containers.
146171

147172
```yaml
148173
Type: String
@@ -160,7 +185,7 @@ Accept wildcard characters: False
160185

161186
### -PagingToken
162187

163-
Use this parameter to provide the `<Paging Token>` provided to view the remaining Containers as shown in Example 5. If there are no more Containers to display, the commandlet output will return the message `End of Containers view.` Otherwise, use the given `<Paging Token>` to retrieve the next batch of up to 200 Containers.
188+
Use this parameter to provide the paging token provided to view the remaining Containers as shown in Example 4. If there are no more Containers to display, the cmdlet output will return the message `End of containers view.` Otherwise, use the given paging token to retrieve the next batch of up to 200 Containers.
164189

165190
```yaml
166191
Type: String
@@ -175,13 +200,34 @@ Accept pipeline input: False
175200
Accept wildcard characters: False
176201
```
177202

178-
### CommonParameters
203+
### -SortByStorage
179204

180-
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).
205+
This parameter can be used when you need to see the list of containers, sorted by storage.
181206

182-
## NOTES
207+
```yaml
208+
Type: String
209+
Applicable: SharePoint Online
183210
211+
Required: False
212+
Position: Named
213+
Default value: None
214+
Accept pipeline input: False
215+
Accept wildcard characters: False
216+
```
184217
## RELATED LINKS
185218

186-
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps)
219+
[Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell)
220+
221+
[Get-SPOApplication](./Get-SPOApplication.md)
222+
223+
[Set-SPOContainer](./Set-SPOContainer.md)
224+
225+
[Get-SPODeletedContainer](./Get-SPODeletedContainer.md)
226+
227+
[Remove-SPOContainer](./Remove-SPOContainer.md)
228+
229+
[Remove-SPODeletedContainer](./Remove-SPODeletedContainer.md)
230+
231+
[Restore-SPODeletedContainer](./Restore-SPODeletedContainer.md)
232+
187233

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,21 @@ Returns one or more container types created in the tenant.
2121
### ParamSet1
2222

2323
```powershell
24-
Get-SPOContainerType
24+
Get-SPOContainerType [<CommonParameters>]
2525
```
2626
### ParamSet2
2727
```powershell
28-
Get-SPOContainerType [-ContainerTypeId <ContainerTypeId>]
28+
Get-SPOContainerType -ContainerTypeId <ContainerTypeId> [<CommonParameters>]
2929
```
3030

3131
## DESCRIPTION
3232

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.
33+
This cmdlet returns all the container types present in the tenant or details of a specific container type when paired with the `ContainerTypeId` parameter.
3434

3535
You must be a SharePoint Embedded Administrator to run the cmdlet.
3636

37+
While the basic information of container types is displayed to all administrators running this cmdlet, the billing information about a container type is only visible to administrators who also have owner or contributor access on the billing subscription attached to the container type.
38+
3739
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).
3840

3941
## EXAMPLES
@@ -49,9 +51,9 @@ Example 1 retrieves all the container types present in the tenant and displays c
4951
### Example 2
5052

5153
```powershell
52-
Get-SPOContainerType -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4
54+
Get-SPOContainerType -ContainerTypeId 4f0af585
5355
```
54-
Example 2 returns the detailed properties of container type 4f0af585-8dcc-0000-223d-661eb2c604e4
56+
Example 2 returns the detailed properties of container type 4f0af585.
5557

5658
## PARAMETERS
5759

0 commit comments

Comments
 (0)