Skip to content

Latest commit

 

History

History
153 lines (115 loc) · 3.95 KB

Get-AzVMDscExtension.md

File metadata and controls

153 lines (115 loc) · 3.95 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.Compute.dll-Help.xml
Az.Compute
5B7A1BE6-F5F5-4968-BE32-7743D0E25FE3
2.0.0

Get-AzVMDscExtension

SYNOPSIS

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.

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

-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: System.String
Parameter Sets: GetDscExtension
Aliases:

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

-ResourceGroupName

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

-Status

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

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-VM

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

-VMName

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

Type: System.String
Parameter Sets: GetDscExtension
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

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

INPUTS

System.String

System.Management.Automation.SwitchParameter

OUTPUTS

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

NOTES

RELATED LINKS

Remove-AzVMDscExtension

Set-AzVMDscExtension