< Back
Get-AzureRmAutomationDscNodeConfigurationDeployment
Post
NAME Get-AzureRmAutomationDscNodeConfigurationDeployment
SYNOPSIS
Gets DSC Node configuration deployments in Automation.
SYNTAX
Get-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] [-EndTime <DateTimeOffset>] [-StartTime <DateTimeOffset>] [-Status {Completed | Failed | Queued | Starting | Resuming |
Running | Stopped | Stopping | Suspended | Suspending | Activating}] [<CommonParameters>]
Get-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] -JobId <Guid> [<CommonParameters>]
DESCRIPTION
The Get-AzureRmAutomationDscNodeConfigurationDeployment cmdlet deployes an APS Desired State Configuration (DSC) node configuration in Azure
Automation.
PARAMETERS
-AutomationAccountName <String>
Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles.
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
-EndTime <DateTimeOffset>
End time filter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobId <Guid>
Specifies the Job id of an existing deployment job.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group in which this cmdlet compiles a configuration.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StartTime <DateTimeOffset>
Start time filter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Status <String>
Status of the Job filter.
Required? false
Position? named
Default value None
Accept pipeline input? False
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.NodeConfigurationDeployment
NOTES
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 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Start-AzureRmAutomationDscCompilationJob
Import-AzureRmAutomationDscNodeConfiguration
Start-AzureRmAutomationDscNodeConfigurationDeployment
Stop-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule
SYNOPSIS
Gets DSC Node configuration deployments in Automation.
SYNTAX
Get-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] [-EndTime <DateTimeOffset>] [-StartTime <DateTimeOffset>] [-Status {Completed | Failed | Queued | Starting | Resuming |
Running | Stopped | Stopping | Suspended | Suspending | Activating}] [<CommonParameters>]
Get-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] -JobId <Guid> [<CommonParameters>]
DESCRIPTION
The Get-AzureRmAutomationDscNodeConfigurationDeployment cmdlet deployes an APS Desired State Configuration (DSC) node configuration in Azure
Automation.
PARAMETERS
-AutomationAccountName <String>
Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles.
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
-EndTime <DateTimeOffset>
End time filter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobId <Guid>
Specifies the Job id of an existing deployment job.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group in which this cmdlet compiles a configuration.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-StartTime <DateTimeOffset>
Start time filter.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Status <String>
Status of the Job filter.
Required? false
Position? named
Default value None
Accept pipeline input? False
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.NodeConfigurationDeployment
NOTES
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 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Start-AzureRmAutomationDscCompilationJob
Import-AzureRmAutomationDscNodeConfiguration
Start-AzureRmAutomationDscNodeConfigurationDeployment
Stop-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule