SchedulerManagementService Class

Note that this class is a preliminary work on Scheduler management. Since it lack a lot a features, final version can be slightly different from the current one.

Inheritance

azure.servicemanagement.servicemanagementclient._ServiceManagementClient

SchedulerManagementService

Constructor

SchedulerManagementService(subscription_id=None, cert_file=None, host='management.core.windows.net', request_session=None, timeout=65)

Parameters

subscription_id

default value: None

cert_file

default value: None

host

default value: management.core.windows.net

request_session

default value: None

timeout

default value: 65

Methods

check_job_collection_name	The Check Name Availability operation checks if a new job collection with the given name may be created, or if it is unavailable. The result of the operation is a Boolean true or false. cloud_service_id: The cloud service id job_collection_id: The name of the job_collection_id.
create_cloud_service	The Create Cloud Service request creates a new cloud service. When job collections are created, they are hosted within a cloud service. A cloud service groups job collections together in a given region. Once a cloud service has been created, job collections can then be created and contained within it. cloud_service_id: The cloud service id label: The name of the cloud service. description: The description of the cloud service. geo_region: The geographical region of the webspace that will be created.
create_job	The Create Job request creates a new job. cloud_service_id: The cloud service id job_collection_id: Name of the hosted service. job_id: The job id you wish to create. job: A dictionary of the payload
create_job_collection	The Create Job Collection request is specified as follows. Replace with your subscription ID, with your cloud service ID, and with the ID of the job collection you'd like to create. There are no "default" pre-existing job collections every job collection must be manually created. cloud_service_id: The cloud service id job_collection_id: Name of the hosted service.
delete_cloud_service	The Get Cloud Service operation gets all the resources (job collections) in the cloud service. cloud_service_id: The cloud service id
delete_job	The Delete Job request creates a new job. cloud_service_id: The cloud service id job_collection_id: Name of the hosted service. job_id: The job id you wish to create.
delete_job_collection	The Delete Job Collection request is specified as follows. Replace with your subscription ID, with your cloud service ID, and with the ID of the job collection you'd like to delete. cloud_service_id: The cloud service id job_collection_id: Name of the hosted service.
get_all_jobs	The Get All Jobs operation gets all the jobs in a job collection. The full list of jobs can be accessed by excluding any job ID in the GET call (i.e. /jobs.) The return type is cloud_service_id: The cloud service id job_collection_id: Name of the hosted service.
get_cloud_service	The Get Cloud Service operation gets all the resources (job collections) in the cloud service. cloud_service_id: The cloud service id
get_job	The Get Job operation gets the details (including the current job status) of the specified job from the specified job collection. The return type is cloud_service_id: The cloud service id job_collection_id: Name of the hosted service. job_id: The job id you wish to create.
get_job_collection	The Get Job Collection operation gets the details of a job collection cloud_service_id: The cloud service id job_collection_id: Name of the hosted service.
list_cloud_services	List the cloud services for scheduling defined on the account.

check_job_collection_name

The Check Name Availability operation checks if a new job collection with the given name may be created, or if it is unavailable. The result of the operation is a Boolean true or false.

cloud_service_id: The cloud service id

job_collection_id: The name of the job_collection_id.

check_job_collection_name(cloud_service_id, job_collection_id)

Parameters

cloud_service_id

Required

job_collection_id

Required

create_cloud_service

The Create Cloud Service request creates a new cloud service. When job collections are created, they are hosted within a cloud service. A cloud service groups job collections together in a given region. Once a cloud service has been created, job collections can then be created and contained within it.

cloud_service_id: The cloud service id

label: The name of the cloud service.

description: The description of the cloud service.

geo_region: The geographical region of the webspace that will be created.

create_cloud_service(cloud_service_id, label, description, geo_region)

Parameters

cloud_service_id

Required

label

Required

description

Required

geo_region

Required

create_job

The Create Job request creates a new job. cloud_service_id:

The cloud service id

job_collection_id: Name of the hosted service.

job_id: The job id you wish to create.

job: A dictionary of the payload

create_job(cloud_service_id, job_collection_id, job_id, job)

Parameters

cloud_service_id

Required

job_collection_id

Required

job_id

Required

job

Required

create_job_collection

The Create Job Collection request is specified as follows. Replace with your subscription ID, with your cloud service ID, and with the ID of the job collection you'd like to create. There are no "default" pre-existing job collections every job collection must be manually created.

cloud_service_id: The cloud service id

job_collection_id: Name of the hosted service.

create_job_collection(cloud_service_id, job_collection_id, plan='Standard')

Parameters

cloud_service_id

Required

job_collection_id

Required

plan

default value: Standard

delete_cloud_service

The Get Cloud Service operation gets all the resources (job collections) in the cloud service.

cloud_service_id: The cloud service id

delete_cloud_service(cloud_service_id)

Parameters

cloud_service_id

Required

delete_job

The Delete Job request creates a new job. cloud_service_id:

The cloud service id

job_collection_id: Name of the hosted service.

job_id: The job id you wish to create.

delete_job(cloud_service_id, job_collection_id, job_id)

Parameters

cloud_service_id

Required

job_collection_id

Required

job_id

Required

delete_job_collection

The Delete Job Collection request is specified as follows. Replace with your subscription ID, with your cloud service ID, and with the ID of the job collection you'd like to delete.

cloud_service_id: The cloud service id

job_collection_id: Name of the hosted service.

delete_job_collection(cloud_service_id, job_collection_id)

Parameters

cloud_service_id

Required

job_collection_id

Required

get_all_jobs

The Get All Jobs operation gets all the jobs in a job collection. The full list of jobs can be accessed by excluding any job ID in the GET call (i.e. /jobs.)

The return type is

cloud_service_id: The cloud service id

job_collection_id: Name of the hosted service.

get_all_jobs(cloud_service_id, job_collection_id)

Parameters

cloud_service_id

Required

job_collection_id

Required

get_cloud_service

The Get Cloud Service operation gets all the resources (job collections) in the cloud service.

cloud_service_id: The cloud service id

get_cloud_service(cloud_service_id)

Parameters

cloud_service_id

Required

get_job

The Get Job operation gets the details (including the current job status) of the specified job from the specified job collection.

The return type is

cloud_service_id: The cloud service id

job_collection_id: Name of the hosted service.

job_id: The job id you wish to create.

get_job(cloud_service_id, job_collection_id, job_id)

Parameters

cloud_service_id

Required

job_collection_id

Required

job_id

Required

get_job_collection

The Get Job Collection operation gets the details of a job collection

cloud_service_id: The cloud service id

job_collection_id: Name of the hosted service.

get_job_collection(cloud_service_id, job_collection_id)

Parameters

cloud_service_id

Required

job_collection_id

Required

list_cloud_services

List the cloud services for scheduling defined on the account.

list_cloud_services()