Share via

Job - Stop

  • Reference
Service:
Automation
API Version:
2023-11-01

Stop the job identified by jobName.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/stop?api-version=2023-11-01

URI Parameters

Name In Required Type Description
automationAccountName
 path True

string

The name of the automation account.
jobName
 path True

string

The job name.
resourceGroupName
 path True

string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$
subscriptionId
 path True

string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version
 query True

string

Client Api Version.

Request Header

Name Required Type Description
clientRequestId

string

Identifies this specific client request.

Responses

Name Type Description
200 OK

OK
Other Status Codes

ErrorResponse

Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Stop job

Sample request

POST https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/foo/stop?api-version=2023-11-01

Sample response

Status code:
200

Definitions

ErrorResponse

Error response of an operation failure

Name Type Description
code

string

Error code
message

string

Error message indicating why the operation failed.