JobCollectionsOperations Class

JobCollectionsOperations operations.

Inheritance

builtins.object

JobCollectionsOperations

Constructor

JobCollectionsOperations(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 collection or updates an existing job collection.
delete	Deletes a job collection.
disable	Disables all of the jobs in the job collection.
enable	Enables all of the jobs in the 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.

create_or_update

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

create_or_update(resource_group_name, job_collection_name, job_collection, 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_collection

JobCollectionDefinition

Required

The job collection definition.

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

JobCollectionDefinition or ClientRawResponse if raw=true

Return type

JobCollectionDefinition,

ClientRawResponse

Exceptions

CloudError

delete

Deletes a job collection.

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

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

disable

Disables all of the jobs in the job collection.

disable(resource_group_name, job_collection_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

enable

Enables all of the jobs in the job collection.

enable(resource_group_name, job_collection_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name

str

Required

The resource group name.

job_collection_name

str

Required

The job collection name.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

polling

default value: True

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

AzureOperationPoller[None],

AzureOperationPoller[ClientRawResponse[None]]

Exceptions

CloudError

get

Gets a job collection.

get(resource_group_name, job_collection_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.

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

JobCollectionDefinition or ClientRawResponse if raw=true

Return type

JobCollectionDefinition,

ClientRawResponse

Exceptions

CloudError

list_by_resource_group

Gets all job collections under specified resource group.

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The resource group 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

An iterator like instance of JobCollectionDefinition

Return type

JobCollectionDefinitionPaged[JobCollectionDefinition]

Exceptions

CloudError

list_by_subscription

Gets all job collections under specified subscription.

list_by_subscription(custom_headers=None, raw=False, **operation_config)

Parameters

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 JobCollectionDefinition

Return type

JobCollectionDefinitionPaged[JobCollectionDefinition]

Exceptions

CloudError

patch

Patches an existing job collection.

patch(resource_group_name, job_collection_name, job_collection, 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_collection

JobCollectionDefinition

Required

The job collection definition.

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

JobCollectionDefinition or ClientRawResponse if raw=true

Return type

JobCollectionDefinition,

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