Skip to content

Commit 62c7567

Browse files
Merge pull request #883 from ShreyasSar26/patch-PS
Changes as part of Copilot Embedded Chat host changes
2 parents fb6e3a1 + 03b06c6 commit 62c7567

File tree

3 files changed

+149
-8
lines changed

3 files changed

+149
-8
lines changed

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ ms.reviewer:
1414

1515
## SYNOPSIS
1616

17-
Returns container type configurations in a SharePoint Embedded application.
17+
Use this cmdlet to read the configuration values set on the container type.
1818

1919
## SYNTAX
2020

2121
### ParamSet1
2222

2323
```powershell
24-
Get-SPOContainerTypeConfiguration [-ContainerTypeId <ContainerTypeId>]
24+
Get-SPOContainerTypeConfiguration -ContainerTypeId <Guid> [<CommonParameters>]
2525
```
2626

2727
## DESCRIPTION
2828

29-
The `Get-SPOContainerTypeConfiguration` cmdlet retrieves and returns configuration settings set on a container type created under a SharePoint Embedded application.
29+
The `Get-SPOContainerTypeConfiguration` cmdlet retrieves and returns configuration settings set on a container type created under a SharePoint Embedded application. This can either be the default value or the previously set value on the container type.
3030

31-
You must be a SharePoint Administrator or Global Administrator to run this cmdlet.
31+
You must be a SharePoint Embedded Administrator to run this cmdlet.
3232

3333
## EXAMPLES
3434

@@ -58,6 +58,10 @@ Default value: None
5858
Accept pipeline input: False
5959
Accept wildcard characters: False
6060
```
61+
### CommonParameters
62+
63+
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).
64+
6165

6266
## RELATED LINKS
6367

sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ This example sets the host URLs for the application with Id 423poi45.
8383

8484
### -CopilotEmbeddedChatHosts
8585

86-
This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience.
86+
This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience. This will always be a subset of permissible URLs set by the application's developer. To check the list of permissible URLs, use the `Get-SPOApplication` cmdlet.
8787

8888
```yaml
8989
Type: System.Collections.Generic.List`1[System.String]

sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainerTypeConfiguration.md

Lines changed: 140 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ online version: https://learn.microsoft.com/powershell/module/sharepoint-online/
55
applicable: SharePoint Online
66
title: Set-SPOContainerTypeConfiguration
77
schema: 2.0.0
8-
author: FarreltinF
9-
ms.author: fanyi
8+
author: ShreyasSar26
9+
ms.author: shsaravanan
1010
ms.reviewer:
1111
---
1212

@@ -22,13 +22,15 @@ Set-SPOContainerTypeConfiguration -ContainerTypeId <Guid> [-DiscoverabilityDisab
2222
[-SharingRestricted <Boolean>] [-ApplicationRedirectUrl <String>] [-WhoCanShareAnonymousAllowList <Guid[]>]
2323
[-WhoCanShareAuthenticatedGuestAllowList <Guid[]>] [-OverrideTenantWhoCanShareAnonymousAllowList <Boolean>]
2424
[-OverrideTenantWhoCanShareAuthenticatedGuestAllowList <Boolean>]
25+
[[-CopilotEmbeddedChatHosts] <System.Collections.Generic.List`1[System.String]>] [-WhatIf] [-Confirm]
26+
[<CommonParameters>]
2527
```
2628

2729
## DESCRIPTION
2830

2931
For any parameters passed in, the `Set-SPOContainerTypeConfiguration` cmdlet sets or updates the settings for a container type created under a SharePoint Embedded application.
3032

31-
You must be a SharePoint Administrator or Global Administrator to run this cmdlet.
33+
You must be a SharePoint Embedded Administrator to run this cmdlet.
3234

3335
## EXAMPLES
3436

@@ -72,6 +74,13 @@ Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb
7274

7375
Example 5 overrides the tenant-level `WhoCanShareAuthenticatedGuestAllowList` with a null value, while leaving the `WhoCanShareAnonymousAllowList` untouched. This has the effect of no longer restricting the privilege of sharing to authenticated guests to members of specific security groups.
7476

77+
### Example 6
78+
79+
```powershell
80+
Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585 -CopilotEmbeddedChatHosts "http://localhost:3000 https://contoso.sharepoint.com https://fabrikam.com"
81+
```
82+
This example sets the host URLs for the container type with Id 4f0af585.
83+
7584
## PARAMETERS
7685

7786
### -DiscoverabilityDisabled
@@ -106,6 +115,131 @@ Default value: True
106115
Accept pipeline input: False
107116
Accept wildcard characters: False
108117
```
118+
### -ApplicationRedirectUrl
119+
120+
This parameter specifies the url of that the application should be redirected to.
121+
122+
```yaml
123+
Type: String
124+
Parameter Sets: (All)
125+
Aliases:
126+
127+
Required: False
128+
Position: Named
129+
Default value: None
130+
Accept pipeline input: False
131+
Accept wildcard characters: False
132+
```
133+
134+
### -ContainerTypeId
135+
136+
This parameter specifies the ID of the container type corresponding to the SharePoint Embedded application.
137+
138+
```yaml
139+
Type: Guid
140+
Parameter Sets: (All)
141+
Aliases:
142+
143+
Required: True
144+
Position: Named
145+
Default value: None
146+
Accept pipeline input: False
147+
Accept wildcard characters: False
148+
```
149+
### -CopilotEmbeddedChatHosts
150+
This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience.
151+
152+
```yaml
153+
Type: System.Collections.Generic.List`1[System.String]
154+
Parameter Sets: (All)
155+
Aliases:
156+
157+
Required: False
158+
Position: 3
159+
Default value: None
160+
Accept pipeline input: False
161+
Accept wildcard characters: False
162+
```
163+
164+
### -OverrideTenantWhoCanShareAnonymousAllowList
165+
166+
This setting determines if the container type `WhoCanShareAnonymousAllowList` overrides the tenant-level `WhoCanShareAnonymousAllowList`. The default value for this parameter is false.
167+
168+
PARAMVALUE: True | False
169+
170+
```yaml
171+
Type: Boolean
172+
Parameter Sets: (All)
173+
Aliases:
174+
175+
Required: False
176+
Position: Named
177+
Default value: None
178+
Accept pipeline input: False
179+
Accept wildcard characters: False
180+
```
181+
182+
### -OverrideTenantWhoCanShareAuthenticatedGuestAllowList
183+
184+
This setting determines if the container type `WhoCanShareAuthenticatedGuestAllowList` overrides the tenant-level `WhoCanShareAuthenticatedGuestAllowList`. The default value for this parameter is false.
185+
186+
PARAMVALUE: True | False
187+
188+
```yaml
189+
Type: Boolean
190+
Parameter Sets: (All)
191+
Aliases:
192+
193+
Required: False
194+
Position: Named
195+
Default value: None
196+
Accept pipeline input: False
197+
Accept wildcard characters: False
198+
```
199+
200+
### -WhoCanShareAnonymousAllowList
201+
202+
Sets a container type-specific list of security groups who are allowed to share with anonymous (non-authenticated) users as well as authenticated guest users. This must be set in conjunction with `OverrideTenantWhoCanShareAnonymousAllowList`.
203+
204+
> [!NOTE]
205+
> This allow list only accepts security groups, and not Microsoft 365 Groups.
206+
207+
Each security group is denoted by its GUID object ID. To set this list to be a specific security group, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them. To skip the check and allow all security groups to share to anyone, set this allow list and the `WhoCanShareAuthenticatedGuestAllowList` to null arrays.
208+
209+
```yaml
210+
Type: Guid[]
211+
Parameter Sets: (All)
212+
Aliases:
213+
214+
Required: False
215+
Position: Named
216+
Default value: None
217+
Accept pipeline input: False
218+
Accept wildcard characters: False
219+
```
220+
221+
### -WhoCanShareAuthenticatedGuestAllowList
222+
223+
Sets a container type-specific list of security groups who are allowed to share with authenticated guest users at the container level. This must be set in conjunction with `OverrideTenantWhoCanShareAuthenticatedGuestAllowList`.
224+
225+
> [!NOTE]
226+
> This allow list only accepts security groups, and not Microsoft 365 Groups.
227+
228+
Each security group is denoted by its GUID object ID. To set this list to be a specific security group, you need to enter its GUID as the parameter. You can enter multiple GUIDs by using a comma to separate them. To skip the check and allow all security groups to share to authenticated guests, set this allow list to a null array.
229+
230+
231+
```yaml
232+
Type: Guid[]
233+
Parameter Sets: (All)
234+
Aliases:
235+
236+
Required: False
237+
Position: Named
238+
Default value: None
239+
Accept pipeline input: False
240+
Accept wildcard characters: False
241+
```
242+
109243

110244
### -WhoCanShareAnonymousAllowList
111245

@@ -183,6 +317,9 @@ Accept pipeline input: False
183317
Accept wildcard characters: False
184318
```
185319

320+
### CommonParameters
321+
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).
322+
186323
## RELATED LINKS
187324

188325
[Get-SPOContainerTypeConfiguration](Get-SPOContainerTypeConfiguration.md)

0 commit comments

Comments
 (0)