Skip to content

scheduler.md

Latest commit

 

History

History
74 lines (58 loc) · 2.11 KB

scheduler.md

File metadata and controls

74 lines (58 loc) · 2.11 KB
title Azure Scheduler SDK for Python
description Reference for Azure Scheduler SDK for Python
ms.date 01/05/2026
ms.topic reference
ms.devlang python
ms.service scheduler

Azure Scheduler libraries for python

Install the libraries

Management

pip install azure-mgmt-scheduler

Example

Create the management client

The following code creates an instance of the management client.

You will need to provide your subscription_id which can be retrieved from your subscription list.

See Resource Management Authentication for details on handling Azure Active Directory authentication with the Python SDK, and creating a Credentials instance.

from azure.mgmt.scheduler import SchedulerManagementClient
from azure.common.credentials import UserPassCredentials

# Replace this with your subscription id
subscription_id = 'aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e'

# See above for details on creating different types of AAD credentials
credentials = UserPassCredentials(
    'user@domain.com',	# Your user
    'my_password',		# Your password
)

scheduler_client = SchedulerManagementClient(
    credentials,
    subscription_id
)

Create a job collection

The following code creates a job collection under an existing resource group. To create or manage resource groups, see Resource Management.

from azure.mgmt.scheduler.models import JobCollectionDefinition, JobCollectionProperties, Sku

group_name = 'myresourcegroup'
job_collection_name = "myjobcollection"
scheduler_client.job_collections.create_or_update(
    group_name,
    job_collection_name,
    JobCollectionDefinition(
        location = "West US",
        properties = JobCollectionProperties(
            sku = Sku(
                name="Free"
            )
        )
    )
)
# scheduler_client is a JobCollectionDefinition instance

[!div class="nextstepaction"] Explore the Management APIs