Edit

Get-AzAutomationDscConfiguration

  • Reference
Module:
Az.Automation

Gets DSC configurations from Automation.

Syntax

Get-AzAutomationDscConfiguration
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzAutomationDscConfiguration
   [-Name] <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzAutomationDscConfiguration cmdlet gets APS Desired State Configuration (DSC) configurations from Azure Automation.

Examples

Example 1: Get all DSC configurations

Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"

This command gets metadata for all DSC configurations in the Automation account named Contoso17.

Example 2: Get a DSC configuration by name

Get-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration"

This command gets metadata for a DSC configuration named MyConfiguration in the Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of the Automation account that contains DSC configurations that this cmdlet gets.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-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 DSC configuration that this cmdlet gets.

Type:String
Aliases:ConfigurationName
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group for which this cmdlet gets DSC configurations.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

DscConfiguration