Skip to content

Add documentation about BlockAllSubdomains param #11626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 12, 2024
Merged

Add documentation about BlockAllSubdomains param #11626

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f106620
Add documentation about BlockAllSubdomains param
andreimaneev Feb 21, 2024
3b921fc
Change default value to None
andreimaneev Feb 21, 2024
6b63cbd
Extend doc
andreimaneev Mar 12, 2024
3861a67
Improve description of domains couples
andreimaneev Mar 12, 2024
6e60704
Improve sentence about subdomains
andreimaneev Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 39 additions & 3 deletions skype/skype-ps/skype/Set-CsTenantFederationConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,17 @@ These settings are used to determine which domains (if any) your users are allow

### Identity (Default)
```
Set-CsTenantFederationConfiguration [-Tenant <Guid>] [-AllowedDomains <IAllowedDomainsChoice>]
[-BlockedDomains <List>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] [-AllowTeamsConsumer <Boolean>] [-AllowTeamsConsumerInbound <Boolean>]
Set-CsTenantFederationConfiguration [-Tenant <Guid>]
[-AllowedDomains <IAllowedDomainsChoice>] [-BlockedDomains <List>] [-BlockAllSubdomains <Boolean>]
[-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] [-AllowTeamsConsumer <Boolean>] [-AllowTeamsConsumerInbound <Boolean>]
[-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>]
[-AllowedDomainsAsAList <List>] [[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### Instance
```
Set-CsTenantFederationConfiguration [-Tenant <Guid>] [-AllowedDomains <IAllowedDomainsChoice>]
[-BlockedDomains <List>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>]
[-BlockedDomains <List>] [-BlockAllSubdomains <Boolean>] [-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>]
[-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>]
[-AllowedDomainsAsAList <List>] [-Instance <PSObject>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
```
Expand Down Expand Up @@ -150,6 +151,22 @@ Set-CsTenantFederationConfiguration -AllowTeamsConsumer $True -AllowTeamsConsume

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.

### -------------------------- Example 10 -------------------------
```
$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")
$list.add("fabrikam.com")
Set-CsTenantFederationConfiguration -BlockedDomains $list

Set-CsTenantFederationConfiguration -BlockAllSubdomains $True
```

Example 10 shows how you can block all subdomains of domains in BlockedDomains list.
In this example, all users from contoso.com and fabrikam.com will be blocked.
When the BlockAllSubdomains is enabled, all users from all subdomains of all domains in BlockedDomains list will also be blocked.
So, users from subdomain.contoso.com and subdomain.fabrikam.com will be blocked.
Note: Users from subcontoso.com will not be blocked because it's a completely different domain rather than a subdomain of contoso.com.

## PARAMETERS

### -AllowedDomains
Expand Down Expand Up @@ -256,6 +273,25 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -BlockAllSubdomains
If the BlockedDomains parameter is used, then BlockAllSubdomains can be used to activate all subdomains blocking.
If the BlockedDomains parameter is ignored, then BlockAllSubdomains is also ignored.
Just like for BlockedDomains, users will be disallowed from communicating with users from blocked domains.
But all subdomains for domains in this list will also be blocked.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Applicable: Skype for Business Online

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Confirm
Prompts you for confirmation before executing the command.

Expand Down