JobsOperations Class

JobsOperations operations.

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

api_version

The API version. Constant value: "2016-03-01".

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.

create_or_update(resource_group_name, job_collection_name, job_name, properties=None, custom_headers=None, raw=False, **operation_config)

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.

properties

JobProperties

default value: None

Gets or sets the job properties.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobDefinition or ClientRawResponse if raw=true

Return type

JobDefinition,

ClientRawResponse

Exceptions

CloudError

delete

Deletes a job.

delete(resource_group_name, job_collection_name, job_name, custom_headers=None, raw=False, **operation_config)

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

get

Gets a job.

get(resource_group_name, job_collection_name, job_name, custom_headers=None, raw=False, **operation_config)

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobDefinition or ClientRawResponse if raw=true

Return type

JobDefinition,

ClientRawResponse

Exceptions

CloudError

list

Lists all jobs under the specified job collection.

list(resource_group_name, job_collection_name, top=None, skip=None, filter=None, custom_headers=None, raw=False, **operation_config)

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of JobDefinition

Return type

JobDefinitionPaged[JobDefinition]

Exceptions

CloudError

list_job_history

Lists job history.

list_job_history(resource_group_name, job_collection_name, job_name, top=None, skip=None, filter=None, custom_headers=None, raw=False, **operation_config)

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of JobHistoryDefinition

Return type

JobHistoryDefinitionPaged[JobHistoryDefinition]

Exceptions

CloudError

patch

Patches an existing job.

patch(resource_group_name, job_collection_name, job_name, properties=None, custom_headers=None, raw=False, **operation_config)

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.

properties

JobProperties

default value: None

Gets or sets the job properties.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

JobDefinition or ClientRawResponse if raw=true

Return type

JobDefinition,

ClientRawResponse

Exceptions

CloudError

run

Runs a job.

run(resource_group_name, job_collection_name, job_name, custom_headers=None, raw=False, **operation_config)

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.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

CloudError

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'>