Set-RdsTenant

Reference

Module:: WindowsVirtualDesktopPowershell

Sets properties for a tenant.

Syntax

Set-RdsTenant
   [-Name] <String>
   [-AadTenantId <String>]
   [-FriendlyName <String>]
   [-Description <String>]
   [-SsoAdfsAuthority <String>]
   [-SsoClientId <String>]
   [-SsoClientSecret <String>]
   [-LogAnalyticsWorkspaceId <String>]
   [-LogAnalyticsPrimaryKey <String>]
   [<CommonParameters>]

Description

The Set-RdsTenant cmdlet sets properties for a tenant. Steps and examples for Sso properties will be included at a later date.

Examples

Example 1: Set properties for the tenant

PS C:\> Set-RdsTenant -Name "contoso" -FriendlyName "Contoso Apps and Desktops" -Description "Tenant for Contoso users to securely access their apps and desktops."

TenantGroupName       : Default Tenant Group
AadTenantId           : xxxx-xxxx-xxxx-xxxx-xxxx
TenantName            : contoso
Description           : Tenant for Contoso users to securely access their apps and desktops.
FriendlyName          : Contoso Apps and Desktops
SsoAdfsAuthority      : 
SsoClientId           : 
SsoClientSecret       : 
AzureSubscriptionId   : bbbb-bbbb-bbbb-bbbb

This command sets general properties for the tenant.

Parameters

-Description

A 512 character string that describes the Tenant to help administrators. Any character is allowed.

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

-FriendlyName

A 256 character string that is intended for display to end users. Any character is allowed.

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

-Name

The name of the tenant.

Type:	String
Aliases:	TenantName
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SsoAdfsAuthority

The Universal Resource Locator (URL) string pointing to your ADFS cluster, typically in the format of https://sts.contoso.com/adfs . This URL must be accessible over the Internet so Windows Virtual Desktop can coordinate single sign-on.

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

-SsoClientId

The ADFS client ID that identifies Windows Virtual Desktop application. Example: https://mrs-Prod.ame.gbl/mrs-RDInfra-prod

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

-SsoClientSecret

The ADFS client secret that was generated when registering Windows Virtual Desktop to your ADFS cluster as a client. Example: zw26ykuGzIs4sG_wSJntJvBsvgnH5J_NfakWuQJQ

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

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtTenant