Skip to content

Commit 58b3dfa

Browse files
committed
Update New-CsExternalAccessPolicy.md
Formatting and rearragement
1 parent dc7234b commit 58b3dfa

File tree

1 file changed

+119
-98
lines changed

1 file changed

+119
-98
lines changed

teams/teams-ps/teams/New-CsExternalAccessPolicy.md

Lines changed: 119 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,26 @@ For information about external access in Microsoft Teams, see [Manage external a
2424
## SYNTAX
2525

2626
```powershell
27-
New-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-CommunicationWithExternalOrgs <Boolean>] [-AllowedExternalDomains <List>] [-BlockedExternalDomains <List>] [-EnableAcsFederationAccess <Boolean>]
28-
[-EnableXmppAccess <Boolean>] [-EnablePublicCloudAccess <Boolean>]
29-
[-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableTeamsConsumerAccess <Boolean>] [-EnableTeamsConsumerInbound <Boolean>] [-EnableOutsideAccess <Boolean>] [-FederatedBilateralChats <Boolean>] [-Identity] <XdsIdentity>
30-
[-InMemory] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
31-
27+
New-CsExternalAccessPolicy [-Identity] <XdsIdentity>
28+
[-AllowedExternalDomains <List>]
29+
[-BlockedExternalDomains <List>]
30+
[-CommunicationWithExternalOrgs <Boolean>]
31+
[-Confirm]
32+
[-Description <String>]
33+
[-EnableAcsFederationAccess <Boolean>]
34+
[-EnableFederationAccess <Boolean>]
35+
[-EnableOutsideAccess <Boolean>]
36+
[-EnablePublicCloudAccess <Boolean>]
37+
[-EnablePublicCloudAudioVideoAccess <Boolean>]
38+
[-EnableTeamsConsumerAccess <Boolean>]
39+
[-EnableTeamsConsumerInbound <Boolean>]
40+
[-EnableXmppAccess <Boolean>]
41+
[-FederatedBilateralChats <Boolean>]
42+
[-Force]
43+
[-InMemory]
44+
[-Tenant <Guid>]
45+
[-WhatIf]
46+
[<CommonParameters>]
3247
```
3348

3449
## DESCRIPTION
@@ -124,15 +139,17 @@ In this example, we create an ExternalAccessPolicy named "GranularFederationExam
124139
## PARAMETERS
125140

126141
### -Identity
127-
Unique Identity to be assigned to the policy.
128-
New external access policies can be created at the site or per-user scope.
142+
Unique Identity to be assigned to the policy. New external access policies can be created at the site or per-user scope.
143+
129144
To create a new site policy, use the prefix "site:" and the name of the site as your Identity.
145+
130146
For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.`
147+
131148
To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.`
132149

133150
Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead.
134-
Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists.
135-
If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet.
151+
152+
Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet.
136153

137154
```yaml
138155
Type: XdsIdentity
@@ -146,61 +163,45 @@ Accept pipeline input: False
146163
Accept wildcard characters: False
147164
```
148165
149-
### -Description
150-
Enables administrators to provide explanatory text to accompany the policy.
151-
For example, the Description might include information about the users the policy should be assigned to.
166+
### -AllowedExternalDomains
167+
Indicates the domains that are allowed to communicate with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `AllowSpecificExternalDomains`.
152168

153169
```yaml
154-
Type: String
170+
Type: List
155171
Parameter Sets: (All)
156172
Aliases:
157-
173+
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
158174
Required: False
159175
Position: Named
160176
Default value: None
161177
Accept pipeline input: False
162178
Accept wildcard characters: False
163179
```
164180

165-
### -EnableFederationAccess
166-
Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization.
167-
Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams.
168-
The default value is True.
169-
170-
```yaml
171-
Type: Boolean
172-
Parameter Sets: (All)
173-
Aliases:
174-
175-
Required: False
176-
Position: Named
177-
Default value: True
178-
Accept pipeline input: False
179-
Accept wildcard characters: False
180-
```
181-
182-
### -FederatedBilateralChats
183-
This setting enables bi-lateral chats for the users included in the messaging policy.
181+
### -BlockedExternalDomains
182+
Indicates the domains that are blocked from communicating with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `BlockSpecificExternalDomains`.
184183

185184
```yaml
186-
Type: Boolean
185+
Type: List
187186
Parameter Sets: (All)
188187
Aliases:
189-
188+
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
190189
Required: False
191190
Position: Named
192-
Default value: True
191+
Default value: None
193192
Accept pipeline input: False
194193
Accept wildcard characters: False
195194
```
196195

197196
### -CommunicationWithExternalOrgs
198197
Indicates how the users get assigned by this policy can communicate with the external orgs. There are 5 options:
199-
* OrganizationDefault: the users of this policy will follow the federation settings defined in TenantFederationConfiguration
200-
* AllowAllExternalDomains: the users are open to communicate with all domains
201-
* AllowSpecificExternalDomains: the users can only communicate with the users of the domains defined in `AllowedExternalDomains`
202-
* BlockSpecificExternalDomains: only users from the domains defined in `BlockedExternalDomains` are blocked from communicating with the users of this policy
203-
* BlockAllExternalDomains: the users are not able to communicate with any external domains
198+
199+
- OrganizationDefault: the users of this policy will follow the federation settings defined in TenantFederationConfiguration
200+
- AllowAllExternalDomains: the users are open to communicate with all domains
201+
- AllowSpecificExternalDomains: the users can only communicate with the users of the domains defined in `AllowedExternalDomains`
202+
- BlockSpecificExternalDomains: only users from the domains defined in `BlockedExternalDomains` are blocked from communicating with the users of this policy
203+
- BlockAllExternalDomains: the users are not able to communicate with any external domains
204+
204205
```yaml
205206
Type: String
206207
Parameter Sets: (All)
@@ -213,84 +214,66 @@ Accept pipeline input: False
213214
Accept wildcard characters: False
214215
```
215216

216-
### -AllowedExternalDomains
217-
Indicates the domains that are allowed to communicate with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `AllowSpecificExternalDomains`
217+
### -Confirm
218+
Prompts you for confirmation before executing the command.
219+
218220
```yaml
219-
Type: List
221+
Type: SwitchParameter
220222
Parameter Sets: (All)
221-
Aliases:
222-
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
223+
Aliases: cf
224+
223225
Required: False
224226
Position: Named
225227
Default value: None
226228
Accept pipeline input: False
227229
Accept wildcard characters: False
228230
```
229231

230-
### -BlockedExternalDomains
231-
Indicates the domains that are blocked from communicating with the users of this policy. This is referenced only when `CommunicationWithExternalOrgs` is set to be `BlockSpecificExternalDomains`
232+
### -Description
233+
Enables administrators to provide explanatory text to accompany the policy.
234+
For example, the Description might include information about the users the policy should be assigned to.
235+
232236
```yaml
233-
Type: List
237+
Type: String
234238
Parameter Sets: (All)
235239
Aliases:
236-
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
240+
237241
Required: False
238242
Position: Named
239243
Default value: None
240244
Accept pipeline input: False
241245
Accept wildcard characters: False
242246
```
243247

244-
### -EnableTeamsConsumerAccess
245-
(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization.
248+
### -EnableAcsFederationAccess
249+
Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation.
246250

247-
To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled.
251+
To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled.
248252

249-
Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams.
250-
The default value is True.
253+
To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled.
251254

252255
```yaml
253256
Type: Boolean
254257
Parameter Sets: (All)
255258
Aliases:
259+
Applicable: Microsoft Teams
256260
Required: False
257261
Position: Named
258262
Default value: True
259263
Accept pipeline input: False
260264
Accept wildcard characters: False
261265
```
262266

263-
### -EnableTeamsConsumerInbound
264-
(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user.
265-
266-
To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled.
267-
267+
### -EnableFederationAccess
268+
Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization.
268269
Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams.
269270
The default value is True.
270271

271272
```yaml
272273
Type: Boolean
273274
Parameter Sets: (All)
274275
Aliases:
275-
Required: False
276-
Position: Named
277-
Default value: True
278-
Accept pipeline input: False
279-
Accept wildcard characters: False
280-
```
281276
282-
### -EnableAcsFederationAccess
283-
Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation.
284-
285-
To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled.
286-
287-
To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled.
288-
289-
```yaml
290-
Type: Boolean
291-
Parameter Sets: (All)
292-
Aliases:
293-
Applicable: Microsoft Teams
294277
Required: False
295278
Position: Named
296279
Default value: True
@@ -347,27 +330,50 @@ Accept pipeline input: False
347330
Accept wildcard characters: False
348331
```
349332

350-
### -Force
351-
Suppresses the display of any non-fatal error message that might occur when running the command.
333+
### -EnableTeamsConsumerAccess
334+
(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization.
335+
336+
To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled.
337+
338+
Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams.
339+
The default value is True.
352340

353341
```yaml
354-
Type: SwitchParameter
342+
Type: Boolean
355343
Parameter Sets: (All)
356344
Aliases:
345+
Required: False
346+
Position: Named
347+
Default value: True
348+
Accept pipeline input: False
349+
Accept wildcard characters: False
350+
```
351+
352+
### -EnableTeamsConsumerInbound
353+
(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user.
354+
355+
To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled.
356+
357+
Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams.
358+
The default value is True.
357359

360+
```yaml
361+
Type: Boolean
362+
Parameter Sets: (All)
363+
Aliases:
358364
Required: False
359365
Position: Named
360-
Default value: None
366+
Default value: True
361367
Accept pipeline input: False
362368
Accept wildcard characters: False
363369
```
364370

365-
### -InMemory
366-
Creates an object reference without actually committing the object as a permanent change.
367-
If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\<cmdlet\>.
371+
### -EnableXmppAccess
372+
Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner.
373+
The default value is False.
368374

369375
```yaml
370-
Type: SwitchParameter
376+
Type: Boolean
371377
Parameter Sets: (All)
372378
Aliases:
373379
@@ -378,28 +384,28 @@ Accept pipeline input: False
378384
Accept wildcard characters: False
379385
```
380386

381-
### -WhatIf
382-
Describes what would happen if you executed the command without actually executing the command.
387+
### -FederatedBilateralChats
388+
This setting enables bi-lateral chats for the users included in the messaging policy.
383389

384390
```yaml
385-
Type: SwitchParameter
391+
Type: Boolean
386392
Parameter Sets: (All)
387-
Aliases: wi
393+
Aliases:
388394
389395
Required: False
390396
Position: Named
391-
Default value: None
397+
Default value: True
392398
Accept pipeline input: False
393399
Accept wildcard characters: False
394400
```
395401

396-
### -Confirm
397-
Prompts you for confirmation before executing the command.
402+
### -Force
403+
Suppresses the display of any non-fatal error message that might occur when running the command.
398404

399405
```yaml
400406
Type: SwitchParameter
401407
Parameter Sets: (All)
402-
Aliases: cf
408+
Aliases:
403409
404410
Required: False
405411
Position: Named
@@ -408,12 +414,12 @@ Accept pipeline input: False
408414
Accept wildcard characters: False
409415
```
410416

411-
### -EnableXmppAccess
412-
Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner.
413-
The default value is False.
417+
### -InMemory
418+
Creates an object reference without actually committing the object as a permanent change.
419+
If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\<cmdlet\>.
414420

415421
```yaml
416-
Type: Boolean
422+
Type: SwitchParameter
417423
Parameter Sets: (All)
418424
Aliases:
419425
@@ -446,6 +452,21 @@ Accept pipeline input: False
446452
Accept wildcard characters: False
447453
```
448454

455+
### -WhatIf
456+
Describes what would happen if you executed the command without actually executing the command.
457+
458+
```yaml
459+
Type: SwitchParameter
460+
Parameter Sets: (All)
461+
Aliases: wi
462+
463+
Required: False
464+
Position: Named
465+
Default value: None
466+
Accept pipeline input: False
467+
Accept wildcard characters: False
468+
```
469+
449470
### CommonParameters
450471
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).`
451472

0 commit comments

Comments
 (0)