Skip to content

Commit eac9473

Browse files
authored
Merge pull request #11626 from andreimaneev/andreimaneev/add_blockallsubdomains_doc
Add documentation about BlockAllSubdomains param
2 parents d417847 + 6e60704 commit eac9473

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,17 @@ These settings are used to determine which domains (if any) your users are allow
2020

2121
### Identity (Default)
2222
```
23-
Set-CsTenantFederationConfiguration [-Tenant <Guid>] [-AllowedDomains <IAllowedDomainsChoice>]
24-
[-BlockedDomains <List>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] [-AllowTeamsConsumer <Boolean>] [-AllowTeamsConsumerInbound <Boolean>]
23+
Set-CsTenantFederationConfiguration [-Tenant <Guid>]
24+
[-AllowedDomains <IAllowedDomainsChoice>] [-BlockedDomains <List>] [-BlockAllSubdomains <Boolean>]
25+
[-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] [-AllowTeamsConsumer <Boolean>] [-AllowTeamsConsumerInbound <Boolean>]
2526
[-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>]
2627
[-AllowedDomainsAsAList <List>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
2728
```
2829

2930
### Instance
3031
```
3132
Set-CsTenantFederationConfiguration [-Tenant <Guid>] [-AllowedDomains <IAllowedDomainsChoice>]
32-
[-BlockedDomains <List>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>]
33+
[-BlockedDomains <List>] [-BlockAllSubdomains <Boolean>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>]
3334
[-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>]
3435
[-AllowedDomainsAsAList <List>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
3536
```
@@ -150,6 +151,22 @@ Set-CsTenantFederationConfiguration -AllowTeamsConsumer $True -AllowTeamsConsume
150151

151152
The command shown in Example 9 enables communication with people using Teams with an account that's not managed by an organization, to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people in your organization.
152153

154+
### -------------------------- Example 10 -------------------------
155+
```
156+
$list = New-Object Collections.Generic.List[String]
157+
$list.add("contoso.com")
158+
$list.add("fabrikam.com")
159+
Set-CsTenantFederationConfiguration -BlockedDomains $list
160+
161+
Set-CsTenantFederationConfiguration -BlockAllSubdomains $True
162+
```
163+
164+
Example 10 shows how you can block all subdomains of domains in BlockedDomains list.
165+
In this example, all users from contoso.com and fabrikam.com will be blocked.
166+
When the BlockAllSubdomains is enabled, all users from all subdomains of all domains in BlockedDomains list will also be blocked.
167+
So, users from subdomain.contoso.com and subdomain.fabrikam.com will be blocked.
168+
Note: Users from subcontoso.com will not be blocked because it's a completely different domain rather than a subdomain of contoso.com.
169+
153170
## PARAMETERS
154171

155172
### -AllowedDomains
@@ -256,6 +273,25 @@ Accept pipeline input: False
256273
Accept wildcard characters: False
257274
```
258275

276+
### -BlockAllSubdomains
277+
If the BlockedDomains parameter is used, then BlockAllSubdomains can be used to activate all subdomains blocking.
278+
If the BlockedDomains parameter is ignored, then BlockAllSubdomains is also ignored.
279+
Just like for BlockedDomains, users will be disallowed from communicating with users from blocked domains.
280+
But all subdomains for domains in this list will also be blocked.
281+
282+
```yaml
283+
Type: SwitchParameter
284+
Parameter Sets: (All)
285+
Aliases:
286+
Applicable: Skype for Business Online
287+
288+
Required: False
289+
Position: Named
290+
Default value: None
291+
Accept pipeline input: False
292+
Accept wildcard characters: False
293+
```
294+
259295
### -Confirm
260296
Prompts you for confirmation before executing the command.
261297

0 commit comments

Comments
 (0)