Set-RdsTenant

Module:

Microsoft.RDInfra.RDPowershell Module

Sets properties for a tenant.

Syntax

Default (Default)

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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FriendlyName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The name of the tenant.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	TenantName

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SsoClientId

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtTenant