< Back
Stop-AzureRmAutomationDscNodeConfigurationDeployment
Post
NAME Stop-AzureRmAutomationDscNodeConfigurationDeployment
SYNOPSIS
Stops a DSC Node configuration deployment in Automation. It only stops the current deployment job but does not unassign already assigned node
configurations.
SYNTAX
Stop-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] -JobId <Guid> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] -InputObject <NodeConfigurationDeployment> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmAutomationDscNodeConfigurationDeployment cmdlet stops a deployment of a Desired State Configuration (DSC) node configuration in
Azure Automation. It stops assignment of node configuration to groups of nodes, if any are remaining to be assigned, but does not unassign already
assigned nodes. To unregister a scheduled job, please use the Unregister-AzureRmAutomationScheduledRunbook
(./Unregister-AzureRmAutomationScheduledRunbook.md)with the JobScheduleId to unassign an existing scheduled job.
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
-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
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
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
-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
NOTES
Example 1: Deploy an Azure DSC node configuration in Automation
PS C:\\> Stop-AzureRmAutomationDscNodeConfigurationDeployment -AutomationAccountName "Contoso01" -ResourceGroupName "ResourceGroup01" -JobId
00000000-0000-0000-0000-000000000000
The above command stops the DSC node configuration deployment job with the jobId passed in.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Start-AzureRmAutomationDscCompilationJob
Import-AzureRmAutomationDscNodeConfiguration
Start-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule
SYNOPSIS
Stops a DSC Node configuration deployment in Automation. It only stops the current deployment job but does not unassign already assigned node
configurations.
SYNTAX
Stop-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] [-Force] -JobId <Guid> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
Stop-AzureRmAutomationDscNodeConfigurationDeployment [-ResourceGroupName] <String> [-AutomationAccountName] <String> [-DefaultProfile
<IAzureContextContainer>] -InputObject <NodeConfigurationDeployment> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmAutomationDscNodeConfigurationDeployment cmdlet stops a deployment of a Desired State Configuration (DSC) node configuration in
Azure Automation. It stops assignment of node configuration to groups of nodes, if any are remaining to be assigned, but does not unassign already
assigned nodes. To unregister a scheduled job, please use the Unregister-AzureRmAutomationScheduledRunbook
(./Unregister-AzureRmAutomationScheduledRunbook.md)with the JobScheduleId to unassign an existing scheduled job.
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
-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
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
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
-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
NOTES
Example 1: Deploy an Azure DSC node configuration in Automation
PS C:\\> Stop-AzureRmAutomationDscNodeConfigurationDeployment -AutomationAccountName "Contoso01" -ResourceGroupName "ResourceGroup01" -JobId
00000000-0000-0000-0000-000000000000
The above command stops the DSC node configuration deployment job with the jobId passed in.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Start-AzureRmAutomationDscCompilationJob
Import-AzureRmAutomationDscNodeConfiguration
Start-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeployment
Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule