Skip to content

Commit f106620

Browse files
committed
Add documentation about BlockAllSubdomains param
This param was implemented for Federation Settings.
1 parent 86797be commit f106620

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

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

Lines changed: 32 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,15 @@ 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+
Set-CsTenantFederationConfiguration -BlockAllSubdomains $True
157+
```
158+
159+
Example 10 shows how you can empower BlockedDomains to also block all subdomains.
160+
Let's say you block contoso.com. Then all users from subdomain.contoso.com will also be blocked.
161+
Note: Users from subcontoso.com will not be blocked because it's a completely different domain rather than a subdomain.
162+
153163
## PARAMETERS
154164

155165
### -AllowedDomains
@@ -256,6 +266,25 @@ Accept pipeline input: False
256266
Accept wildcard characters: False
257267
```
258268

269+
### -BlockAllSubdomains
270+
If the BlockedDomains parameter is used, then BlockAllSubdomains can be used to activate all subdomains blocking.
271+
If the BlockedDomains parameter is ignored, then BlockAllSubdomains is also ignored.
272+
Just like for BlockedDomains, users will be disallowed from communicating with users from blocked domains.
273+
But all subdomains for domains in this list will also be blocked.
274+
275+
```yaml
276+
Type: SwitchParameter
277+
Parameter Sets: (All)
278+
Aliases:
279+
Applicable: Skype for Business Online
280+
281+
Required: False
282+
Position: Named
283+
Default value: False
284+
Accept pipeline input: False
285+
Accept wildcard characters: False
286+
```
287+
259288
### -Confirm
260289
Prompts you for confirmation before executing the command.
261290

0 commit comments

Comments
 (0)