Edit

Share via

Copy-AzureRemoteAppUserDisk

  • Reference
Module:
Azure

Copies the user disk of a user from one Azure RemoteApp collection to another.

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

Copy-AzureRemoteAppUserDisk
    [-SourceCollectionName] <String>
    [-DestinationCollectionName] <String>
    [-UserUpn] <String>
    [-OverwriteExistingUserDisk]
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Copy-AzureRemoteAppUserDisk cmdlet copies the user disk of a user from one Azure RemoteApp collection to another.

Examples

Example 1: Copy a user disk

PS C:\> Copy-AzureRemoteAppUserDisk -DestinationCollectionName "Contoso02" -SourceCollectionName "Contoso01" -UserUpn "PattiFuller@contoso.com" -OverwriteExistingUserDisk

This command copies the user disk of a Microsoft Entra user who has the UPN PattiFuller@contoso.com from the collection Contoso01 to the collection Contoso02. If a user disk for PattiFuller@contoso.com already exists on Contoso02, this command overwrites it.

Parameters

-DestinationCollectionName

Specifies the name of the destination Azure RemoteApp collection.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-OverwriteExistingUserDisk

Indicates that this cmdlet overwrites an existing user disk.

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

-SourceCollectionName

Specifies the name of the source Azure RemoteApp collection.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-UserUpn

Specifies the user principal name (UPN) of the user for whom this cmdlet copies the disk.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False