< Back
Get-AzureRmVMExtension
Post
NAME Get-AzureRmVMExtension
SYNOPSIS
Gets properties of Virtual Machine Extensions installed on a virtual machine.
SYNTAX
Get-AzureRmVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [[-Status]] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmVMExtension cmdlet gets properties of Virtual Machine Extensions installed on a virtual machine. Specify the name of an extension
for which to get properties. To get only the instance view of an extension, specify the Status parameter.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of an extension. This cmdlet gets properties for the extension that this parameter specifies.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Status [<SwitchParameter>]
Indicates that this cmdlet gets only the instance view of an extension.
Required? false
Position? 3
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of a virtual machine. This cmdlet gets properties of an extension from the virtual machine that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension
NOTES
Example 1: Get properties of an extension
PS C:\\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension"
This command gets properties for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group
ResourceGroup11.
Example 2: Get instance view of an extension
PS C:\\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Status
This command gets the instance view for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource
group ResourceGroup11.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mextension
Remove-AzureRmVMExtension
Set-AzureRmVMExtension
SYNOPSIS
Gets properties of Virtual Machine Extensions installed on a virtual machine.
SYNTAX
Get-AzureRmVMExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [[-Status]] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
DESCRIPTION
The Get-AzureRmVMExtension cmdlet gets properties of Virtual Machine Extensions installed on a virtual machine. Specify the name of an extension
for which to get properties. To get only the instance view of an extension, specify the Status parameter.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of an extension. This cmdlet gets properties for the extension that this parameter specifies.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Status [<SwitchParameter>]
Indicates that this cmdlet gets only the instance view of an extension.
Required? false
Position? 3
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VMName <String>
Specifies the name of a virtual machine. This cmdlet gets properties of an extension from the virtual machine that this parameter specifies.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Compute.Models.PSVirtualMachineExtension
NOTES
Example 1: Get properties of an extension
PS C:\\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension"
This command gets properties for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource group
ResourceGroup11.
Example 2: Get instance view of an extension
PS C:\\> Get-AzureRmVMExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Status
This command gets the instance view for the extension named CustomScriptExtension on the virtual machine named VirtualMachine22 in the resource
group ResourceGroup11.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... mextension
Remove-AzureRmVMExtension
Set-AzureRmVMExtension