Remove-AzureServiceExtension
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Remove-AzureServiceExtension
This cmdlet removes given cloud service extensions that are applied on a deployment.
Syntax
Parameter Set: RemoveByRoles
Remove-AzureServiceExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-Role] <String[]> ] [-ExtensionName] <String> [-ProviderNamespace] <String> [ <CommonParameters>]
Parameter Set: RemoveAllRoles
Remove-AzureServiceExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [-ExtensionName] <String> [-ProviderNamespace] <String> [-UninstallConfiguration] [ <CommonParameters>]
Detailed Description
This cmdlet removes given cloud service extensions that are applied on a deployment.
Parameters
-ExtensionName<String>
The Extension Name.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ProviderNamespace<String>
The Extension Provider Namespace.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Role<String[]>
An optional array of roles to specify the extension for. If not specified the extension is applied as the default configuration for all roles.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServiceName<String>
The cloud service name.
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 uninstall all configurations from the cloud service.
Aliases |
none |
Required? |
true |
Position? |
5 |
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.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Remove the existing RDP extension applied on all roles.
C:\PS>Remove-AzureServiceExtension -ServiceName $svc -Slot Production -ExtensionName RDP -ProviderNamespace Microsoft.Windows.Azure.Extensions
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
Remove the existing RDP extension applied on all roles, and uninstall it from the cloud service.
C:\PS>Remove-AzureServiceExtension -ServiceName $svc -Slot Production -ExtensionName RDP -ProviderNamespace Microsoft.Windows.Azure.Extensions -UninstallConfiguration