JobOperations Class

JobOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

JobOperations

Constructor

JobOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create	Create a job of the runbook.
get	Retrieve the job identified by job name.
get_output	Retrieve the job output identified by job name.
get_runbook_content	Retrieve the runbook content of the job identified by job name.
list_by_automation_account	Retrieve a list of jobs.
resume	Resume the job identified by jobName.
stop	Stop the job identified by jobName.
suspend	Suspend the job identified by job name.

create

Create a job of the runbook.

async create(resource_group_name: str, automation_account_name: str, job_name: str, parameters: azure.mgmt.automation.models._models_py3.JobCreateParameters, client_request_id: Optional[str] = None, **kwargs) -> azure.mgmt.automation.models._models_py3.Job

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

job_name

str

Required

The job name.

parameters

JobCreateParameters

Required

The parameters supplied to the create job operation.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

Job

Exceptions

HttpResponseError

get

Retrieve the job identified by job name.

async get(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs) -> azure.mgmt.automation.models._models_py3.Job

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

job_name

str

Required

The job name.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

Job

Exceptions

HttpResponseError

get_output

Retrieve the job output identified by job name.

async get_output(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs) -> IO

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

job_name

str

Required

The name of the job to be created.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

get_runbook_content

Retrieve the runbook content of the job identified by job name.

async get_runbook_content(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs) -> IO

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

job_name

str

Required

The job name.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

list_by_automation_account

Retrieve a list of jobs.

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, client_request_id: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.automation.models._models_py3.JobListResultV2]

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

filter

str

default value: None

The filter to apply on the operation.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobListResultV2 or the result of cls(response)

Return type

AsyncItemPaged[JobListResultV2]

Exceptions

HttpResponseError

resume

Resume the job identified by jobName.

async resume(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs) -> None

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

job_name

str

Required

The job name.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

stop

Stop the job identified by jobName.

async stop(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs) -> None

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

job_name

str

Required

The job name.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

suspend

Suspend the job identified by job name.

async suspend(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs) -> None

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

job_name

str

Required

The job name.

client_request_id

str

default value: None

Identifies this specific client request.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.automation.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\automation\\models\\__init__.py'>