Skip to content

Commit 1935dac

Browse files
Merge pull request #12720 from krammerliu/patch-6
Update Set-CsExternalAccessPolicy.md
2 parents d6ae845 + a088edb commit 1935dac

File tree

2 files changed

+37
-18
lines changed

2 files changed

+37
-18
lines changed

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

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWit
133133
Set-CsTenantFederationConfiguration -CustomizeFederation $true
134134
```
135135

136-
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.
136+
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.
137137

138138
## PARAMETERS
139139

@@ -163,7 +163,10 @@ Accept wildcard characters: False
163163
```
164164
165165
### -AllowedExternalDomains
166-
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`.
166+
> [!NOTE]
167+
> Please note that this parameter is in Private Preview.
168+
169+
Specifies the external domains allowed to communicate with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `AllowSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed.
167170

168171
```yaml
169172
Type: List
@@ -178,7 +181,10 @@ Accept wildcard characters: False
178181
```
179182

180183
### -BlockedExternalDomains
181-
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`.
184+
> [!NOTE]
185+
> Please note that this parameter is in Private Preview.
186+
187+
Specifies the external domains blocked from communicating with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `BlockSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed.
182188

183189
```yaml
184190
Type: List
@@ -193,14 +199,18 @@ Accept wildcard characters: False
193199
```
194200

195201
### -CommunicationWithExternalOrgs
196-
Indicates how the users get assigned by this policy can communicate with the external orgs. There are 5 options:
202+
> [!NOTE]
203+
> Please note that this parameter is in Private Preview.
204+
205+
Indicates how users assigned to the policy can communicate with external organizations (domains). This setting has 5 possible values:
197206

198-
- OrganizationDefault: the users of this policy will follow the federation settings defined in TenantFederationConfiguration
199-
- AllowAllExternalDomains: the users are open to communicate with all domains
200-
- AllowSpecificExternalDomains: the users can only communicate with the users of the domains defined in `AllowedExternalDomains`
201-
- BlockSpecificExternalDomains: only users from the domains defined in `BlockedExternalDomains` are blocked from communicating with the users of this policy
202-
- BlockAllExternalDomains: the users are not able to communicate with any external domains
207+
- OrganizationDefault: users follow the federation settings specified in `TenantFederationConfiguration`. This is the default value.
208+
- AllowAllExternalDomains: users are allowed to communicate with all domains.
209+
- AllowSpecificExternalDomains: users can communicate with external domains listed in `AllowedExternalDomains`.
210+
- BlockSpecificExternalDomains: users are blocked from communicating with domains listed in `BlockedExternalDomains`.
211+
- BlockAllExternalDomains: users cannot communicate with any external domains.
203212

213+
The setting is only applicable when `EnableFederationAccess` is set to true. This setting can only be modified in custom policies. In the Global (default) policy, it is fixed to `OrganizationDefault` and cannot be changed.
204214
```yaml
205215
Type: String
206216
Parameter Sets: (All)

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

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,7 @@ In this example, the Global policy is updated to allow Teams-ACS federation for
142142
New-CsExternalAccessPolicy -Identity GranularFederationExample -CommunicationWithExternalOrgs "AllowSpecificExternalDomains" -AllowedExternalDomains @("example1.com", "example2.com")
143143
Set-CsTenantFederationConfiguration -CustomizeFederation $true
144144
```
145-
146-
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.
145+
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.
147146

148147
## PARAMETERS
149148

@@ -187,7 +186,10 @@ Accept wildcard characters: False
187186
```
188187
189188
### -AllowedExternalDomains
190-
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`
189+
> [!NOTE]
190+
> Please note that this parameter is in Private Preview.
191+
192+
Specifies the external domains allowed to communicate with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `AllowSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed.
191193
```yaml
192194
Type: List
193195
Parameter Sets: (All)
@@ -202,7 +204,10 @@ Accept wildcard characters: False
202204
```
203205

204206
### -BlockedExternalDomains
205-
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`
207+
> [!NOTE]
208+
> Please note that this parameter is in Private Preview.
209+
210+
Specifies the external domains blocked from communicating with users assigned to this policy. This setting is applicable only when `CommunicationWithExternalOrgs` is configured to `BlockSpecificExternalDomains`. This setting can be modified only in custom policy. In Global (default) policy `CommunicationWithExternalOrgs` can only be set to `OrganizationDefault` and cannot be changed.
206211
```yaml
207212
Type: List
208213
Parameter Sets: (All)
@@ -217,14 +222,18 @@ Accept wildcard characters: False
217222
```
218223

219224
### -CommunicationWithExternalOrgs
225+
> [!NOTE]
226+
> Please note that this parameter is in Private Preview.
227+
220228
Indicates how the users get assigned by this policy can communicate with the external orgs. There are 5 options:
221229

222-
- OrganizationDefault: the users of this policy will follow the federation settings defined in TenantFederationConfiguration.
223-
- AllowAllExternalDomains: the users are open to communicate with all domains.
224-
- AllowSpecificExternalDomains: the users can only communicate with the users of the domains defined in `AllowedExternalDomains`.
225-
- BlockSpecificExternalDomains: only users from the domains defined in `BlockedExternalDomains` are blocked from communicating with the users of this policy.
226-
- BlockAllExternalDomains: the users are not able to communicate with any external domains.
230+
- OrganizationDefault: users follow the federation settings specified in `TenantFederationConfiguration`. This is the default value.
231+
- AllowAllExternalDomains: users are allowed to communicate with all domains.
232+
- AllowSpecificExternalDomains: users can communicate with external domains listed in `AllowedExternalDomains`.
233+
- BlockSpecificExternalDomains: users are blocked from communicating with domains listed in `BlockedExternalDomains`.
234+
- BlockAllExternalDomains: users cannot communicate with any external domains.
227235

236+
The setting is only applicable when `EnableFederationAccess` is set to true. This setting can only be modified in custom policies. In the Global (default) policy, it is fixed to `OrganizationDefault` and cannot be changed.
228237
```yaml
229238
Type: String
230239
Parameter Sets: (All)

0 commit comments

Comments
 (0)