Get-RdsTenant
Gets tenants that are authorized for the current user.
Syntax
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.
| Type: | String |
| Aliases: | TenantName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
System.String
Outputs
Microsoft.RDInfra.RDManagementData.RdMgmtTenant