azure.mgmt.scheduler.operations module

class azure.mgmt.scheduler.operations.JobCollectionsOperations(client, config, serializer, deserializer)[source]

Bases: object

JobCollectionsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, job_collection_name, job_collection, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_collection (JobCollectionDefinition) – The job collection definition.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobCollectionDefinition

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

delete(resource_group_name, job_collection_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a job collection.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

disable(resource_group_name, job_collection_name, custom_headers=None, raw=False, **operation_config)[source]

Disables all of the jobs in the job collection.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

enable(resource_group_name, job_collection_name, custom_headers=None, raw=False, **operation_config)[source]

Enables all of the jobs in the job collection.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

get(resource_group_name, job_collection_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a job collection.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobCollectionDefinition

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Gets all job collections under specified resource group.

Parameters:
  • resource_group_name (str) – The resource group name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobCollectionDefinitionPaged

Raises:

CloudError

list_by_subscription(custom_headers=None, raw=False, **operation_config)[source]

Gets all job collections under specified subscription.

Parameters:
Return type:

JobCollectionDefinitionPaged

Raises:

CloudError

patch(resource_group_name, job_collection_name, job_collection, custom_headers=None, raw=False, **operation_config)[source]

Patches an existing job collection.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_collection (JobCollectionDefinition) – The job collection definition.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobCollectionDefinition

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

class azure.mgmt.scheduler.operations.JobsOperations(client, config, serializer, deserializer)[source]

Bases: object

JobsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create_or_update(resource_group_name, job_collection_name, job_name, properties=None, custom_headers=None, raw=False, **operation_config)[source]

Provisions a new job or updates an existing job.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_name (str) – The job name.
  • properties (JobProperties) – Gets or sets the job properties.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobDefinition

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Deletes a job.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_name (str) – The job name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Gets a job.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_name (str) – The job name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobDefinition

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Lists all jobs under the specified job collection.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • top (int) – The number of jobs to request, in the of range of [1..100].
  • skip (int) – The (0-based) index of the job history list from which to begin requesting entries.
  • filter (str) – The filter to apply on the job state.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobDefinitionPaged

Raises:

CloudError

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

Lists job history.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_name (str) – The job name.
  • top (int) – the number of job history to request, in the of range of [1..100].
  • skip (int) – The (0-based) index of the job history list from which to begin requesting entries.
  • filter (str) – The filter to apply on the job state.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobHistoryDefinitionPaged

Raises:

CloudError

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

Patches an existing job.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_name (str) – The job name.
  • properties (JobProperties) – Gets or sets the job properties.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

JobDefinition

Return type:

ClientRawResponse if raw=true

Raises:

CloudError

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

Runs a job.

Parameters:
  • resource_group_name (str) – The resource group name.
  • job_collection_name (str) – The job collection name.
  • job_name (str) – The job name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

None

Return type:

ClientRawResponse if raw=true

Raises:

CloudError