Remove-AzureVMExtension
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Remove-AzureVMExtension
Removes resource extensions from virtual machines (VMs).
Syntax
Parameter Set: RemoveByExtensionName
Remove-AzureVMExtension [-ExtensionName] <String> [-Publisher] <String> -VM <IPersistentVM> [ <CommonParameters>]
Parameter Set: RemoveAll
Remove-AzureVMExtension [-RemoveAll] -VM <IPersistentVM> [ <CommonParameters>]
Parameter Set: RemoveByReferenceName
Remove-AzureVMExtension [-ReferenceName] <String> -VM <IPersistentVM> [ <CommonParameters>]
Detailed Description
This cmdlet removes resource extensions from VMs.
Parameters
-ExtensionName<String>
Specifies the name of the extension.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Publisher<String>
Specifies the publisher of the extension.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ReferenceName<String>
Specifies the extension's reference name.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-RemoveAll
Removes all extensions.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VM<IPersistentVM>
Aliases |
InputObject |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
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
This example removes an extension with the specified name and publisher.
C:\PS>$vm = Remove-AzureVMExtension -VM $vm -ExtensionName $ext -Publisher $pub;
EXAMPLE 2
This example removes all extensions from the specified VM as stored in the variable $vm.
C:\PS>$vm = Remove-AzureVMExtension -VM $vm -RemoveAll;