Microsoft Azure SDK for Python
This is the Microsoft Azure Data Bricks Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see the azure sdk python release.
Disclaimer
Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691
Getting started
Prerequisites
Install the package
pip install azure-mgmt-databricks
pip install azure-identity
Authentication
By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
AZURE_CLIENT_ID
for Azure client ID.AZURE_TENANT_ID
for Azure tenant ID.AZURE_CLIENT_SECRET
for Azure client secret.
In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID
.
With above configuration, client can be authenticated by following code:
from azure.identity import DefaultAzureCredential
from azure.mgmt.databricks import AzureDatabricksManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = AzureDatabricksManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
Examples
Code samples for this package can be found at:
Troubleshooting
Next steps
Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the
Issues
section of the project.

Release History
2.0.0 (2023-06-29)
Features Added
- Added operation group AccessConnectorsOperations
- Added operation group OutboundNetworkDependenciesEndpointsOperations
- Added operation group PrivateEndpointConnectionsOperations
- Added operation group PrivateLinkResourcesOperations
- Model OperationDisplay has a new parameter description
- Model Workspace has a new parameter disk_encryption_set_id
- Model Workspace has a new parameter encryption
- Model Workspace has a new parameter managed_disk_identity
- Model Workspace has a new parameter private_endpoint_connections
- Model Workspace has a new parameter public_network_access
- Model Workspace has a new parameter required_nsg_rules
- Model Workspace has a new parameter system_data
- Model WorkspaceCustomParameters has a new parameter load_balancer_backend_pool_name
- Model WorkspaceCustomParameters has a new parameter load_balancer_id
- Model WorkspaceCustomParameters has a new parameter nat_gateway_name
- Model WorkspaceCustomParameters has a new parameter public_ip_name
- Model WorkspaceCustomParameters has a new parameter resource_tags
- Model WorkspaceCustomParameters has a new parameter storage_account_name
- Model WorkspaceCustomParameters has a new parameter storage_account_sku_name
- Model WorkspaceCustomParameters has a new parameter vnet_address_prefix
Breaking Changes
- Client name is changed from
DatabricksClient
to AzureDatabricksManagementClient
1.1.0b2 (2022-11-18)
Features Added
- Added operation group AccessConnectorsOperations
- Added operation group OutboundNetworkDependenciesEndpointsOperations
- Model EncryptionEntitiesDefinition has a new parameter managed_disk
- Model Workspace has a new parameter disk_encryption_set_id
- Model Workspace has a new parameter managed_disk_identity
1.1.0b1 (2021-08-02)
Features
- Model WorkspaceCustomParameters has a new parameter load_balancer_backend_pool_name
- Model WorkspaceCustomParameters has a new parameter load_balancer_id
- Model WorkspaceCustomParameters has a new parameter public_ip_name
- Model WorkspaceCustomParameters has a new parameter vnet_address_prefix
- Model WorkspaceCustomParameters has a new parameter storage_account_sku_name
- Model WorkspaceCustomParameters has a new parameter nat_gateway_name
- Model WorkspaceCustomParameters has a new parameter storage_account_name
- Model WorkspaceCustomParameters has a new parameter resource_tags
- Model Workspace has a new parameter required_nsg_rules
- Model Workspace has a new parameter private_endpoint_connections
- Model Workspace has a new parameter public_network_access
- Model Workspace has a new parameter system_data
- Model Workspace has a new parameter encryption
- Added operation group PrivateLinkResourcesOperations
- Added operation group PrivateEndpointConnectionsOperations
1.0.0 (2021-03-19)
1.0.0b1 (2020-11-30)
This is beta preview version.
This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).
General breaking changes
-
Credential system has been completly revamped:
azure.common.credentials
or msrestazure.azure_active_directory
instances are no longer supported, use the azure-identity
classes instead: https://pypi.org/project/azure-identity/credentials
parameter has been renamed credential
-
The config
attribute no longer exists on a client, configuration should be passed as kwarg. Example: MyClient(credential, subscription_id, enable_logging=True)
. For a complete set of
supported options, see the parameters accept in init documentation of azure-core
-
You can't import a version
module anymore, use __version__
instead
-
Operations that used to return a msrest.polling.LROPoller
now returns a azure.core.polling.LROPoller
and are prefixed with begin_
.
-
Exceptions tree have been simplified and most exceptions are now azure.core.exceptions.HttpResponseError
(CloudError
has been removed).
-
Most of the operation kwarg have changed. Some of the most noticeable:
General new features
- Type annotations support using
typing
. SDKs are mypy ready. - This client has now stable and official support for async. Check the
aio
namespace of your package to find the async client. - This client now support natively tracing library like OpenCensus or OpenTelemetry. See this tracing quickstart for an overview.
0.1.0 (2019-04-17)