Remove-AzureServiceRemoteDesktopExtension
Syntax
Remove-AzureServiceRemoteDesktopExtension
[[-ServiceName] <String>]
[[-Slot] <String>]
[[-Role] <String[]>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Remove-AzureServiceRemoteDesktopExtension
[[-ServiceName] <String>]
[[-Slot] <String>]
[-UninstallConfiguration]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[-Profile <AzureSMProfile>]
[<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.
Required Parameters
Specifies that this cmdlet uninstalls all RDP configurations from the cloud service.
| Type: | SwitchParameter |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Optional Parameters
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies an information variable.
| Type: | String |
| Aliases: | iv |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the Azure service name of the deployment.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |