Skip to content

Latest commit

 

History

History
181 lines (138 loc) · 5.43 KB

Get-AzAutomationDscNodeConfiguration.md

File metadata and controls

181 lines (138 loc) · 5.43 KB
external help file Module Name ms.assetid online version schema content_git_url original_content_git_url
Microsoft.Azure.PowerShell.Cmdlets.Automation.dll-Help.xml
Az.Automation
89C931AE-DA81-47A7-80E4-159C36497DA0
2.0.0

Get-AzAutomationDscNodeConfiguration

SYNOPSIS

Gets metadata for DSC node configurations in Automation.

SYNTAX

ByAll (Default)

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

ByNodeConfigurationName

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

ByConfigurationName

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

DESCRIPTION

The Get-AzAutomationDscNodeConfiguration 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

Get-AzAutomationDscNodeConfiguration -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

Get-AzAutomationDscNodeConfiguration -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

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

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

-ConfigurationName

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

Type: System.String
Parameter Sets: ByConfigurationName
Aliases:

Required: True
Position: Named
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 node configuration for which this cmdlet gets metadata.

Type: System.String
Parameter Sets: ByNodeConfigurationName
Aliases: NodeConfigurationName

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: System.String
Parameter Sets: (All)
Aliases:

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

-RollupStatus

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

  • Bad
  • Good Bad: Non-Compliant Good: Compliant

Note

Even if one node is non-compliant, the overall state of the node configuration shows as bad.

Type: System.String
Parameter Sets: ByAll, ByConfigurationName
Aliases:
Accepted values: Good, Bad

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.CompilationJob

NOTES

RELATED LINKS

Import-AzAutomationDscNodeConfiguration