Get-AzureRmAutomationDscNodeConfigurationDeployment
Gets DSC Node configuration deployments 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-AzureRmAutomationDscNodeConfigurationDeployment
[-Status <String>]
[-StartTime <DateTimeOffset>]
[-EndTime <DateTimeOffset>]
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmAutomationDscNodeConfigurationDeployment
-JobId <Guid>
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzureRmAutomationDscNodeConfigurationDeployment cmdlet deployes an APS Desired State Configuration (DSC) node configuration in Azure Automation.
Examples
Example 1: Get a node configuration deployment
PS C:\> $deployment = Get-AzureRmAutomationDscNodeConfigurationDeployment `
-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
PS C:\> $deployment | Select -expand nodeStatus
Key Value
--- -----
WebServer Pending
WebServer2 Pending
WebServer3 CompliantThe 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.
| Type: | String |
| Position: | 1 |
| 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 |
-EndTime
End time filter.
| Type: | Nullable<T>[DateTimeOffset] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobId
Specifies the Job id of an existing deployment job.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of a resource group in which this cmdlet compiles a configuration.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StartTime
Start time filter.
| Type: | Nullable<T>[DateTimeOffset] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Status
Status of the Job filter.
| Type: | String |
| Accepted values: | Completed, Failed, Queued, Starting, Resuming, Running, Stopped, Stopping, Suspended, Suspending, Activating |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |