Skip to content

Commit 3c59637

Browse files
authored
Update Set-CsTenantFederationConfiguration.md
Adding documentation for AllowedTrialTenantDomains.
1 parent cd481cb commit 3c59637

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Set-CsTenantFederationConfiguration [-Tenant <Guid>]
2525
[-AllowFederatedUsers <Boolean>] [-AllowPublicUsers <Boolean>] [-AllowTeamsConsumer <Boolean>] [-AllowTeamsConsumerInbound <Boolean>]
2626
[-TreatDiscoveredPartnersAsUnverified <Boolean>] [-SharedSipAddressSpace <Boolean>] [-RestrictTeamsConsumerToExternalUserProfiles <Boolean>]
2727
[-AllowedDomainsAsAList <List>] [-ExternalAccessWithTrialTenants <ExternalAccessWithTrialTenantsType>] [-CustomizeFederation <Boolean>]
28+
[-AllowedTrialTenantDomains <List>]
2829
[[-Identity] <XdsIdentity>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
2930
```
3031

@@ -182,6 +183,42 @@ Set-CsTenantFederationConfiguration -CustomizeFederation $True
182183

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

186+
### -------------------------- Example 13 --------------------------
187+
```
188+
$list = New-Object Collections.Generic.List[String]
189+
$list.add("contoso.com")
190+
$list.add("fabrikam.com")
191+
192+
Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains $list
193+
```
194+
195+
Example 13 shows how you can set or replace domains in the Allowed Trial Tenant Domains using a List collection object.
196+
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.
197+
When this command completes, the Allowed Trial Tenant Domains list will be replaced with those domains.
198+
199+
### -------------------------- Example 14 --------------------------
200+
```
201+
$list = New-Object Collections.Generic.List[String]
202+
$list.add("contoso.com")
203+
204+
Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Add=$list}
205+
```
206+
207+
Example 14 shows how you can add domains to the existing Allowed Trial Tenant Domains using a List collection object.
208+
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.
209+
When this command completes, the domains in the list will be added to any domains already on the Allowed Trial Tenant Domains list.
210+
211+
### -------------------------- Example 15 --------------------------
212+
```
213+
$list = New-Object Collections.Generic.List[String]
214+
$list.add("contoso.com")
215+
216+
Set-CsTenantFederationConfiguration -AllowedTrialTenantDomains @{Remove=$list}
217+
```
218+
219+
Example 15 shows how you can remove domains from the existing Allowed Trial Tenant Domains using a List collection object.
220+
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.
221+
When this command completes, the domains in the list will be removed from the Allowed Trial Tenant Domains list.
185222

186223
## PARAMETERS
187224

@@ -507,6 +544,23 @@ Accept pipeline input: False
507544
Accept wildcard characters: False
508545
```
509546

547+
### -AllowedTrialTenantDomains
548+
You can provide list of trial tenant domains which are excluded from blocking when `ExternalAccessWithTrialTenants` is set to `Blocked`.
549+
This allows you to have trial tenant block enabled but still selectively allow communication with some trial tenants.
550+
551+
```yaml
552+
Type: List
553+
Parameter Sets: (All)
554+
Aliases:
555+
applicable: Microsoft Teams
556+
557+
Required: False
558+
Position: Named
559+
Default value: None
560+
Accept pipeline input: False
561+
Accept wildcard characters: False
562+
```
563+
510564
### -WhatIf
511565
Describes what would happen if you executed the command without actually executing the command.
512566

0 commit comments

Comments
 (0)