Skip to content

Commit 879885e

Browse files
authored
Update Set-CsExternalAccessPolicy.md
add granular federation fields
1 parent 7978591 commit 879885e

File tree

1 file changed

+60
-2
lines changed

1 file changed

+60
-2
lines changed

teams/teams-ps/teams/Set-CsExternalAccessPolicy.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This cmdlet was introduced in Lync Server 2010.
1919

2020
### Identity (Default)
2121
```
22-
Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-EnableAcsFederationAccess <Boolean>]
22+
Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-CommunicationWithExternalOrgs <Boolean>] [-AllowedExternalDomains <List>] [-BlockedExternalDomains <List>] [-EnableAcsFederationAccess <Boolean>]
2323
[-EnableXmppAccess <Boolean>] [-EnablePublicCloudAccess <Boolean>]
2424
[-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableTeamsConsumerAccess <Boolean>] [-EnableTeamsConsumerInbound <Boolean>] [-EnableOutsideAccess <Boolean>] [[-Identity] <XdsIdentity>]
2525
[-RestrictTeamsConsumerAccessToExternalUserProfiles <Boolean>] [-EnableTeamsSmsAccess <Boolean>]
@@ -28,7 +28,7 @@ Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFede
2828

2929
### Instance
3030
```
31-
Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-EnableAcsFederationAccess <Boolean>]
31+
Set-CsExternalAccessPolicy [-Tenant <Guid>] [-Description <String>] [-EnableFederationAccess <Boolean>] [-CommunicationWithExternalOrgs <Boolean>] [-AllowedExternalDomains <List>] [-BlockedExternalDomains <List>] [-EnableAcsFederationAccess <Boolean>]
3232
[-EnableXmppAccess <Boolean>] [-EnablePublicCloudAccess <Boolean>]
3333
[-RestrictTeamsConsumerAccessToExternalUserProfiles <Boolean>] [-EnableTeamsSmsAccess <Boolean>]
3434
[-EnablePublicCloudAudioVideoAccess <Boolean>] [-EnableTeamsConsumerAccess <Boolean>] [-EnableTeamsConsumerInbound <Boolean>] [-EnableOutsideAccess <Boolean>] [-Instance <PSObject>]
@@ -118,6 +118,14 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio
118118

119119
In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed.
120120

121+
### -------------------------- Example 6 ------------------------
122+
```
123+
New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com")
124+
Set-CsTenantFederationConfiguration -CustomizeFederation $true
125+
```
126+
127+
In this example, we create an ExternalAccessPolicy named "GranularFederationExample" that allows communication with specific external domains, namely `example1.com` and `example2.com`. The federation policy is set to restrict communication to only these allowed domains. After that, we still have to enable the `CustomizeFederation` setting in the TenantFederationConfiguration to allow the federation settings as defined in the ExternalAccessPolicy to work.
128+
121129
## PARAMETERS
122130

123131
### -Identity
@@ -194,6 +202,56 @@ Accept pipeline input: False
194202
Accept wildcard characters: False
195203
```
196204
205+
### -CommunicationWithExternalOrgs
206+
Indicates how the users get assigned by this policy can communicate with the external orgs. There are 5 options:
207+
* OrganizationDefault: the users of this policy will follow the federation settings defined in TenantFederationConfiguration
208+
* AllowAllExternalDomains: the users are open to communicate with all domains
209+
* AllowSpecificExternalDomains: the users can only communicate with the users of the domains defined in `AllowedExternalDomains`
210+
* BlockSpecificExternalDomains: only users from the domains defined in `BlockedExternalDomains` are blocked from communicating with the users of this policy
211+
* BlockAllExternalDomains: the users are not able to communicate with any external domains
212+
```yaml
213+
Type: String
214+
Parameter Sets: (All)
215+
Aliases:
216+
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019
217+
218+
Required: False
219+
Position: Named
220+
Default value: OrganizationDefault
221+
Accept pipeline input: False
222+
Accept wildcard characters: False
223+
```
224+
225+
### -AllowedExternalDomains
226+
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`
227+
```yaml
228+
Type: List
229+
Parameter Sets: (All)
230+
Aliases:
231+
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019
232+
233+
Required: False
234+
Position: Named
235+
Default value: None
236+
Accept pipeline input: False
237+
Accept wildcard characters: False
238+
```
239+
240+
### -BlockedExternalDomains
241+
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`
242+
```yaml
243+
Type: List
244+
Parameter Sets: (All)
245+
Aliases:
246+
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019
247+
248+
Required: False
249+
Position: Named
250+
Default value: None
251+
Accept pipeline input: False
252+
Accept wildcard characters: False
253+
```
254+
197255
### -EnableAcsFederationAccess
198256
Indicates whether Teams meeting 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.
199257

0 commit comments

Comments
 (0)