Get-AzVMDscExtension
Gets the settings of the DSC extension on a particular virtual machine.
Syntax
Get-AzVMDscExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[[-Name] <String>]
[-Status]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 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.
| 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 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.
| 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 |
-Status
Indicates that this cmdlet gets the instance view of the DSC extension.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VM
Specifies the virtual machine object the extension is on.
| Type: | PSVirtualMachine |
| Position: | Named |
| 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 DSC extension.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Outputs
VirtualMachineDscExtensionContext
