Edit

Share via

Get-AzVMDscExtensionStatus

  • Reference
Module:
Az.Compute

Gets the status of the DSC extension handler for a virtual machine.

Syntax

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

Description

The Get-AzVMDscExtensionStatus cmdlet gets the status of the Desired State Configuration (DSC) extension handler for a virtual machine in a resource group. When a configuration is applied this cmdlet produces output consistent with the Start-DscConfiguration cmdlet.

Examples

1:

Parameters

-DefaultProfile

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

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

-Name

Specifies the name of the Azure Resource Manager resource that represents the extension. The Set-AzVMDscExtension cmdlet sets this name to Microsoft.Powershell.DSC, which is the same value that is used by Get-AzVMDscExtensionStatus. Specify this parameter only if you changed the default name in the Set cmdlet or used a different resource name in a Resource Manager template.

Type:String
Position:2
Default value:None
Required:False
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

-VMName

Specifies the name of a virtual machine for which this cmdlet gets the DSC extension status.

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

Inputs

None

This cmdlet does not accept any input.

Outputs

PSVirtualMachineInstanceView