Get-AzAutomationDscNodeConfigurationDeployment
Gets DSC Node configuration deployments in Automation.
Syntax
ByAll (Default)
Get-AzAutomationDscNodeConfigurationDeployment
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-Status <String>]
[-StartTime <DateTimeOffset>]
[-EndTime <DateTimeOffset>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByJobId
Get-AzAutomationDscNodeConfigurationDeployment
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
-JobId <Guid>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzAutomationDscNodeConfigurationDeployment cmdlet deploys an APS Desired State Configuration (DSC) node configuration in Azure Automation.
Examples
Example 1: Get a node configuration deployment
$deployment = Get-AzAutomationDscNodeConfigurationDeployment `
-JobId 35b14eb4-52b7-4a1d-ad62-8e9f84adc657 `
-AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01"
ResourceGroupName : ResourceGroup01
AutomationAccountName : Contoso01
JobId : 35b14eb4-52b7-4a1d-ad62-8e9f84adc657
Job : Microsoft.Azure.Commands.Automation.Model.Job
JobStatus : Running
NodeStatus : {System.Collections.Generic.Dictionary`2[System.String,System.String], System.Collections.Generic.Dictionary`2[System.String,System.String]}
NodeConfigurationName : Config01.Node1
JobSchedule :
JobScheduleId : 00000000-0000-0000-0000-000000000000
$deployment | Select-Object -ExpandProperty nodeStatus
Key Value
--- -----
WebServer Pending
WebServer2 Pending
WebServer3 Compliant
The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner.
Parameters
-AutomationAccountName
Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EndTime
End time filter.
Parameter properties
Parameter sets
ByAll
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JobId
Specifies the Job id of an existing deployment job.
Parameter properties
Type: Guid
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByJobId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
Specifies the name of a resource group in which this cmdlet compiles a configuration.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-StartTime
Start time filter.
Parameter properties
Parameter sets
ByAll
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Status
Status of the Job filter.
Parameter properties
Type: String
Default value: None Accepted values: Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating Supports wildcards: False DontShow: False
Parameter sets
ByAll
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
