New-AzureRemoteAppCollection

Creates an Azure RemoteApp collection.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

New-AzureRemoteAppCollection
   [-CollectionName] <String>
   [-ImageName] <String>
   [-Plan] <String>
   [[-Location] <String>]
   [-Description <String>]
   [-CustomRdpProperty <String>]
   [-ResourceType <CollectionMode>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
New-AzureRemoteAppCollection
   [-CollectionName] <String>
   [-ImageName] <String>
   [-Plan] <String>
   [[-Location] <String>]
   [-VNetName] <String>
   [-SubnetName] <String>
   [-DnsServers <String>]
   [[-Domain] <String>]
   [[-Credential] <PSCredential>]
   [-OrganizationalUnit <String>]
   [-Description <String>]
   [-CustomRdpProperty <String>]
   [-ResourceType <CollectionMode>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The New-AzureRemoteAppCollection cmdlet creates an Azure RemoteApp collection.

Examples

Example 1: Create a collection

PS C:\> New-AzureRemoteAppCollection -CollectionName "Contoso" -ImageName "Windows Server 2012 R2" -Plan Standard -Location "West US" -Description CloudOnly

This command creates an Azure RemoteApp collection.

Example 2: Create a collection using credentials

PS C:\> $cred = Get-Credential corp.contoso.com\admin
PS C:\> New-AzureRemoteAppCollection -CollectionName "ContosoHybrid" -ImageName "Windows Server 2012 R2" -Plan Standard -VNetName azureVNet -Domain Contoso.com -Credential $cred -Description Hybrid

This command creates an Azure RemoteApp collection using a credential from the Get-Credential cmdlet.

Parameters

-CollectionName

Specifies the name of the Azure RemoteApp collection.

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

-Credential

Specifies the credentials of a service account that has permission to join the Azure RemoteApp servers to your domain. To obtain a PSCredential object, use the Get-Credential cmdlet.

Type:PSCredential
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-CustomRdpProperty

Specifies custom Remote Desktop Protocal (RDP) properties which can be used to configure drive redirection and other settings. See RDP Settings for Remote Desktop Services in Windows Server (https://technet.microsoft.com/library/ff393699(v=ws.10).aspx) for details.

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

-Description

Specifies a short description for the object.

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

-DnsServers

Specifies a comma-separated list of IPv4 addresses of the DNS servers.

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

-Domain

Specifies the name of the Active Directory Domain Services domain to which to join the RD Session Host servers.

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

-ImageName

Specifies the name of the Azure RemoteApp template image.

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

-Location

Specifies the Azure region of the collection.

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

-OrganizationalUnit

Specifies the name of the organizational unit (OU) to which to join the RD Session Host servers, for example, OU=MyOu,DC=MyDomain,DC=ParentDomain,DC=com. Attributes such as OU and DC must be in uppercase. The OU cannot be changed after the collection has been created.

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

-Plan

Specifies the plan for the Azure RemoteApp collection, which may define the usage limits. Use Get-AzureRemoteAppPlan to see the plans available.

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

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceType

Specifies the resource type of the collection. The acceptable values for this parameter are: App or Desktop.

Type:CollectionMode
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubnetName

Specifies the name of the subnet in the virtual network to use to create the Azure RemoteApp collection.

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

-VNetName

Specifies the name of an Azure RemoteApp virtual network.

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