auth kommandogrupp

Kommandogruppen auth i Databricks CLI innehåller autentiseringsrelaterade kommandon, inklusive följande:

• Visa en lista över tillgängliga autentiseringskonfigurationsprofiler.
• Hämta information om en konfigurationsprofil för individuell autentisering.
• Använd U2M-autentisering (användar-till-dator) för att autentisera Databricks CLI med dina Azure Databricks-konton och arbetsytor.
• Hämta information om OAuth-åtkomsttoken som Databricks CLI kan ha cachelagrat.
• Få information om konfigurationen som Databricks CLI använder för att autentisera.

databricks auth describe

Beskriver konfigurationen som Databricks CLI använder för att autentisera, inklusive autentiseringsuppgifterna och källan för dessa autentiseringsuppgifter. Om inga alternativ anges auth describe följer kommandot autentiseringsmetodprioriteten.

databricks auth describe [flags]

Alternativ

--sensitive

    Inkludera känsliga fält som lösenord och token i utdata

Globala flaggor

Exempel

I följande exempel beskrivs den aktuella autentiseringskonfigurationen:

databricks auth describe

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: default
  ✓ auth_type: <authentication-type> (from <path>/<to>/.databrickscfg config file)

Om du vill ange den information om en specifik Azure Databricks-arbetsyta som används anger du --host alternativet tillsammans med arbetsytans URL.

databricks auth describe --host https://<workspace-instance-name>

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from --host flag)
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Om du vill ange att information om ett specifikt Azure Databricks-konto används anger du --host alternativet tillsammans med AZURE Databricks-kontokonsolens URL, https://accounts.azuredatabricks.net.

databricks auth describe --host <account-console-url>

Host: <account-console-url>
User: <user-name>@<domain>
AccountId: <account-id>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: <account-console-url> (from --host flag)
  ✓ account_id: <account-id>
  ✓ profile: default
  ✓ auth_type: <authentication-type>

Om du vill ange den information om en specifik Azure Databricks-konfigurationsprofil som används anger du -p alternativet eller --profile tillsammans med profilens namn:

databricks auth describe -p TEST

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: <authentication-type>
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: ******** (from <path>/<to>/.databrickscfg config file)
  ✓ profile: TEST (from --profile flag)
  ✓ auth_type: <authentication-type>

Om du vill inkludera känslig information i utdata (till exempel personliga åtkomsttoken för Azure Databricks och klienthemligheter) anger du alternativet --sensitive :

databricks auth describe --sensitive

Host: https://<workspace-instance-name>
User: <user-name>@<domain>
Authenticated with: pat
-----
Current configuration:
  ✓ host: https://<workspace-instance-name> (from <path>/<to>/.databrickscfg config file)
  ✓ token: <token-value> (from <path>/<to>/.databrickscfg config file)
  ✓ profile: <profile-name>
  ✓ auth_type: pat

databricks autentisering miljö

Hämta information om en befintlig konfigurationsprofil med namnet på profilen eller Url:en för Azure Databricks-kontokonsolen eller URL:en för Azure Databricks-arbetsytan.

databricks auth env [flags]

Information om hur du skapar en konfigurationsprofil finns i configure kommandot .

Alternativ

--host string

    Värdnamn för att hämta auth env för

--profile string

    Profil att hämta autentiseringsenv för

Globala flaggor

Exempel

I följande exempel hämtas standardautentiseringsmiljön:

databricks auth env

I följande exempel hämtas autentiseringsmiljön för en specifik värd:

databricks auth env --host https://my-workspace.cloud.databricks.com

Utdata för en profil som har konfigurerats med Azure Databricks-åtkomsttokenautentisering kan vara:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "TEST",
    "DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

I följande exempel hämtas autentiseringsmiljön för en specifik profil:

databricks auth env --profile my-test-environment

inloggning med databricks-autentisering

Logga in på en Databricks-arbetsyta eller ett konto och spara autentiseringskonfigurationen i en profil (som ~/.databrickscfg standard). Profilen kan sedan användas för att autentisera --profile andra Databricks CLI-kommandon med hjälp av flaggan. Profilen kan också användas för att autentisera andra Databricks-verktyg som stöder enhetlig Databricks-autentisering, inklusive Databricks Python, Java och Go SDK:er.

databricks auth login HOST [flags]

Det här kommandot kräver att en Databricks-värd-URL (med --host eller som ett positionsargument eller implicit härleds från det angivna profilnamnet) och att ett profilnamn (med hjälp av --profile) anges. Om du inte anger dessa värden uppmanas du att ange värden vid körning.

Även om det här kommandot alltid loggar in dig på den angivna värden beror beteendet på de befintliga profiler som du har angett i konfigurationsfilen (som ~/.databrickscfg standard):

1. Om det finns en profil med det angivna namnet och anger en värd loggas du in på värden som anges av profilen. Profilen uppdateras för att använda "databricks-cli" som autentiseringstyp om så inte var fallet tidigare.
2. Om det finns en profil med det angivna namnet men inte anger någon värd uppmanas du att ange en värd. Profilen uppdateras för att använda den angivna värden. Autentiseringstypen uppdateras till "databricks-cli" om så inte var fallet tidigare.
3. Om det finns en profil med det angivna namnet och anger en värd, men du anger en värd som använder --host (eller som HOST positions arg), uppdateras profilen för att använda den nyligen angivna värden. Autentiseringstypen uppdateras till "databricks-cli" om så inte var fallet tidigare.
4. Om det inte finns någon profil med det angivna namnet skapas en ny profil med den angivna värden. Autentiseringstypen anges till "databricks-cli".

Argumentpunkter

HOST

    Databricks-värd-URL (valfritt)

Alternativ

--configure-cluster

    Uppmaningar om att konfigurera kluster

--timeout duration

    Tidsgräns för att slutföra inloggningsutmaningen i webbläsaren (standard 1h0m0s)

Globala flaggor

Exempel

Följande exempel loggar in på en Databricks-arbetsyta:

databricks auth login

Följande exempel loggar in på en specifik Databricks-arbetsyta:

databricks auth login https://my-workspace.cloud.databricks.com

Följande exempel loggar in med en specifik profil och konfigurerar klusterinställningar:

databricks auth login --profile my-profile --configure-cluster

I följande exempel anges en anpassad tidsgräns för inloggningsprocessen:

databricks auth login --timeout 30m

databricks-autentiseringsprofiler

Visa en lista över alla tillgängliga konfigurationsprofiler (som ~/.databrickscfg standard) och kontrollera om de är giltiga profiler.

databricks auth profiles [flags]

Det här kommandot matar ut profiler i följande format:

Name            Host                Valid
DEFAULT         https://<host-url>  YES
<profile-name>  https://<host-url>  NO

För att avgöra om varje profil är giltig visar Databricks CLI arbetsytor för varje profil på kontonivå och kör ett hämta aktuellt användarkommando för varje arbetsytenivåprofil. Om kommandot lyckas visas en YES . Annars visas en NO .

Kommandots auth profiles utdata visar inga åtkomsttoken. Information om hur du visar en åtkomsttoken finns i databricks auth env.

Som standard lagras konfigurationsprofiler i filen ~/.databrickscfg på Linux eller macOS eller %USERPROFILE%\.databrickscfg i Windows. Du kan ändra standardsökvägen för den här filen genom att ange miljövariabeln DATABRICKS_CONFIG_FILE.

Information om hur du skapar konfigurationsprofiler finns i configure kommandot .

Alternativ

--skip-validate

    Om du vill hoppa över valideringen av profilerna

Globala flaggor

Exempel

I följande exempel visas alla autentiseringsprofiler:

databricks auth profiles

I följande exempel visas profiler utan att verifiera dem:

databricks auth profiles --skip-validate

databricks-autentiseringstoken

Hämta autentiseringstoken från den lokala cachen i ~/.databricks/token-cache.json. Uppdatera åtkomsttoken om den har upphört att gälla. Det här kommandot fungerar bara med U2M-autentisering (med kommandot databricks auth login ). M2M-autentisering med ett klient-ID och en hemlighet stöds inte.

databricks auth token [HOST] [flags]

För att konfigurera och ställa in OAuth-användare-till-maskin (U2M) autentisering, se OAuth-användare-till-maskin (U2M) autentisering.

Argumentpunkter

HOST

    Databricks-värd-URL (valfritt)

Alternativ

--account-id string

    Databricks-konto-ID

--timeout duration

    Tidsgräns för att hämta en token. (standard 1h0m0s)

Globala flaggor

Exempel

I följande exempel hämtas autentiseringstoken:

databricks auth token

I följande exempel hämtas autentiseringstoken för en specifik värd:

databricks auth token https://my-workspace.cloud.databricks.com

Utdata kan vara:

{
  "access_token": "<token-value>",
  "token_type": "Bearer",
  "expiry": "<token-expiration-date-time>"
}

I följande exempel anges en anpassad tidsgräns för tokenförvärv:

databricks auth token --timeout 30m

Globala flaggor

--debug

  Om felsökningsloggning ska aktiveras.

-h eller --help

    Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.

--log-file sträng

    En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.

--log-format format

    Loggformattypen, text eller json. Standardvärdet är text.

--log-level sträng

    En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.

-o, --output typ

    Kommandots utdatatyp, text eller json. Standardvärdet är text.

-p, --profile sträng

    Namnet på profilen i ~/.databrickscfg-filen som ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.

--progress-format format

    Formatet för att visa förloppsloggar: default, append, inplaceeller json

-t, --target sträng

    Om tillämpligt, paketmålet som ska användas