Skip to content

Commit dde776c

Browse files
authored
Merge branch 'main' into patch-1
2 parents 8adaeeb + fffb560 commit dde776c

867 files changed

Lines changed: 1506 additions & 1186 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.openpublishing.redirection.spserver.json

Lines changed: 163 additions & 163 deletions
Large diffs are not rendered by default.

sharepoint/docfx.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
{"files": ["**/*.md"], "src": "sharepoint-ps/sharepoint-online", "version": "sharepoint-ps", "dest": "module/sharepoint-online"},
1111
{"files": ["**/*.md"], "src": "virtual-folder", "version": "sharepoint-ps", "dest": "module" },
1212

13-
{"files": ["**/toc.yml"], "src": "sharepoint-server-ps", "version": "sharepoint-server-ps", "exclude": ["docs-conceptual"], "dest": "module/sharepoint-ps"},
13+
{"files": ["**/toc.yml"], "src": "sharepoint-server-ps", "version": "sharepoint-server-ps", "exclude": ["docs-conceptual"], "dest": "module/sharepoint-server-ps"},
1414
{"files": ["**/*.yml"], "src": "sharepoint-server-ps", "version": "sharepoint-server-ps", "exclude": ["docs-conceptual"], "dest": "module"},
1515
{"files": ["**/*.md"], "src": "sharepoint-server-ps/sharepoint-server", "version": "sharepoint-server-ps", "dest": "module/sharepoint-server"},
1616
{"files": ["**/*.md"], "src": "virtual-folder", "version": "sharepoint-server-ps", "dest": "module" }

sharepoint/mapping/monikerMapping.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"sharepoint-server-ps": {
99
"conceptualToc": "docs-conceptual/toc.yml",
1010
"conceptualTocUrl": "/powershell/sharepoint/toc.json",
11-
"referenceTocUrl": "/powershell/module/sharepoint-ps/toc.json",
11+
"referenceTocUrl": "/powershell/module/sharepoint-server-ps/toc.json",
1212
"packageRoot": "sharepoint-server-ps"
1313
}
1414
}
Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spocontaineruser
5+
applicable: SharePoint Online
6+
title: Add-SPOContainerUser
7+
schema: 2.0.0
8+
author: ShreyasSar26
9+
ms.author: shsaravanan
10+
ms.reviewer:
11+
---
12+
13+
# Add-SPOContainerUser
14+
15+
## SYNOPSIS
16+
17+
Adds a user to a SharePoint Embedded container with a specified role.
18+
19+
## SYNTAX
20+
21+
```
22+
Add-SPOContainerUser [-ContainerId] <String> -LoginName <String> -Role <String> [<CommonParameters>]
23+
```
24+
25+
##DESCRIPTION
26+
27+
Assigns a user to a defined role within a SharePoint Embedded container.
28+
29+
You must be a SharePoint Embedded Administrator to run this cmdlet.
30+
31+
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).
32+
33+
> [!NOTE]
34+
> A user can be assigned to only one role within a container at a time.
35+
> **Owner** and **principal owner** are distinct. A container can have multiple owners, but only one principal owner at any time.
36+
> Principal ownership of a container can't be added—it can only be transferred.
37+
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
43+
```powershell
44+
Add-SPOContainerUser 423poi45 -LoginName shras@contoso.com-Role Owner
45+
```
46+
47+
Example 1 assigns the role of owner to user with User Principal Name "shras@contoso.com".
48+
49+
## PARAMETERS
50+
51+
-ContainerId
52+
53+
> Applicable: SharePoint Online
54+
55+
The unique identifier of the container to which the user is being added.
56+
57+
```yaml
58+
Type: String
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: True
63+
Position: 0
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
-LoginName
70+
71+
> Applicable: SharePoint Online
72+
73+
The user’s login name to assign to the container. This is the User Principal Name.
74+
75+
```yaml
76+
Type: String
77+
Parameter Sets: (All)
78+
Aliases:
79+
80+
Required: True
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
-Role
88+
89+
> Applicable: SharePoint Online
90+
91+
The role to assign to the user within the container. Valid roles are:
92+
93+
Owner: Has full control over the container and its contents.
94+
Manager: Can add, update, and delete content, and manage permissions, but can't delete the container.
95+
Writer: Can add, update, and delete content in the container.
96+
Reader: Can only view content in the container.
97+
98+
99+
```yaml
100+
Type: String
101+
Parameter Sets: (All)
102+
Aliases:
103+
Accepted values: Owner, Reader, Writer, Manager
104+
105+
Required: True
106+
Position: Named
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### CommonParameters
113+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
114+
115+
## INPUTS
116+
117+
### None
118+
119+
## OUTPUTS
120+
121+
### System.Object
122+
123+
## NOTES
124+
125+
## RELATED LINKS
126+
127+
[Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell)
128+
129+
[Set-SPOContainerUser](./Set-SPOContainerUser.md)
130+
131+
[Remove-SPOContainerUser](./Remove-SPOContainerUser.md)
132+
133+
[Set-SPOContainer](./Set-SPOContainer.md)
134+
135+
[Get-SPOContainer](./Get-SPOContainer.md)
136+
137+
138+
139+

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md

Lines changed: 55 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,36 @@ Returns one or more containers in a SharePoint Embedded application.
1818

1919
## SYNTAX
2020

21+
### All (Default)
22+
```
23+
Get-SPOContainer [-Identity <SPOContainerPipeBind>] [-Paged] [[-PagingToken] <String>]
24+
[[-SortByStorage] <SortOrder>] [[-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>]
25+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
26+
```
27+
2128
### OwningApplicationId
2229
```
23-
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [<CommonParameters>]
30+
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>]
31+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
2432
```
2533

34+
2635
### Sort
2736
```
2837
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [-SortByStorage] <SortOrder>
29-
[<CommonParameters>]
38+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
3039
```
3140

3241
### Archive
3342
```
3443
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>]
3544
[[-SortByStorage] <SortOrder>] [-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>
36-
[<CommonParameters>]
45+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
3746
```
3847

3948
### Identity
4049
```
41-
Get-SPOContainer -Identity <SPOContainerPipeBind> [<CommonParameters>]
50+
Get-SPOContainer -Identity <SPOContainerPipeBind> [-ProgressAction <ActionPreference>] [<CommonParameters>]
4251
```
4352

4453
## DESCRIPTION
@@ -50,73 +59,90 @@ You must be a SharePoint Embedded Administrator to run this cmdlet.
5059
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).
5160

5261
> [!NOTE]
53-
> Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet.
54-
> The OwningApplicationId for Microsoft Loop is `a187e399-0c36-4b98-8f04-1edc167a0996`.
55-
> The OwningApplicationId for Microsoft Designer is `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`.
62+
> You can't retrieve containers in the Recycle Bin using this cmdlet.
63+
>
64+
> Use the following `OwningApplicationId` values to identify specific Microsoft applications:
65+
66+
67+
| Application | OwningApplicationId |
68+
|----------|----------|
69+
| **Microsoft Declarative Agent** | `3fbee041-e7d6-4f14-8826-6bf27f0a2849` |
70+
| **Microsoft Designer** | `5e2795e3-ce8c-4cfb-b302-35fe5cd01597` |
71+
| **Microsoft Loop** | `a187e399-0c36-4b98-8f04-1edc167a0996` |
72+
| **Microsoft Outlook Newsletters** | `a6804318-a92d-4f36-b499-441033991274`|
73+
| **Microsoft Teams Events Video on Demand** | `f574b137-eb91-46a0-8811-1a04d80c7ffa`|
74+
5675

5776
## EXAMPLES
5877

5978
### Example 1
6079

80+
```powershell
81+
Get-SPOContainer
82+
```
83+
Example 1 returns the details of all the containers in the tenant.
84+
85+
### Example 2
86+
6187
```powershell
6288
Get-SPOContainer -Identity b66f5b2e
6389
```
6490

65-
Example 1 returns the detailed properties of the Container with associated Container ID b66f5b2e.
91+
Example 2 returns the detailed properties of the Container with associated Container ID b66f5b2e.
6692

67-
### Example 2
93+
### Example 3
6894

6995
```powershell
7096
Get-SPOContainer -OwningApplicationId 423poi45 | ft
7197
```
72-
Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`.
98+
Example 3 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`.
7399

74-
### Example 3
100+
### Example 4
75101

76102
```powershell
77103
Get-SPOContainer -OwningApplicationId 423poi45 -Paged | ft
78104
```
79-
Example 3 uses the `-Paged` command to retrieve a paging token.
105+
Example 4 uses the `-Paged` command to retrieve a paging token.
80106

81-
### Example 4
107+
### Example 5
82108

83109
```powershell
84110
Get-SPOContainer -OwningApplicationId 423poi45 -Paged -PagingToken <zacad> | ft
85111
```
86112

87-
Example 4 uses the `-PagingToken` parameter along with the `-Paged` parameter to view more containers that were not displayed in Example 3.
113+
Example 5 uses the `-PagingToken` parameter along with the `-Paged` parameter to view more containers that were not displayed in Example 3.
88114

89-
### Example 5
115+
### Example 6
90116

91117
```powershell
92118
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending
93119
```
94120

95-
Example 5 displays the containers belonging to the application, sorted in ascending order of storage.
121+
Example 6 displays the containers belonging to the application, sorted in ascending order of storage.
96122

97-
### Example 6
123+
### Example 7
98124

99125
```powershell
100126
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending -Paged
101127
```
102128

103-
Example 6 displays a paged view of the the containers belonging to the application, sorted in ascending order of storage.
129+
Example 7 displays a paged view of the containers belonging to the application, sorted in ascending order of storage.
104130

105-
### Example 7
131+
### Example 8
106132

107133
```powershell
108134
Get-SPOContainer -OwningApplicationId 423poi45-as -SortByStorage Ascending -Paged -PagingToken <zacad>
109135
```
110136

111-
Example 7 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
137+
Example 8 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
112138

113-
### Example 8
139+
### Example 9
114140

115141
```powershell
116142
Get-SPOContainer -OwningApplicationId 423poi45 -ArchiveStatus RecentlyArchived | ft
117143
```
118144

119-
Example 8 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
145+
Example 9 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
120146

121147
## PARAMETERS
122148

@@ -130,7 +156,7 @@ The ArchiveStatus parameter is used to display containers in various stages of a
130156
- RecentlyArchived – Displays containers in the "Recently archived" state.
131157
- FullyArchived – Displays containers in the "Fully archived" state.
132158
- Reactivating – Displays containers in the "Reactivating" state.
133-
- NotArchived – Displays active containers
159+
- NotArchived – Displays active containers.
134160

135161
```yaml
136162
Type: Microsoft.Online.SharePoint.TenantAdministration.SPContainerArchiveStatusFilterProperties
@@ -203,7 +229,7 @@ Accept wildcard characters: False
203229

204230
> Applicable: SharePoint Online
205231

206-
Use this parameter to provide the paging token 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. For displaying the next set of archived containers, `-ArchiveStatus` paramter needs to be used along with this parameter.
232+
Use this parameter to provide the paging token 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. For displaying the next set of archived containers, `-ArchiveStatus` parameter needs to be used along with this parameter.
207233

208234
```yaml
209235
Type: System.String
@@ -219,6 +245,8 @@ Accept wildcard characters: False
219245

220246
### -SortByStorage
221247

248+
> Applicable: SharePoint Online
249+
222250
This parameter can be used when you need to see the list of containers, sorted by storage.
223251

224252
```yaml
@@ -235,6 +263,9 @@ Accept wildcard characters: False
235263
```
236264

237265
### CommonParameters
266+
267+
> Applicable: SharePoint Online
268+
238269
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
239270

240271
## INPUTS

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ The following cmdlet references are for SharePoint Online.
1818
### [Add-SPOContainerTypeBilling](Add-SPOContainerTypeBilling.md)
1919
Adds the mentioned billing profile details to a standard container type.
2020

21+
### [Add-SPOContainerUser](Add-SPOContainerUser.md)
22+
Adds a user to a SharePoint Embedded container with a specified role.
23+
2124
### [Add-SPOContentSecurityPolicy](Add-SPOContentSecurityPolicy.md)
2225
Adds a source to the **Content Security Policy** configuration.
2326

@@ -481,14 +484,17 @@ Cmdlet to register customer encryption status for your geo tenant. For more info
481484
Enables the hub site feature on a site to make it a hub site. For more information visit [SharePoint hub sites overview](/sharepoint/dev/features/hub-site/hub-site-overview).
482485

483486
### [Remove-SPOAppBillingPolicy](Remove-SPOAppBillingPolicy.md)
484-
Removes billing policy asscoiated with the application.
487+
Removes billing policy associated with the application.
485488

486489
### [Remove-SPOContainer](Remove-SPOContainer.md)
487490
Sends a Container to the Recycle Bin.
488491

489492
### [Remove-SPOContainerType](Remove-SPOContainerType.md)
490493
This cmdlet removes the container type specified from the tenant.
491494

495+
### [Remove-SPOContainerUser](Remove-SPOContainerUser.md)
496+
This cmdlet removes the container type specified from the tenant.
497+
492498
### [Remove-SPOContentEventEmailAddresses](Remove-SPOContentEventEmailAddresses.md)
493499
Removes the email addresses associated with the specified category of content event if they exist. Consequently, notification emails will no longer be sent to these addresses.
494500

@@ -666,6 +672,9 @@ Sets or updates one or more property values of a trial, standard or a direct to
666672
### [Set-SPOContainerTypeConfiguration](Set-SPOContainerTypeConfiguration.md)
667673
Sets or updates the configuration settings of a container type in SharePoint Embedded.
668674

675+
### [Set-SPOContainerUser](Set-SPOContainerUser.md)
676+
Reassigns a user from their current role to a new role within a SharePoint Embedded container.
677+
669678
### [Set-SPOContentEventEmailAddresses](Set-SPOContentEventEmailAddresses.md)
670679
Adds the email addresses to the specified category of content event. Consequently, notification emails will be sent to these addresses.
671680

0 commit comments

Comments
 (0)