Update-​Azure​Remote​App​Collection

Updates an Azure RemoteApp collection with a new template image.

Syntax

Update-AzureRemoteAppCollection
      [-CollectionName] <String>
      [-ImageName] <String>
      [[-SubnetName] <String>]
      [-ForceLogoffWhenUpdateComplete]
      [-Profile <AzureSMProfile>]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Update-AzureRemoteAppCollection cmdlet updates an Azure RemoteApp collection with a new template image. After the update completes, users with existing sessions have one hour to sign out before they are automatically signed out. When they sign in again, they connect to the newly updated collection. To force users to be immediately signed out as soon as the collection is updated, specify the ForceLogoffWhenUpdateComplete parameter.

Required Parameters

-CollectionName

Specifies the name of the Azure RemoteApp collection.

Type:String
Aliases:Name
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ImageName

Specifies the name of an Azure RemoteApp template image.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-ForceLogoffWhenUpdateComplete

Indicates that this cmdlet signs users out of their existing sessions as soon as the update is complete. When users sign in again, they connect to the newly updated collection.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
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
Accept pipeline input:False
Accept wildcard characters:False
-SubnetName

Specifies the name of the subnet into which to move the collection.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False