< Back

Get-AzureRmAutomationDscConfiguration

Tue Jan 29, 2019 9:32 pm

NAME Get-AzureRmAutomationDscConfiguration



SYNOPSIS

Gets DSC configurations from Automation.





SYNTAX

Get-AzureRmAutomationDscConfiguration [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-Name] <String> [-DefaultProfile

<IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-AutomationAccountName <String>

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



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the DSC configuration that this cmdlet gets.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Automation.Model.DscConfiguration







NOTES









Example 1: Get all DSC configurations



PS C:\\>Get-AzureRmAutomationDscConfiguration -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



PS C:\\>Get-AzureRmAutomationDscConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration"



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







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... figuration

Export-AzureRmAutomationDscConfiguration

Import-AzureRmAutomationDscConfiguration