Stop-AzAutomationDscNodeConfigurationDeployment

Reference

Module:: Az.Automation

Stops a DSC Node configuration deployment in Automation. It only stops the current deployment job but does not unassign already assigned node configurations.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Stop-AzAutomationDscNodeConfigurationDeployment
    -JobId <Guid>
    [-Force]
    [-PassThru]
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Stop-AzAutomationDscNodeConfigurationDeployment
    [-PassThru]
    -InputObject <NodeConfigurationDeployment>
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-AzAutomationDscNodeConfigurationDeployment 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-AzAutomationScheduledRunbook with the JobScheduleId to unassign an existing scheduled job.

Examples

Example 1: Deploy an Azure DSC node configuration in Automation

PS C:\> Stop-AzAutomationDscNodeConfigurationDeployment -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.

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
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
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
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

ps_force

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Input object for Piping

Type:	NodeConfigurationDeployment
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-JobId

Specifies the Job id of an existing deployment job.

Type:	Guid
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:	SwitchParameter
Position:	Named
Default value:	None
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
Accept pipeline input:	True
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Guid

NodeConfigurationDeployment

String

Outputs

Boolean