Edit

Share via

Set-AzureRemoteAppCollection

Module:
Azure Module

Sets the properties of a 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

DescriptionOnly (Default) 

Set-AzureRemoteAppCollection
    [-CollectionName] <String>
    -Description <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

PlanOnly 

Set-AzureRemoteAppCollection
    [-CollectionName] <String>
    -Plan <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

DomainJoined 

Set-AzureRemoteAppCollection
    [-CollectionName] <String>
    -Credential <PSCredential>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

RdpPropertyOnly 

Set-AzureRemoteAppCollection
    [-CollectionName] <String>
    -CustomRdpProperty <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

AclLevelOnly 

Set-AzureRemoteAppCollection
    [-CollectionName] <String>
    -AclLevel <CollectionAclLevel>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Set-AzureRemoteAppCollection cmdlet sets the properties of an Azure RemoteApp collection.

Parameters

-AclLevel

Specifies the access control list (ACL) level for the collection. The acceptable values for this parameter are: Collection and Application.

Parameter properties

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

Parameter sets

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

-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

DomainJoined
Position:Named
Mandatory:True
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

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

-Description

Specifies a short description for the collection.

Parameter properties

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

Parameter sets

DescriptionOnly
Position:Named
Mandatory:True
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 defines 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

PlanOnly
Position:Named
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

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.