Skip to main content

A wrapper for the Azure Databricks REST API

Project description

Azure Databricks API Wrapper

A Python, object-oriented wrapper for the Azure Databricks REST API 2.0

GitHub Workflow Status (branch) Coveralls github PyPI PyPI - Downloads GitHub

Installation

This package is pip installable.

pip install azure-databricks-api

Implemented APIs

As of June 25th, 2020 there are 12 different services available in the Azure Databricks API. Currently, the following services are supported by the Azure Databricks API Wrapper.

  • [x] Clusters
  • [ ] Cluster Policies (Preview)
  • [x] DBFS
  • [x] Groups (Must be Databricks admin)
  • [ ] Instance Pools
  • [ ] Jobs
  • [X] Libraries
  • [ ] MLflow
  • [ ] SCIM (Preview)
  • [ ] Secrets
  • [x] Token
  • [x] Workspace

Client Instantiation

To create the client object, you pass the Azure region your workspace is located in and the generated Personal Access Token

from azure_databricks_api import AzureDatabricksRESTClient

azure_region = '[INSERT YOUR AZURE REGION HERE]'
token = '[INSERT YOUR PERSONAL ACCESS TOKEN]' 

client = AzureDatabricksRESTClient(region=azure_region, token=token)

Clusters Client Usage

The services above are implemented as children objects of the client. For example, to pin a cluster, you can either pass the cluster_name or cluster_id to the pin() method:

client.clusters.pin(cluster_name='test_cluster_name')

The other services are implemented similarly. (e.g. client.tokens or client.groups)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for azure-databricks-api, version 0.6.2
Filename, size File type Python version Upload date Hashes
Filename, size azure_databricks_api-0.6.2-py3-none-any.whl (23.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size azure-databricks-api-0.6.2.tar.gz (22.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page