JobsOperations Class

JobsOperations 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

JobsOperations

Constructor

JobsOperations(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_or_update	Provisions a new job or updates an existing job.
delete	Deletes a job.
get	Gets a job.
list	Lists all jobs under the specified job collection.
list_job_history	Lists job history.
patch	Patches an existing job.
run	Runs a job.

create_or_update

Provisions a new job or updates an existing job.

async create_or_update(resource_group_name: str, job_collection_name: str, job_name: str, job: azure.mgmt.scheduler.models._models_py3.JobDefinition, **kwargs) -> azure.mgmt.scheduler.models._models_py3.JobDefinition

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

job_name

str

Required

The job name.

job

JobDefinition

Required

The job definition.

cls

callable

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

Returns

JobDefinition, or the result of cls(response)

Return type

JobDefinition

Exceptions

HttpResponseError

delete

Deletes a job.

async delete(resource_group_name: str, job_collection_name: str, job_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

job_name

str

Required

The job name.

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

get

Gets a job.

async get(resource_group_name: str, job_collection_name: str, job_name: str, **kwargs) -> azure.mgmt.scheduler.models._models_py3.JobDefinition

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

job_name

str

Required

The job name.

cls

callable

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

Returns

JobDefinition, or the result of cls(response)

Return type

JobDefinition

Exceptions

HttpResponseError

list

Lists all jobs under the specified job collection.

list(resource_group_name: str, job_collection_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.scheduler.models._models_py3.JobListResult]

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

top

int

default value: None

The number of jobs to request, in the of range of [1..100].

skip

int

default value: None

The (0-based) index of the job history list from which to begin requesting entries.

filter

str

default value: None

The filter to apply on the job state.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[JobListResult]

Exceptions

HttpResponseError

list_job_history

Lists job history.

list_job_history(resource_group_name: str, job_collection_name: str, job_name: str, top: Optional[int] = None, skip: Optional[int] = None, filter: Optional[str] = None, **kwargs) -> AsyncIterable[azure.mgmt.scheduler.models._models_py3.JobHistoryListResult]

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

job_name

str

Required

The job name.

top

int

default value: None

the number of job history to request, in the of range of [1..100].

skip

int

default value: None

The (0-based) index of the job history list from which to begin requesting entries.

filter

str

default value: None

The filter to apply on the job state.

cls

callable

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

Returns

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

Return type

AsyncItemPaged[JobHistoryListResult]

Exceptions

HttpResponseError

patch

Patches an existing job.

async patch(resource_group_name: str, job_collection_name: str, job_name: str, job: azure.mgmt.scheduler.models._models_py3.JobDefinition, **kwargs) -> azure.mgmt.scheduler.models._models_py3.JobDefinition

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

job_name

str

Required

The job name.

job

JobDefinition

Required

The job definition.

cls

callable

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

Returns

JobDefinition, or the result of cls(response)

Return type

JobDefinition

Exceptions

HttpResponseError

run

Runs a job.

async run(resource_group_name: str, job_collection_name: str, job_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

job_name

str

Required

The job name.

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.scheduler.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\scheduler\\models\\__init__.py'>