Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Update-AzureRemoteAppCollection

Update-AzureRemoteAppCollection

microsoft.azure.commands.remoteapp.dll

Synopsis

This cmdlet updates the Microsoft Azure RemoteApp collection with the new template image.

Syntax

Update-AzureRemoteAppCollection [-CollectionName] [-ImageName] [-ForceLogoffWhenUpdateComplete] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

This cmdlet updates the Microsoft Azure RemoteApp collection with the new template image. After the update is complete, users with existing sessions will have one hour to sign out before being automatically signed out. When they sign in again, they will connect to the newly updated collection. To force users to be immediately signed out as soon as the collection is updated, specify the -ForceLogoffWhenUpdateComplete switch.

Parameters

-CollectionName <string>

Name of the Microsoft Azure RemoteApp collection.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ForceLogoffWhenUpdateComplete <SwitchParameter>

Signs users out of their existing sessions as soon as the update is complete. When users sign back in, they'll connect to the newly updated collection.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ImageName <string>

Name of Microsoft Azure RemoteApp template image.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Describes what would happen if you executed the command without actually executing the command.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples