Set-CsTenantFederationConfiguration

Syntax

Set-CsTenantFederationConfiguration
   [-Tenant <Guid>]
   [-AllowedDomains <IAllowedDomainsChoice>]
   [-BlockedDomains <List>]
   [-BlockAllSubdomains <Boolean>]
   [-AllowFederatedUsers <Boolean>]
   [-AllowPublicUsers <Boolean>]
   [-AllowTeamsConsumer <Boolean>]
   [-AllowTeamsConsumerInbound <Boolean>]
   [-TreatDiscoveredPartnersAsUnverified <Boolean>]
   [-SharedSipAddressSpace <Boolean>]
   [-RestrictTeamsConsumerToExternalUserProfiles <Boolean>]
   [-AllowedDomainsAsAList <List>]
   [-ExternalAccessWithTrialTenants <ExternalAccessWithTrialTenantsType>]
   [-CustomizeFederation <Boolean>]
   [-AllowedTrialTenantDomains <List>]
   [[-Identity] <XdsIdentity>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CsTenantFederationConfiguration
   [-Tenant <Guid>]
   [-AllowedDomains <IAllowedDomainsChoice>]
   [-BlockedDomains <List>]
   [-BlockAllSubdomains <Boolean>]
   [-AllowFederatedUsers <Boolean>]
   [-AllowPublicUsers <Boolean>]
   [-TreatDiscoveredPartnersAsUnverified <Boolean>]
   [-SharedSipAddressSpace <Boolean>]
   [-RestrictTeamsConsumerToExternalUserProfiles <Boolean>]
   [-AllowedDomainsAsAList <List>]
   [-CustomizeFederation <Boolean>]
   [-Instance <PSObject>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Federation is a service that enables users to exchange IM and presence information with users from other domains. With Skype for Business Online, administrators can use the federation configuration settings to govern:

Whether or not users can communicate with people from other domains and if so, which domains they are allowed to communicate with.

Whether or not users can communicate with people who have accounts on public IM and presence providers such as Windows Live, Skype, or people using Microsoft Teams with an account that's not managed by an organization.

Administrators can use the Set-CsTenantFederationConfiguration cmdlet to enable and disable federation with other domains and federation with public providers. In addition, this cmdlet can be used to expressly indicate the domains that users can communicate with and/or the domains that users are not allowed to communicate with. However, administrators must use the Set-CsTenantPublicProvider cmdlet in order to indicate the public IM and presence providers that users can and cannot communicate with.

Examples

-------------------------- Example 1 --------------------------

Set-CsTenantFederationConfiguration -AllowPublicUsers $False

The command shown in Example 1 disables communication with public providers for the current tenant.

-------------------------- Example 2 --------------------------

$x = New-CsEdgeDomainPattern -Domain "fabrikam.com"

Set-CsTenantFederationConfiguration -BlockedDomains @{Replace=$x}

In Example 2, the domain fabrikam.com is assigned as the only domain on the blocked domains list for current tenant. To do this, the first command in the example uses the New-CsEdgeDomainPattern cmdlet to create a new domain object for fabrikam.com. This domain object is stored in a variable named $x.

The second command in the example then uses the Set-CsTenantFederationConfiguration cmdlet to update the blocked domains list. Using the Replace method ensures that the existing blocked domains list will be replaced by the new list: a list that contains only the domain fabrikam.com.

-------------------------- Example 3 --------------------------

$x = New-CsEdgeDomainPattern -Domain "fabrikam.com"

Set-CsTenantFederationConfiguration -BlockedDomains @{Remove=$x}

The commands shown in Example 3 remove fabrikam.com from the list of domains blocked by the current tenant. To do this, the first command in the example uses the New-CsEdgeDomainPattern cmdlet to create a domain object for fabrikam.com. The resulting domain object is then stored in a variable named $x.

The second command in the example then uses the Set-CsTenantFederationConfiguration cmdlet and the Remove method to remove fabrikam.com from the blocked domains list for the specified tenant.

-------------------------- Example 4 --------------------------

$x = New-CsEdgeDomainPattern -Domain "fabrikam.com"

Set-CsTenantFederationConfiguration -BlockedDomains @{Add=$x}

The commands shown in Example 4 add the domain fabrikam.com to the list of domains blocked by the current tenant. To add a new blocked domain, the first command in the example uses the New-CsEdgeDomainPattern cmdlet to create a domain object for fabrikam.com. This object is stored in a variable named $x.

After the domain object has been created, the second command then uses the Set-CsTenantFederationConfiguration cmdlet and the Add method to add fabrikam.com to any domains already on the blocked domains list.

-------------------------- Example 5 --------------------------

Set-CsTenantFederationConfiguration -BlockedDomains $Null

Example 5 shows how you can remove all the domains assigned to the blocked domains list for the current tenant. To do this, simply include the BlockedDomains parameter and set the parameter value to null ($Null). When this command completes, the blocked domain list will be cleared.

-------------------------- Example 6 --------------------------

$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")
$list.add("fabrikam.com")
Set-CsTenantFederationConfiguration -AllowedDomainsAsAList $list

Example 6 shows how you can replace domains in the Allowed Domains using a List collection object. First, a List collection is created and domains are added to it, then, simply include the AllowedDomainsAsAList parameter and set the parameter value to the List object. When this command completes, the allowed domains list will be replaced with those domains.

-------------------------- Example 7 --------------------------

$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")
$list.add("fabrikam.com")
Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Add=$list}

Example 7 shows how you can add domains to the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Add method in the AllowedDomainsAsAList parameter to add the domains to the existing allowed domains list. When this command completes, the domains in the list will be added to any domains already on the AllowedDomains list.

-------------------------- Example 8 --------------------------

$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")
$list.add("fabrikam.com")
Set-CsTenantFederationConfiguration -AllowedDomainsAsAList @{Remove=$list}

Example 8 shows how you can remove domains from the existing Allowed Domains using a List object. First, a List is created and domains are added to it, then use the Remove method in the AllowedDomainsAsAList parameter to remove the domains from the existing allowed domains list. When this command completes, the domains in the list will be removed from the AllowedDomains list.

-------------------------- Example 9 --------------------------

Set-CsTenantFederationConfiguration -AllowTeamsConsumer $True -AllowTeamsConsumerInbound $False

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.

-------------------------- Example 11 -------------------------

Set-CsTenantFederationConfiguration -ExternalAccessWithTrialTenants "Allowed"

Example 11 shows how you can allow users to communicate with users in tenants that contain only trial licenses (default value is Blocked).

-------------------------- Example 12 --------------------------

$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")
$list.add("fabrikam.com")

Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains $list

Using the AllowedTrialTenantDomains parameter, you can whitelist specific "trial-only" tenant domains, while keeping the ExternalAccessWithTrialTenants set to Blocked. Example 12 shows how you can set or replace domains in the Allowed Trial Tenant Domains using a List collection object. First, a List collection is created and domains are added to it, then, simply include the AllowedTrialTenantDomains parameter and set the parameter value to the List object. When this command completes, the Allowed Trial Tenant Domains list will be replaced with those domains.

-------------------------- Example 13 --------------------------

$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")

Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Add=$list}

Example 13 shows how you can add domains to the existing Allowed Trial Tenant Domains using a List collection object. First, a List is created and domains are added to it, then, use the Add method in the AllowedTrialTenantDomains parameter to add the domains to the existing allowed domains list. When this command completes, the domains in the list will be added to any domains already on the Allowed Trial Tenant Domains list.

-------------------------- Example 14 --------------------------

$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")

Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Remove=$list}

Example 14 shows how you can remove domains from the existing Allowed Trial Tenant Domains using a List collection object. First, a List is created and domains are added to it, then use the Remove method in the AllowedTrialTenantDomains parameter to remove the domains from the existing allowed domains list. When this command completes, the domains in the list will be removed from the Allowed Trial Tenant Domains list.

-------------------------- Example 15 -------------------------

Set-CsTenantFederationConfiguration -CustomizeFederation $True

Example 15 shows how you can enable the feature where you can customize your federation in ExternalAccessPolicy.

Parameters

-AllowedDomains

-AllowedDomainsAsAList

-AllowedTrialTenantDomains

-AllowFederatedUsers

-AllowPublicUsers

-AllowTeamsConsumer

-AllowTeamsConsumerInbound

-BlockAllSubdomains

-BlockedDomains

-Confirm

-CustomizeFederation

-ExternalAccessWithTrialTenants

-Force

-Identity

-Instance

-RestrictTeamsConsumerToExternalUserProfiles

-SharedSipAddressSpace

-Tenant

-TreatDiscoveredPartnersAsUnverified

-WhatIf

Inputs

Input types

The Set-CsTenantFederationConfiguration cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object.

Outputs

Output types

None. Instead, the Set-CsTenantFederationConfiguration cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.TenantFederationSettings object.

Related Links

• Get-CsTenantFederationConfiguration