Skip to content
Next Next commit
Update Set-CsTenantFederationConfiguration.md
Adding documentation for AllowedTrialTenantDomains.
  • Loading branch information
rhrivnak authored Nov 7, 2024
commit 3c59637f1fbb86b37bda4d2db2beeaba7fc2a623
54 changes: 54 additions & 0 deletions teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Set-CsTenantFederationConfiguration [-Tenant <Guid>]
[-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>]
```

Expand Down Expand Up @@ -182,6 +183,42 @@ Set-CsTenantFederationConfiguration -CustomizeFederation $True

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

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

Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains $list
```

Example 13 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 14 --------------------------
```
$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")

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

Example 14 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 15 --------------------------
```
$list = New-Object Collections.Generic.List[String]
$list.add("contoso.com")

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

Example 15 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.

## PARAMETERS

Expand Down Expand Up @@ -507,6 +544,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -AllowedTrialTenantDomains
You can provide list of trial tenant domains which are excluded from blocking when `ExternalAccessWithTrialTenants` is set to `Blocked`.
This allows you to have trial tenant block enabled but still selectively allow communication with some trial tenants.

```yaml
Type: List
Parameter Sets: (All)
Aliases:
applicable: Microsoft Teams

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

### -WhatIf
Describes what would happen if you executed the command without actually executing the command.

Expand Down