Edit

Share via

Remove-AzureRemoteAppUserDisk

  • Reference
Module:
Azure

Removes the user disk of a user from an Azure 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

Remove-AzureRemoteAppUserDisk
      [-CollectionName] <String>
      [-UserUpn] <String>
      [-Profile <AzureSMProfile>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzureRemoteAppUserDisk cmdlet removes the user disk of a user from an Azure RemoteApp collection.

Examples

Example 1: Remove a user disk

PS C:\> Remove-AzureRemoteAppUserDisk -CollectionName "Contoso01" -UserUpn "[email protected]"

This command removes the user disk of a Microsoft Entra user who has the UPN [email protected] from the collection Contoso01.

Parameters

-CollectionName

Specifies the name of the Azure RemoteApp collection.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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

-UserUpn

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

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