JobsOperations Class

JobsOperations 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

Name	Description
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

Name	Description
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.

create_or_update(resource_group_name: str, job_collection_name: str, job_name: str, job: 'models.JobDefinition', **kwargs: Any) -> models.JobDefinition

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_name Required	str The job name.
job Required	JobDefinition The job definition.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
JobDefinition	JobDefinition, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a job.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_name Required	str The job name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a job.

get(resource_group_name: str, job_collection_name: str, job_name: str, **kwargs: Any) -> models.JobDefinition

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_name Required	str The job name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
JobDefinition	JobDefinition, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all jobs under the specified job collection.

list(resource_group_name: str, job_collection_name: str, top: int | None = None, skip: int | None = None, filter: str | None = None, **kwargs: Any) -> Iterable['models.JobListResult']

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
top	int The number of jobs to request, in the of range of [1..100]. Default value: None
skip	int The (0-based) index of the job history list from which to begin requesting entries. Default value: None
filter	str The filter to apply on the job state. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[JobListResult]	An iterator like instance of either JobListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_job_history

Lists job history.

list_job_history(resource_group_name: str, job_collection_name: str, job_name: str, top: int | None = None, skip: int | None = None, filter: str | None = None, **kwargs: Any) -> Iterable['models.JobHistoryListResult']

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_name Required	str The job name.
top	int the number of job history to request, in the of range of [1..100]. Default value: None
skip	int The (0-based) index of the job history list from which to begin requesting entries. Default value: None
filter	str The filter to apply on the job state. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[JobHistoryListResult]	An iterator like instance of either JobHistoryListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

patch

Patches an existing job.

patch(resource_group_name: str, job_collection_name: str, job_name: str, job: 'models.JobDefinition', **kwargs: Any) -> models.JobDefinition

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_name Required	str The job name.
job Required	JobDefinition The job definition.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
JobDefinition	JobDefinition, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

run

Runs a job.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_name Required	str The job name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.scheduler.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\scheduler\\models\\__init__.py'>