external help file | Module Name | ms.assetid | online version | schema |
---|---|---|---|---|
Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml |
Az.Compute |
695F224D-DA25-49F2-916E-25DA2A48A4A7 |
2.0.0 |
Gets the status of the DSC extension handler for a virtual machine.
Get-AzVMDscExtensionStatus [-ResourceGroupName] <String> [-VMName] <String> [[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzVMDscExtensionStatus [-VM <PSVirtualMachine>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
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.
Gets the status of the DSC extension handler for a virtual machine. (autogenerated)
Get-AzVMDscExtensionStatus -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01'
The credentials, account, tenant, and subscription used for communication with azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: System.String
Parameter Sets: GetDscExtension
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Specifies the name of the resource group of the virtual machine.
Type: System.String
Parameter Sets: GetDscExtension
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Specifies the virtual machine object the extension is on.
Type: Microsoft.Azure.Commands.Compute.Models.PSVirtualMachine
Parameter Sets: VMParameterSet
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the name of a virtual machine for which this cmdlet gets the DSC extension status.
Type: System.String
Parameter Sets: GetDscExtension
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.