New-RdsTenant

Module:

Microsoft.RDInfra.RDPowershell Module

Creates a tenant.

Syntax

Default (Default)

New-RdsTenant
    [-Name] <String>
    [-AadTenantId] <String>
    [-AzureSubscriptionId] <string>
    [-FriendlyName <String>]
    [-LogAnalyticsWorkspaceId <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.

Parameter properties

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

Parameter sets

(All)

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

-AzureSubscriptionId

Creates a tenant in the current context.

Parameter properties

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

Parameter sets

(All)

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

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

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

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