databricks-azure-ad-sync-provider


Namedatabricks-azure-ad-sync-provider JSON
Version 0.1.4 PyPI version JSON
download
home_page
SummaryDefault template for PDM package
upload_time2024-02-09 15:05:31
maintainer
docs_urlNone
author
requires_python==3.9.*
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # databricks-azure-ad-sync-provider

`databricks-azure-ad-sync-provider` is a package that allows to sync users, groups and service principals from Microsoft Entra ID to Databricks.

## Requirements

`databricks-azure-ad-sync-provider` is built on top of:

* python 3.9+

#### Authentication

Authenticate to you Microsoft Entra ID and Azure Databricks to use the package.
There are multiple ways available for that, we suggest the following:

**1. With Azure CLI**

+ Authenticate to your Azure account on your machine with `az login`.
+ Specify necessary variables
  1. With environment variables: Setup for `DATABRICKS_HOST` and `DATABRICKS_ACCOUNT_ID`
  2. With a `.databrickscfg` file: Create the `.databrickscfg` file (~ for Linux or macOS, and %USERPROFILE% for Windows) containing the
     following info:

  ```
  [DEFAULT]
  host = https://accounts.azuredatabricks.net/
  account_id = <Databricks account id>
  ```

**2. With Microsoft Entra ID service principal:**

+ Create a service principal in Microsoft Entra ID and add it to Azure Databricks and grant it target permissions (see [reference documentation](https://learn.microsoft.com/en-gb/azure/databricks/dev-tools/service-principals)).
+ Specify necessary variables

  1. With environment variables

     - For Azure: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET (see [Microsoft Entra ID authentication](https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/identity/service-principal?pivots=platform-azcli))
     - For Databricks: DATABRICKS_HOST, DATABRICKS_ACCOUNT_ID, DATABRICKS_CLIENT_ID, DATABRICKS_CLIENT_SECRET (see [Databricks authentication](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#language-Environment))
  2. With a `.databrickscfg` file: Create a .databrickscfg file (~ for Linux or macOS, and %USERPROFILE% for Windows) containing the following info:

  ```
  [DEFAULT]
  host = https://accounts.azuredatabricks.net/
  account_id = <Databricks account id>
  azure_tenant_id = <Azure tenant id>
  azure_client_id = <Azure service principal application ID>
  azure_client_secret = <Azure service principal secret>
  ```

## Installation

```
pip install databricks-azure-ad-sync-provider
```

## Usage

**Sync execution**
  ```
<fct_name> -f/--file <path to your yaml file> -d/--delete
  ```
+ -f/--file <path to your yaml file>:  it's required to provide the object ID(s) of Azure groups and (optionally) exclude object ID(s) in a yaml file (ex. see test.yaml).
+ -d/--delete: If provided, this enablew to delete identities in Databricks.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "databricks-azure-ad-sync-provider",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "==3.9.*",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "Nicolas <nicolas.jankelevitch@dataroots.io>, Bram <bram.decoster@dataroots.io>, Adrien <adrien@dataroots.io>, Xuyao <xuyao@dataroots.io>, Sam <sam@dataroots.io>",
    "download_url": "https://files.pythonhosted.org/packages/7f/78/16a0964f16db7733d2b030664e17bd225592df788a5099709197815a40aa/databricks-azure-ad-sync-provider-0.1.4.tar.gz",
    "platform": null,
    "description": "# databricks-azure-ad-sync-provider\n\n`databricks-azure-ad-sync-provider` is a package that allows to sync users, groups and service principals from Microsoft Entra ID to Databricks.\n\n## Requirements\n\n`databricks-azure-ad-sync-provider` is built on top of:\n\n* python 3.9+\n\n#### Authentication\n\nAuthenticate to you Microsoft Entra ID and Azure Databricks to use the package.\nThere are multiple ways available for that, we suggest the following:\n\n**1. With Azure CLI**\n\n+ Authenticate to your Azure account on your machine with `az login`.\n+ Specify necessary variables\n  1. With environment variables: Setup for `DATABRICKS_HOST` and `DATABRICKS_ACCOUNT_ID`\n  2. With a `.databrickscfg` file: Create the `.databrickscfg` file (~ for Linux or macOS, and %USERPROFILE% for Windows) containing the\n     following info:\n\n  ```\n  [DEFAULT]\n  host = https://accounts.azuredatabricks.net/\n  account_id = <Databricks account id>\n  ```\n\n**2. With Microsoft Entra ID service principal:**\n\n+ Create a service principal in Microsoft Entra ID and add it to Azure Databricks and grant it target permissions (see [reference documentation](https://learn.microsoft.com/en-gb/azure/databricks/dev-tools/service-principals)).\n+ Specify necessary variables\n\n  1. With environment variables\n\n     - For Azure: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET (see [Microsoft Entra ID authentication](https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/identity/service-principal?pivots=platform-azcli))\n     - For Databricks: DATABRICKS_HOST, DATABRICKS_ACCOUNT_ID, DATABRICKS_CLIENT_ID, DATABRICKS_CLIENT_SECRET (see [Databricks authentication](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html#language-Environment))\n  2. With a `.databrickscfg` file: Create a .databrickscfg file (~ for Linux or macOS, and %USERPROFILE% for Windows) containing the following info:\n\n  ```\n  [DEFAULT]\n  host = https://accounts.azuredatabricks.net/\n  account_id = <Databricks account id>\n  azure_tenant_id = <Azure tenant id>\n  azure_client_id = <Azure service principal application ID>\n  azure_client_secret = <Azure service principal secret>\n  ```\n\n## Installation\n\n```\npip install databricks-azure-ad-sync-provider\n```\n\n## Usage\n\n**Sync execution**\n  ```\n<fct_name> -f/--file <path to your yaml file> -d/--delete\n  ```\n+ -f/--file <path to your yaml file>:  it's required to provide the object ID(s) of Azure groups and (optionally) exclude object ID(s) in a yaml file (ex. see test.yaml).\n+ -d/--delete: If provided, this enablew to delete identities in Databricks.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Default template for PDM package",
    "version": "0.1.4",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a389b46969ecab5f43199f4f9a0968efa83a76644b2d61957a6082b0ab9792d5",
                "md5": "0ecef894bc47d9b66584d39858b78bcf",
                "sha256": "2ee5fa8dffed9f765a18909b9c189a1d2b3d3addaadb9d1f64e998de6109a534"
            },
            "downloads": -1,
            "filename": "databricks_azure_ad_sync_provider-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0ecef894bc47d9b66584d39858b78bcf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "==3.9.*",
            "size": 13069,
            "upload_time": "2024-02-09T15:05:29",
            "upload_time_iso_8601": "2024-02-09T15:05:29.761306Z",
            "url": "https://files.pythonhosted.org/packages/a3/89/b46969ecab5f43199f4f9a0968efa83a76644b2d61957a6082b0ab9792d5/databricks_azure_ad_sync_provider-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7f7816a0964f16db7733d2b030664e17bd225592df788a5099709197815a40aa",
                "md5": "a6a5c45f53215f5df0d44176831fa33f",
                "sha256": "8eaceb830579f275b132e69ff619b3208a4ee639582db9b3805eba3506075547"
            },
            "downloads": -1,
            "filename": "databricks-azure-ad-sync-provider-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "a6a5c45f53215f5df0d44176831fa33f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "==3.9.*",
            "size": 12450,
            "upload_time": "2024-02-09T15:05:31",
            "upload_time_iso_8601": "2024-02-09T15:05:31.681569Z",
            "url": "https://files.pythonhosted.org/packages/7f/78/16a0964f16db7733d2b030664e17bd225592df788a5099709197815a40aa/databricks-azure-ad-sync-provider-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-09 15:05:31",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "databricks-azure-ad-sync-provider"
}
        
Elapsed time: 0.19891s