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](https://docs.azuredatabricks.net/api/latest/index.html)
### Installation
This package is pip installable.
```bash
pip install azure-databricks-cli
```
### Implemented APIs
As of September 19th, 2018 there are 9 different services available in the Azure Databricks API. Currently, the following
services are supported by the Azure Databricks API Wrapper.
* [x] Clusters
* [x] Groups
* [x] Token
* [x] Workspace
* [x] DBFS
* [ ] Jobs
* [ ] Libraries
* [ ] Secrets
* [ ] SCIM _(Preview)_
### Client Instantiation
To create the client object, you pass the Azure region your workspace is located in and the [generated Personal Access Token](https://docs.databricks.com/api/latest/authentication.html#generate-a-token)
```python
from azure_databricks_cli import AzureDatabricksRESTClient
azure_region = 'centralus'
token = '[INSERT YOUR PERSONAL ACCESS TOKEN]'
client = AzureDatabricksRESTClient(region=azure_region, token=token)
```
### Clusters Client Usage
The services above are implements as children objects of the client. For example, to pin a cluster, you can either pass the cluster_name or cluster_id:
```python
client.clusters.pin('test_cluster_name')
```
The other services are implemented similarly. (e.g. `client.tokens` or `client.groups`)
A Python, object-oriented wrapper for the [Azure Databricks REST API 2.0](https://docs.azuredatabricks.net/api/latest/index.html)
### Installation
This package is pip installable.
```bash
pip install azure-databricks-cli
```
### Implemented APIs
As of September 19th, 2018 there are 9 different services available in the Azure Databricks API. Currently, the following
services are supported by the Azure Databricks API Wrapper.
* [x] Clusters
* [x] Groups
* [x] Token
* [x] Workspace
* [x] DBFS
* [ ] Jobs
* [ ] Libraries
* [ ] Secrets
* [ ] SCIM _(Preview)_
### Client Instantiation
To create the client object, you pass the Azure region your workspace is located in and the [generated Personal Access Token](https://docs.databricks.com/api/latest/authentication.html#generate-a-token)
```python
from azure_databricks_cli import AzureDatabricksRESTClient
azure_region = 'centralus'
token = '[INSERT YOUR PERSONAL ACCESS TOKEN]'
client = AzureDatabricksRESTClient(region=azure_region, token=token)
```
### Clusters Client Usage
The services above are implements as children objects of the client. For example, to pin a cluster, you can either pass the cluster_name or cluster_id:
```python
client.clusters.pin('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.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for azure_databricks_api-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a57e5d7256b97c804bfdc1d7d2d236eb15b7108644cd7e4cc3a3580019e7d4d |
|
MD5 | 734cb6538c219d735f6ce4d6c39df88d |
|
BLAKE2b-256 | 9fee5f1d3239bada12c29491e6c28ccbc0e8201ff1d00ab0dc597732f5cd922c |