JobCollectionsOperations Class

JobCollectionsOperations 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

JobCollectionsOperations

Constructor

JobCollectionsOperations(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

begin_delete	Deletes a job collection.
begin_disable	Disables all of the jobs in the job collection.
begin_enable	Enables all of the jobs in the job collection.
create_or_update	Provisions a new job collection or updates an existing job collection.
get	Gets a job collection.
list_by_resource_group	Gets all job collections under specified resource group.
list_by_subscription	Gets all job collections under specified subscription.
patch	Patches an existing job collection.

begin_delete

Deletes a job collection.

begin_delete(resource_group_name: str, job_collection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_disable

Disables all of the jobs in the job collection.

begin_disable(resource_group_name: str, job_collection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_enable

Enables all of the jobs in the job collection.

begin_enable(resource_group_name: str, job_collection_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

create_or_update

Provisions a new job collection or updates an existing job collection.

create_or_update(resource_group_name: str, job_collection_name: str, job_collection: 'models.JobCollectionDefinition', **kwargs: Any) -> models.JobCollectionDefinition

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_collection Required	JobCollectionDefinition The job collection definition.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a job collection.

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

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Gets all job collections under specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable['models.JobCollectionListResult']

Parameters

Name	Description
resource_group_name Required	str The resource group name.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Gets all job collections under specified subscription.

list_by_subscription(**kwargs: Any) -> Iterable['models.JobCollectionListResult']

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

patch

Patches an existing job collection.

patch(resource_group_name: str, job_collection_name: str, job_collection: 'models.JobCollectionDefinition', **kwargs: Any) -> models.JobCollectionDefinition

Parameters

Name	Description
resource_group_name Required	str The resource group name.
job_collection_name Required	str The job collection name.
job_collection Required	JobCollectionDefinition The job collection definition.

Keyword-Only Parameters

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

Returns

Type	Description
JobCollectionDefinition	JobCollectionDefinition, 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'>