azure.servicemanagement.schedulermanagementservice module¶
-
class
azure.servicemanagement.schedulermanagementservice.
SchedulerManagementService
(subscription_id=None, cert_file=None, host='management.core.windows.net', request_session=None, timeout=65)[source]¶ Bases:
azure.servicemanagement.servicemanagementclient._ServiceManagementClient
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.
Initializes the scheduler management service.
- subscription_id:
Subscription to manage.
- cert_file:
Path to .pem certificate file (httplib), or location of the certificate in your Personal certificate store (winhttp) in the CURRENT_USERmyCertificateName format. If a request_session is specified, then this is unused.
- host:
Live ServiceClient URL. Defaults to Azure public cloud.
- request_session:
Session object to use for http requests. If this is specified, it replaces the default use of httplib or winhttp. Also, the cert_file parameter is unused when a session is passed in. The session object handles authentication, and as such can support multiple types of authentication: .pem certificate, oauth. For example, you can pass in a Session instance from the requests library. To use .pem certificate authentication with requests library, set the path to the .pem file on the session.cert attribute.
- timeout:
Optional. Timeout for the http request, in seconds.
-
check_job_collection_name
(cloud_service_id, job_collection_id)[source]¶ 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
(cloud_service_id, label, description, geo_region)[source]¶ 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
(cloud_service_id, job_collection_id, job_id, job)[source]¶ 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
(cloud_service_id, job_collection_id, plan='Standard')[source]¶ The Create Job Collection request is specified as follows. Replace <subscription-id> with your subscription ID, <cloud-service-id> with your cloud service ID, and <job-collection-id> 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
(cloud_service_id)[source]¶ The Get Cloud Service operation gets all the resources (job collections) in the cloud service.
- cloud_service_id:
The cloud service id
-
delete_job
(cloud_service_id, job_collection_id, job_id)[source]¶ 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
(cloud_service_id, job_collection_id)[source]¶ The Delete Job Collection request is specified as follows. Replace <subscription-id> with your subscription ID, <cloud-service-id> with your cloud service ID, and <job-collection-id> 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
(cloud_service_id, job_collection_id)[source]¶ 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
(cloud_service_id)[source]¶ The Get Cloud Service operation gets all the resources (job collections) in the cloud service.
- cloud_service_id:
The cloud service id
-
get_job
(cloud_service_id, job_collection_id, job_id)[source]¶ 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.