Get-AzVMCustomScriptExtension

  • Reference
Module:
Az.Compute

Gets information about a custom script extension.

Syntax

Get-AzVMCustomScriptExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [-Name] <String>
   [-Status]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Get a custom script extension

$VMCustomScriptExtension = Get-AzVMCustomScriptExtension -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

$VMCustomScriptExtension = Get-AzVMCustomScriptExtension -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.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the custom script extension about which this cmdlet gets information.

Type:String
Aliases:ExtensionName
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Status

Indicates that this cmdlet gets the instance view of the custom script extension.

Type:SwitchParameter
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VMName

Specifies the name of a virtual machine for which this cmdlet gets the custom script extension.

Type:String
Aliases:ResourceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

SwitchParameter

Outputs

VirtualMachineCustomScriptExtensionContext