Get-RdsTenant

Module:: Microsoft.RDInfra.RDPowershell Module

Gets tenants that are authorized for the current user.

Syntax

Default (Default)

Get-RdsTenant
    [-Name <String>]
    [<CommonParameters>]

Description

The Get-RdsTenant cmdlet gets tenants that are authorized for the current user. If you do not specify a tenant, this cmdlet returns all tenants authorized for the current user.

Examples

Example 1: Get all tenants in the current context

PS C:\> Get-RdsTenant

TenantGroupName       : Default Tenant Group
AadTenantId           : aaaa-aaaa-aaaa-aaaa
TenantName            : contoso
Description           : Windows Virtual Desktop tenant for Contoso.
FriendlyName          : Contoso
SsoAdfsAuthority      :
SsoClientId           :
SsoClientSecret       :
AzureSubscriptionId   : bbbb-bbbb-bbbb-bbbb

TenantGroupName       : Default Tenant Group
AadTenantId           : aaaa-aaaa-aaaa-aaaa
TenantName            : contosoA
Description           : Windows Virtual Desktop tenant for ContosoA.
FriendlyName          : ContosoA
SsoAdfsAuthority      :
SsoClientId           :
SsoClientSecret       :
AzureSubscriptionId   :

This command gets all tenants in the current context that are authorized for the current user.

Example 2: Get a specific tenant

PS C:\> Get-RdsTenant -Name "contoso"

TenantGroupName       : Default Tenant Group
AadTenantId           : aaaa-aaaa-aaaa-aaaa
TenantName            : contoso
Description           : Windows Virtual Desktop tenant for Contoso.
FriendlyName          : Contoso
SsoAdfsAuthority      :
SsoClientId           :
SsoClientSecret       :
AzureSubscriptionId   :

This command gets the specified tenant in the current context. The tenant is displayed only if the tenant exists in the current context and the current user is properly authorized.

Parameters

-Name

The name of the tenant.

Parameter properties

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

Parameter sets

(All)

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

Share via