New-RdsTenant

Reference

Module:: WindowsVirtualDesktopPowershell

Creates a tenant.

Syntax

New-RdsTenant
   [-Name] <String>
   [-AadTenantId] <String>
   [-AzureSubscriptionId] <string>
   [-FriendlyName <String>]
   [-LogAnalyticsWorkspaceId <String>]
   [-LogAnalyticsPrimaryKey <String>][-Description <String>]
   [<CommonParameters>]

Description

Creates a tenant in the current context.

Examples

Example 1: Create a tenant

PS C:\> New-RdsTenant -Name "contoso" -AadTenantId "aaaa-aaaa-aaaa-aaaa" -AzureSubscriptionId "bbbb-bbbb-bbbb-bbbb"

TenantGroupName       : Default Tenant Group
AadTenantId           : aaaa-aaaa-aaaa-aaaa
TenantName            : contoso
Description           : 
FriendlyName          : 
SsoAdfsAuthority      :
SsoClientId           :
SsoClientSecret       :
AzureSubscriptionId   : bbbb-bbbb-bbbb-bbbb

This command creates a new tenant in the current context.

Parameters

-AadTenantId

The Azure Active Directory tenant ID to be associated with the new tenant. Any users you assign to app groups within this tenant must exist in this Azure Active Directory.

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

-AzureSubscriptionId

The Azure subscription ID to be associated with the new tenant for any required Azure communications.

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

-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, which must be unique in the context.

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

Inputs

System.String

Outputs

Microsoft.RDInfra.RDManagementData.RdMgmtTenant