Azure Scheduler Management Client Library

7.0.0 · abandoned · verified Sat Apr 11

The `azure-mgmt-scheduler` library is the Microsoft Azure Scheduler Management Client Library for Python. It provides programmatic access to manage Azure Scheduler resources. While the library's current version is 7.0.0, the underlying Azure Scheduler service has been retired by Microsoft. This package received security fixes until January 31, 2022, and is no longer actively maintained for new features or non-security bug fixes.

Warnings

breaking The underlying Azure Scheduler service has been retired by Microsoft as of January 31, 2022. This library is no longer maintained for new features or non-security bug fixes.
Fix: Migrate existing schedules to Azure Logic Apps, which is the recommended replacement. Use the `azure-mgmt-logic` library for programmatic management of Logic Apps.
breaking Authentication methods changed significantly in version 7.0.0. Older `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported. The `credentials` parameter was renamed to `credential`.
Fix: Update your authentication code to use classes like `DefaultAzureCredential` from `azure.identity`. Pass the credential object directly to the client constructor, e.g., `SchedulerManagementClient(credential, subscription_id)`.
gotcha Attempting to create, update, or retrieve Azure Scheduler resources using this library will almost certainly result in API errors (e.g., HTTP 404 Not Found, 410 Gone) because the backend service is no longer available.
Fix: Do not use this library for active schedule management. For any lingering archival or diagnostic needs, be prepared for consistent API failures.
breaking In version 7.0.0, operations that previously returned a `msrest.polling.LROPoller` now return an `azure.core.polling.LROPoller` and are prefixed with `begin_`. The exceptions tree has been simplified, and most exceptions are now `azure.core.exceptions.HttpResponseError` (CloudError has been removed).
Fix: Update code to use `begin_` prefixed methods for long-running operations and handle `azure.core.exceptions.HttpResponseError` for general API errors. Adjust polling logic as per `azure.core` patterns.

Install

pip install azure-mgmt-scheduler Install latest version

Imports

SchedulerManagementClient
```
from azure.mgmt.scheduler import SchedulerManagementClient
```
This is the primary client for interacting with Azure Scheduler.

Quickstart

This quickstart demonstrates how to instantiate the `SchedulerManagementClient` using `azure.identity.DefaultAzureCredential`. It's crucial to note that the Azure Scheduler service has been retired, so most operations will fail. This example serves primarily to show the client initialization pattern.

from azure.identity import DefaultAzureCredential
from azure.mgmt.scheduler import SchedulerManagementClient
import os

# Your Azure subscription ID (get it from environment variable or replace directly)
subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "YOUR_SUBSCRIPTION_ID")

# Authenticate with Azure (DefaultAzureCredential tries multiple authentication methods)
# Ensure AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET (for service principal)
# or AZURE_USERNAME, AZURE_PASSWORD (for developer login) are set as environment variables
# or use other credential types from azure.identity.
credential = DefaultAzureCredential()

# Create the Scheduler management client
try:
    scheduler_client = SchedulerManagementClient(credential, subscription_id)
    print(f"SchedulerManagementClient created for subscription: {subscription_id}")
    print("\nWARNING: The Azure Scheduler service has been retired as of January 31, 2022.")
    print("Any operations attempted with this client (e.g., listing job collections) will likely fail.")
    # Example: Attempt to list job collections (this will likely fail)
    # for collection in scheduler_client.job_collections.list_by_subscription():
    #     print(f"Job Collection: {collection.name}")
except Exception as e:
    print(f"Error creating or using SchedulerManagementClient: {e}")
    print("This is expected behavior as the underlying service is retired.")

view raw JSON →