Edit

Share via

New-AzureRemoteAppCollection

Module:
Azure Module

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

AllParameterSets (Default) 

New-AzureRemoteAppCollection
    [-CollectionName] <String>
    [-ImageName] <String>
    [-Plan] <String>
    [[-Location] <String>]
    [-Description <String>]
    [-CustomRdpProperty <String>]
    [-ResourceType <CollectionMode>]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

AzureVNet 

New-AzureRemoteAppCollection
    [-CollectionName] <String>
    [-ImageName] <String>
    [-Plan] <String>
    [[-Location] <String>]
    [-VNetName] <String>
    [-SubnetName] <String>
    [[-Domain] <String>]
    [[-Credential] <PSCredential>]
    [-DnsServers <String>]
    [-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.

Parameter properties

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

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

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

-CustomRdpProperty

Specifies custom Remote Desktop Protocol (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.

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:True
Value from remaining arguments:False

-Description

Specifies a short description for the object.

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:True
Value from remaining arguments:False

-DnsServers

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

Parameter properties

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

Parameter sets

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

-Domain

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

Parameter properties

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

Parameter sets

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

-ImageName

Specifies the name of the Azure RemoteApp template image.

Parameter properties

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

Parameter sets

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

-Location

Specifies the Azure region of the collection.

Parameter properties

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

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

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

-Plan

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

Parameter properties

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

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:AzureSMProfile
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

-ResourceType

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

Parameter properties

Type:CollectionMode
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:True
Value from remaining arguments:False

-SubnetName

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

Parameter properties

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

Parameter sets

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

-VNetName

Specifies the name of an Azure RemoteApp virtual network.

Parameter properties

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

Parameter sets

AzureVNet
Position:4
Mandatory:True
Value from pipeline:False
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.