< Back

Remove-AzureServiceRemoteDesktopExtension

Wed Jan 30, 2019 5:51 pm

NAME Remove-AzureServiceRemoteDesktopExtension



SYNOPSIS

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





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.





PARAMETERS

-ServiceName <String>

Specifies the Azure service name of the deployment.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Slot <String>

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



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Role <String[]>

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.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-UninstallConfiguration [<SwitchParameter>]

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



Required? true

Position? 2

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- 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.



RELATED LINKS

Set-AzureServiceRemoteDesktopExtension