Start-AzAutomationDscNodeConfigurationDeployment
Deploys a DSC Node configuration in Automation.
Syntax
Start-AzAutomationDscNodeConfigurationDeployment
[-NodeConfigurationName] <String>
[-NodeName] <String[][]>
[-Schedule <Schedule>]
[-Force]
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-AzAutomationDscNodeConfigurationDeployment
[-NodeConfigurationName] <String>
[-NodeName] <String[][]>
-InputObject <NodeConfigurationDeployment>
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Start-AzAutomationDscNodeConfigurationDeployment cmdlet deploys a Desired State Configuration (DSC) node configuration in Azure Automation.
Examples
Example 1: Deploy an Azure DSC node configuration in Automation
$pilot = @("WebServerPilot1", "WebServerPilot2")
$prod = @("WebServerProd1", "WebServerProd2")
$nodes = @($pilot, $prod)
Start-AzAutomationDscNodeConfigurationDeployment `
-NodeConfigurationName "Config01.Node1" `
-AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01" `
-NodeName $nodes
Starting a node configuration deployment.
Starting a node configuration deployment. It will override any existing node configurations assigned to the node.
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Yes
ResourceGroupName : ResourceGroup01
AutomationAccountName : Contoso01
JobId : 35b14eb4-52b7-4a1d-ad62-8e9f84adc657
Job : Microsoft.Azure.Commands.Automation.Model.Job
JobStatus : New
NodeStatus :
NodeConfigurationName : Config01.Node1
JobSchedule :
JobScheduleId : 00000000-0000-0000-0000-000000000000The 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.
Example 2: Schedule an Azure DSC node configuration deployment in Automation
$sched = New-AzAutomationSchedule -AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01" `
-Name "TestSchedule" `
-StartTime "23:00" `
-OneTime
$pilot = @("WebServerPilot1", "WebServerPilot2")
$prod = @("WebServerProd1", "WebServerProd2")
$nodes = @($pilot, $prod)
Start-AzAutomationDscNodeConfigurationDeployment `
-NodeConfigurationName "Config01.Node1" `
-AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01" `
-NodeName $nodes `
-Schedule $sched
Starting a node configuration deployment.
Starting a node configuration deployment. It will override any existing node configurations assigned to the node.
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
ResourceGroupName : ResourceGroup01
AutomationAccountName : Contoso01
JobId : 00000000-0000-0000-0000-000000000000
Job :
JobStatus :
NodeStatus :
NodeConfigurationName : Config01.Node1
JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule
JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5The above command schedules a deployment of a DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner and will be executed based on the schedule.
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
ps_force
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Input object for Piping
| Type: | NodeConfigurationDeployment |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NodeConfigurationName
Specifies the name of the DSC node configuration that this cmdlet deploys.
| Type: | String |
| Aliases: | Name |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NodeName
Specifies the names of the nodes to which the Node Configuration would be deployed to.
| Type: | String[][] |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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 |
-Schedule
Automation Schedule object to schedule the deployment job.
| Type: | Schedule |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |