Skip to content

Commit e6bcadd

Browse files
authored
Merge pull request #12355 from rhrivnak/patch-1
Set-CsTenantFederationConfiguration - new AllowedTrialTenantDomains parameter docs
2 parents 6c90a6d + 330ee81 commit e6bcadd

File tree

1 file changed

+62
-3
lines changed

1 file changed

+62
-3
lines changed

teams/teams-ps/teams/Set-CsTenantFederationConfiguration.md

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ manager: bulenteg
88
author: tomkau
99
ms.author: tomkau
1010
ms.reviewer: williamlooney
11+
ms.date: 12/11/2024
1112
---
1213

1314
# Set-CsTenantFederationConfiguration
@@ -25,6 +26,7 @@ Set-CsTenantFederationConfiguration [-Tenant <Guid>]
2526
[-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] [-AllowTeamsConsumer <Boolean>] [-AllowTeamsConsumerInbound <Boolean>]
2627
[-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>] [-RestrictTeamsConsumerToExternalUserProfiles <Boolean>]
2728
[-AllowedDomainsAsAList <List>] [-ExternalAccessWithTrialTenants <ExternalAccessWithTrialTenantsType>] [-CustomizeFederation <Boolean>]
29+
[-AllowedTrialTenantDomains <List>]
2830
[[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
2931
```
3032

@@ -175,13 +177,49 @@ Set-CsTenantFederationConfiguration -ExternalAccessWithTrialTenants "Allowed"
175177

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

178-
### -------------------------- Example 12 -------------------------
180+
### -------------------------- Example 12 --------------------------
179181
```
180-
Set-CsTenantFederationConfiguration -CustomizeFederation $True
182+
$list = New-Object Collections.Generic.List[String]
183+
$list.add("contoso.com")
184+
$list.add("fabrikam.com")
185+
186+
Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains $list
181187
```
182188

183-
Example 12 shows how you can enable the feature where you can customize your federation in ExternalAccessPolicy.
189+
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.
190+
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.
191+
When this command completes, the Allowed Trial Tenant Domains list will be replaced with those domains.
184192

193+
### -------------------------- Example 13 --------------------------
194+
```
195+
$list = New-Object Collections.Generic.List[String]
196+
$list.add("contoso.com")
197+
198+
Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Add=$list}
199+
```
200+
201+
Example 13 shows how you can add domains to the existing Allowed Trial Tenant Domains using a List collection object.
202+
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.
203+
When this command completes, the domains in the list will be added to any domains already on the Allowed Trial Tenant Domains list.
204+
205+
### -------------------------- Example 14 --------------------------
206+
```
207+
$list = New-Object Collections.Generic.List[String]
208+
$list.add("contoso.com")
209+
210+
Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Remove=$list}
211+
```
212+
213+
Example 14 shows how you can remove domains from the existing Allowed Trial Tenant Domains using a List collection object.
214+
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.
215+
When this command completes, the domains in the list will be removed from the Allowed Trial Tenant Domains list.
216+
217+
### -------------------------- Example 15 -------------------------
218+
```
219+
Set-CsTenantFederationConfiguration -CustomizeFederation $True
220+
```
221+
222+
Example 15 shows how you can enable the feature where you can customize your federation in ExternalAccessPolicy.
185223

186224
## PARAMETERS
187225

@@ -475,6 +513,27 @@ Accept pipeline input: False
475513
Accept wildcard characters: False
476514
```
477515

516+
### -AllowedTrialTenantDomains
517+
You can whitelist specific "trial-only" tenant domains, while keeping the `ExternalAccessWithTrialTenants` set to `Blocked`. This will allow you to protect your organization against majority of tenants that don't have any paid subscriptions, while still being able to collaborate externally with those trusted trial-tenants in the list.
518+
519+
Note:
520+
- The list supports up to maximum 4k domains.
521+
- If `ExternalAccessWithTrialTenants` is set to `Allowed`, then the `AllowedTrialTenantDomains` list will not be checked.
522+
- Any domain in this list that belongs to a tenant with paid subscriptions will be ignored.
523+
524+
```yaml
525+
Type: List
526+
Parameter Sets: (All)
527+
Aliases:
528+
applicable: Microsoft Teams
529+
530+
Required: False
531+
Position: Named
532+
Default value: None
533+
Accept pipeline input: False
534+
Accept wildcard characters: False
535+
```
536+
478537
### -RestrictTeamsConsumerToExternalUserProfiles
479538
Defines if a user is restriced to collaboration with Teams Consumer (TFL) user only in Extended Directory.
480539
Possible values: True, False

0 commit comments

Comments
 (0)