Remove-AzureServiceRemoteDesktopExtension
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Remove-AzureServiceRemoteDesktopExtension
Removes the cloud service Remote Desktop extension applied on one or more roles at a certain deployment slot.
Parameter Set: RemoveByRoles
Remove-AzureServiceRemoteDesktopExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-Role] <String[]> ] [ <CommonParameters>]
Parameter Set: RemoveAll
Remove-AzureServiceRemoteDesktopExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [-UninstallConfiguration] [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
This cmdlet removes the cloud service Remote Desktop extension applied on one or more roles at a certain deployment slot.
-Role<String[]>
Specifies the roles from which to remove the Remote Desktop extension. If not specified the Remote Desktop extension is removed for all roles.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServiceName<String>
Specifies the Windows Azure service name of the deployment.
Aliases |
none |
Required? |
false |
Position? |
1 |
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".
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UninstallConfiguration
If specified, uninstalls all RDP configurations from the cloud service.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Example 1
This example removes default Remote Desktop configuration for all roles from a cloud service specified by using a variable named $svc.
C:\PS>Remove-AzureServiceRemoteDesktopExtension -ServiceName $svc
Example 2
This example removes Remote Desktop configuration for a role named WebRole1.
C:\PS>Remove-AzureServiceRemoteDesktopExtension -ServiceName $svc -Role "WebRole1"