Edit

Share via

Remove-AzureServiceRemoteDesktopExtension

  • Reference
Module:
Azure

Removes the cloud service remote desktop extension applied on all roles or named roles at a specified deployment slot.

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.

Important

Cloud Services (classic) is now deprecated for new customers and will be retired on August 31st, 2024 for all customers. New deployments should use the new Azure Resource Manager based deployment model Azure Cloud Services (extended support).

Syntax

Remove-AzureServiceRemoteDesktopExtension
      [[-ServiceName] <String>]
      [[-Slot] <String>]
      [[-Role] <String[]>]
      [-Profile <AzureSMProfile>]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]
Remove-AzureServiceRemoteDesktopExtension
      [[-ServiceName] <String>]
      [[-Slot] <String>]
      [-UninstallConfiguration]
      [-Profile <AzureSMProfile>]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [<CommonParameters>]

Description

The Remove-AzureServiceRemoteDesktopExtension cmdlet removes the cloud service remote desktop extension applied on all roles or named roles at a certain deployment slot.

Examples

Example 1: Remove the remote desktop extension

PS C:\> Remove-AzureServiceRemoteDesktopExtension -ServiceName $svc

This command removes the remote desktop extension.

Example 2: Remove the remote desktop extension from a specified role

PS C:\> Remove-AzureServiceRemoteDesktopExtension -ServiceName $svc -Role "WebRole1"

This command removes the remote desktop extension from a specified role.

Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
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

-Role

Specifies an optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop configuration is applied as the default configuration for all roles.

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

-ServiceName

Specifies the Azure service name of the deployment.

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

-Slot

Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".

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

-UninstallConfiguration

Specifies that this cmdlet uninstalls all RDP configurations from the cloud service.

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