< Back
Start-AzureRmAutomationDscNodeConfigurationDeployment
Post
NAME Start-AzureRmAutomationDscNodeConfigurationDeployment
SYNOPSIS
Deploys a DSC Node configuration in Automation.
SYNTAX
Start-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-NodeConfigurationName]
<String> [-NodeName] <String[][]> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Schedule <Schedule>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Start-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-NodeConfigurationName]
<String> [-NodeName] <String[][]> [-DefaultProfile <IAzureContextContainer>] -InputObject <NodeConfigurationDeployment> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Start-AzureRmAutomationDscNodeConfigurationDeployment cmdlet deployes a 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
-Force [<SwitchParameter>]
ps_force
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <NodeConfigurationDeployment>
Input object for Piping
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-NodeConfigurationName <String>
Specifies the name of the DSC node configuration that this cmdlet deploys.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NodeName <String[][]>
Specifies the names of the nodes to which the Node Configuration would be deployed to.
Required? true
Position? 3
Default value None
Accept pipeline input? False
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
-Schedule <Schedule>
Automation Schedule object to schedule the deployment job.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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: Deploy an Azure DSC node configuration in Automation
PS C:\\> $pilot = @("WebServerPilot1", "WebServerPilot2")
PS C:\\> $prod = @("WebServerProd1", "WebServerProd2")
PS C:\\> $nodes = @($pilot, $prod)
PS C:\\> Start-AzureRmAutomationDscNodeConfigurationDeployment `
-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-000000000000
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.
Example 2: Schedule an Azure DSC node configuration deployment in Automation
PS C:\\> $sched = New-AzureRmAutomationSchedule -AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01" `
-Name "TestSchedule" `
-StartTime "23:00" `
-OneTime
PS C:\\> $pilot = @("WebServerPilot1", "WebServerPilot2")
PS C:\\> $prod = @("WebServerProd1", "WebServerProd2")
PS C:\\> $nodes = @($pilot, $prod)
PS C:\\> Start-AzureRmAutomationDscNodeConfigurationDeployment `
-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-e4b2321319e5
The 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Start-AzureRmAutomationDscCompilationJob
Import-AzureRmAutomationDscNodeConfiguration
Stop-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule
New-AzureRmAutomationSchedule
SYNOPSIS
Deploys a DSC Node configuration in Automation.
SYNTAX
Start-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-NodeConfigurationName]
<String> [-NodeName] <String[][]> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Schedule <Schedule>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Start-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-NodeConfigurationName]
<String> [-NodeName] <String[][]> [-DefaultProfile <IAzureContextContainer>] -InputObject <NodeConfigurationDeployment> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Start-AzureRmAutomationDscNodeConfigurationDeployment cmdlet deployes a 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
-Force [<SwitchParameter>]
ps_force
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <NodeConfigurationDeployment>
Input object for Piping
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-NodeConfigurationName <String>
Specifies the name of the DSC node configuration that this cmdlet deploys.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NodeName <String[][]>
Specifies the names of the nodes to which the Node Configuration would be deployed to.
Required? true
Position? 3
Default value None
Accept pipeline input? False
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
-Schedule <Schedule>
Automation Schedule object to schedule the deployment job.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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: Deploy an Azure DSC node configuration in Automation
PS C:\\> $pilot = @("WebServerPilot1", "WebServerPilot2")
PS C:\\> $prod = @("WebServerProd1", "WebServerProd2")
PS C:\\> $nodes = @($pilot, $prod)
PS C:\\> Start-AzureRmAutomationDscNodeConfigurationDeployment `
-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-000000000000
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.
Example 2: Schedule an Azure DSC node configuration deployment in Automation
PS C:\\> $sched = New-AzureRmAutomationSchedule -AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01" `
-Name "TestSchedule" `
-StartTime "23:00" `
-OneTime
PS C:\\> $pilot = @("WebServerPilot1", "WebServerPilot2")
PS C:\\> $prod = @("WebServerProd1", "WebServerProd2")
PS C:\\> $nodes = @($pilot, $prod)
PS C:\\> Start-AzureRmAutomationDscNodeConfigurationDeployment `
-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-e4b2321319e5
The 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Start-AzureRmAutomationDscCompilationJob
Import-AzureRmAutomationDscNodeConfiguration
Stop-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule
New-AzureRmAutomationSchedule