Edit

Share via

Get-AzureRmAutomationDscNodeConfiguration

  • Reference
Module:
AzureRM.Automation

Gets metadata for DSC node configurations in Automation.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmAutomationDscNodeConfiguration
   [-RollupStatus <String>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmAutomationDscNodeConfiguration
   -Name <String>
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmAutomationDscNodeConfiguration
   -ConfigurationName <String>
   [-RollupStatus <String>]
   [-ResourceGroupName] <String>
   [-AutomationAccountName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmAutomationDscNodeConfiguration cmdlet gets metadata for APS Desired State Configuration (DSC) node configurations in Azure Automation. Automation stores DSC node configuration as a Managed Object Format (MOF) configuration document.

Examples

Example 1: Get all DSC node configurations

PS C:\>Get-AzureRmAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17"

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

Example 2: Get all DSC node configurations for a DSC configuration

PS C:\>Get-AzureRmAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -ConfigurationName "ContosoConfiguration"

This command gets metadata for all DSC node configurations in the Automation account named Contoso17 that the DSC configuration named ContosoConfiguration generated.

Example 3: Get a DSC node configuration by name

PS C:\>Get-AzureRmAutomationDscNodeConfiguration -ResourceGroupName "ResourceGroup03" -AutomationAccountName "Contoso17" -Name "ContosoConfiguration.webserver"

This command gets metadata for a DSC node configuration with the name ContosoConfiguration.webserver in the Automation account named Contoso17.

Parameters

-AutomationAccountName

Specifies the name of an Automation account that contains the DSC node configurations for which this cmdlet gets metadata.

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

-ConfigurationName

Specifies the name of DSC configuration for which this cmdlet gets node configuration metadata.

Type:String
Position:Named
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:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of the DSC node configuration for which this cmdlet gets metadata.

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

-ResourceGroupName

Specifies the name of a resource group. This cmdlet gets metadata for DSC node configurations in the resource group that this parameter specifies.

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

-RollupStatus

Specifies the rollup status of DSC node configurations that this cmdlet gets. Valid values are:

  • Bad
  • Good
Type:String
Accepted values:Good, Bad
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

CompilationJob