Microsoft Azure Resource Deploymentscripts Management Client Library for Python

Warnings

• gotcha This package is currently in a beta state (version 1.0.0b1). This means the API surface might change in future releases, potentially introducing breaking changes before a stable 1.0.0 release.
  Fix: Review release notes for each new beta version and anticipate potential API changes. Pin the package version to avoid unexpected updates.
• gotcha Deployment scripts create supporting resources (a storage account and a container instance) for execution and troubleshooting. While these are usually cleaned up automatically, charges may be incurred if they are not removed successfully after the script finishes.
  Fix: Monitor resource groups where deployment scripts run. Manually verify and clean up any lingering 'azscripts' prefixed storage accounts or container instances if automatic cleanup fails.
• gotcha For Azure Resource Manager (ARM) template deployment scripts, an identity is crucial. For API version 2019-10-01-preview, a managed identity is *required*. For API version 2020-10-01 or later, it is optional unless the script performs Azure-specific actions requiring authentication. Currently, only user-assigned managed identities are supported.
  Fix: Ensure that the deployment script resource in your ARM template specifies an appropriate user-assigned managed identity, especially if the script needs to interact with Azure resources. Verify the API version being used in the template (`apiVersion`).
• gotcha When embedding multi-line scripts directly into an ARM template using the `scriptContent` property, the Azure portal and Azure DevOps pipelines may fail to parse them.
  Fix: Chain PowerShell or CLI commands into a single line using semicolons (` ; `), `\r\n`, or `\n`. Alternatively, store the script in an external file (e.g., on GitHub or in a storage account) and reference it using the `primaryScriptUri` property in your ARM template.
• breaking Other `azure-mgmt-resource-*` packages have moved to only target the latest API-Version available, removing older API versions. While not explicitly stated for `azure-mgmt-resource-deploymentscripts`, this is a common breaking change pattern across the Azure SDK for Python management libraries that could affect this package in the future.
  Fix: If your application relies on a specific, non-latest API-Version, it is recommended to pin the package version. Always review release notes for stable (`1.0.0` and above) versions for API-Version targeting changes.

Install

• pip install azure-mgmt-resource-deploymentscripts Install core package
• pip install azure-identity Install Azure Identity for authentication

Imports

• DeploymentScriptsClient

  from azure.mgmt.resource.deploymentscripts import DeploymentScriptsClient

• DefaultAzureCredential

  from azure.identity import DefaultAzureCredential

Quickstart

This quickstart demonstrates how to initialize the `DeploymentScriptsClient` using `DefaultAzureCredential` for authentication. It requires the `AZURE_SUBSCRIPTION_ID` environment variable to be set, along with other Azure Active Directory environment variables for `DefaultAzureCredential` to function correctly (e.g., `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`). For local development, `az login` can often provide the necessary credentials. The example includes a placeholder for listing deployment scripts.

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.resource.deploymentscripts import DeploymentScriptsClient

# Set environment variables for authentication and subscription ID:
# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
# AZURE_SUBSCRIPTION_ID
# For local development, `DefaultAzureCredential` can often pick up credentials from `az login`.

subscription_id = os.environ.get("AZURE_SUBSCRIPTION_ID", "YOUR_SUBSCRIPTION_ID")

if subscription_id == "YOUR_SUBSCRIPTION_ID":
    print("WARNING: Please set the AZURE_SUBSCRIPTION_ID environment variable for a functional example.")

try:
    credential = DefaultAzureCredential()
    client = DeploymentScriptsClient(credential=credential, subscription_id=subscription_id)

    print(f"DeploymentScriptsClient initialized successfully for subscription: {subscription_id}")

    # Example: List deployment scripts (uncomment to run)
    # print("Listing deployment scripts...")
    # for script in client.deployment_scripts.list_by_subscription():
    #     print(f"- Script Name: {script.name}, Resource Group: {script.id.split('/')[4]}")

    # To create, update, or delete deployment scripts, refer to the official Azure SDK samples
    # for detailed usage of `client.deployment_scripts.begin_create_or_update` or other operations.

except Exception as e:
    print(f"An error occurred during client initialization or operation: {e}")
    print("Please ensure you are authenticated to Azure (e.g., `az login`) and AZURE_SUBSCRIPTION_ID is set.")