Get-AzureRmVMCustomScriptExtension

NAME Get-AzureRmVMCustomScriptExtension



SYNOPSIS

Gets information about a custom script extension.





SYNTAX

Get-AzureRmVMCustomScriptExtension [-ResourceGroupName] <String> [-VMName] <String> [-Name] <String> [[-Status]] [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmVMCustomScriptExtension cmdlet gets information about a custom script Virtual Machine Extension on a virtual machine.





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 the custom script extension about which this cmdlet gets information.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group of the virtual machine.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Status [<SwitchParameter>]

Indicates that this cmdlet gets the instance view of the custom script 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 for which this cmdlet gets the custom script extension.



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.VirtualMachineCustomScriptExtensionContext







NOTES









Example 1: Get a custom script extension



PS C:\\> $VMCustomScriptExtension = Get-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name

"ContosoCustomScript"



This command gets the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07.





Example 2: Get the instance view of a custom script extension



PS C:\\> $VMCustomScriptExtension = Get-AzureRmVMCustomScriptExtension -ResourceGroupName "ResourceGroup11" -VMName "VirtualMachine07" -Name

"ContosoCustomScript" -Status



This command gets the instance view of the custom script extension named ContosoCustomScript for the virtual machine named VirtualMachine07.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... textension

Get-AzureRmVMAccessExtension

Get-AzureRmVMExtension

Get-AzureRmVMExtensionImage