Edit

Share via


Set-RdsAppGroup

Sets properties for an app group.

Syntax

Default (Default)

Set-RdsAppGroup
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-Name] <String>
    [-Description <String>]
    [-FriendlyName <String>]
    [<CommonParameters>]

Description

The Set-RdsAppGroup cmdlet sets properties for the specified app group.

Examples

Example 1: Set properties for the app group

PS C:\> Set-RdsAppGroup -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "officeApps" -FriendlyName "Office" -Description "RemoteApp group for Office applications"

TenantGroupName : Microsoft Internal
TenantName      : contoso
HostPoolName    : contosoHostPool
AppGroupName    : officeApps
Description     : RemoteApp group for Office applications
FriendlyName    : Office
ResourceType    : RemoteApp

This command sets the properties for the app group.

Parameters

-Description

A 512 character string that describes the app group 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

-HostPoolName

The name of the host pool.

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

-Name

The name of the app group.

Parameter properties

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

Parameter sets

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

-TenantName

The name of the tenant.

Parameter properties

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

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.RdMgmtAppGroup