Skip to content

Latest commit

 

History

History
128 lines (93 loc) · 3.42 KB

Get-AzAutomationDscConfiguration.md

File metadata and controls

128 lines (93 loc) · 3.42 KB
Raw
external help file Module Name ms.assetid online version schema
Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml
Az.Automation
BBD37C4B-BB6F-4560-BDEE-F0440EC1938A
2.0.0

Get-AzAutomationDscConfiguration

SYNOPSIS

Gets DSC configurations from Automation.

SYNTAX

ByAll (Default)

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

ByConfigurationName

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: System.String
Parameter Sets: (All)
Aliases:

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

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

Type: System.String
Parameter Sets: ByConfigurationName
Aliases: ConfigurationName

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

-ResourceGroupName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
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

OUTPUTS

Microsoft.Azure.Commands.Automation.Model.DscConfiguration

NOTES

RELATED LINKS

Export-AzAutomationDscConfiguration

Import-AzAutomationDscConfiguration