Edit

Share via

Get-AzVMDscExtension

Module:
Az.Compute Module

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

Syntax

GetDscExtension (Default) 

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

VMParameterSet 

Get-AzVMDscExtension
    [-Status]
    [-VM <PSVirtualMachine>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzVMDscExtension 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

Get-AzVMDscExtension -ResourceGroupName "ResourceGroup002" -VMName "VM07" -Name "DSC"

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

Parameters

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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-AzVMDscExtension. Specify this parameter only if you changed the default name in the Set-AzVMDscExtension cmdlet or used a different resource name in a Resource Manager template.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetDscExtension
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetDscExtension
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Status

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-VM

Specifies the virtual machine object the extension is on.

Parameter properties

Type:PSVirtualMachine
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

VMParameterSet
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-VMName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetDscExtension
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

SwitchParameter

Outputs

VirtualMachineDscExtensionContext