Get-​Azure​Rm​VM​Dsc​Extension

Gets the settings of the DSC extension on a particular virtual machine.

Syntax

Get-AzureRmVMDscExtension
   [-ResourceGroupName] <String>
   [-VMName] <String>
   [[-Name] <String>]
   [-Status]
   [<CommonParameters>]

Description

The Get-AzureRmVMDscExtension cmdlet gets the settings of the Desired State Configuration (DSC) extension on a particular virtual machine.

Examples

Example 1: Get the settings of a DSC extension

PS C:\>Get-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup002" -VMName "VM07" -Name "DSC"

This command gets the settings of extension named DSC on the virtual machine named VM07.

Required Parameters

-ResourceGroupName

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

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VMName

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

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Name

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

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Status

Indicates that this cmdlet gets the instance view of the DSC extension.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.Compute.Extension.DSC.VirtualMachineDscExtensionContext