auth kommandogrupp

  • Artikel

Kommentar

Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. Databricks CLI finns i offentlig förhandsversion.

Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.

Med auth kommandogruppen i Databricks CLI kan du:

  • 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.

Du kör auth kommandon genom att lägga till dem i databricks auth. Om du vill visa hjälp för auth kommandot kör du databricks auth -h.

Lista konfigurationsprofiler

Om du vill hämta en lista över alla tillgängliga konfigurationsprofiler och kontrollera om de är giltiga kör auth profiles du kommandot enligt följande:

databricks auth profiles

Utdata (ellipserna representerar utelämnat innehåll, för korthet):

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

För att avgöra om varje profil är giltig kör Databricks CLI ett listarbetsytekommando 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 Hämta information om en konfigurationsprofil.

Konfigurationsprofiler lagras i filen ~/.databrickscfg på Linux eller macOS eller %USERPROFILE%\.databrickscfg i Windows som standard. Du kan ändra standardsökvägen för den här filen genom att ange miljövariabeln DATABRICKS_CONFIG_FILE. Information om hur du anger miljövariabler finns i dokumentationen för ditt operativsystem.

Information om hur du skapar konfigurationsprofiler finns i konfigurera kommandogruppen.

Hämta information om en konfigurationsprofil

Om du vill få information om en befintlig konfigurationsprofil kör auth env du kommandot, där <profile-name> representerar namnet på profilen, och <account-or-workspace-url> representerar Url:en för Azure Databricks-kontokonsolen eller URL:en för Azure Databricks-arbetsytan enligt följande:

databricks auth env --profile <profile-name>

# Or:
databricks auth env --host <account-or-workspace-url>

Dricks

Du kan trycka Tab efter --profile eller -p visa en lista över befintliga tillgängliga konfigurationsprofiler att välja mellan, i stället för att ange namnet på konfigurationsprofilen manuellt.

Här är till exempel utdata för en profil som har konfigurerats med Azure Databricks-åtkomsttokenautentisering:

{
  "env": {
    "DATABRICKS_AUTH_TYPE": "pat",
    "DATABRICKS_CONFIG_PROFILE": "<profile-name>",
    "DATABRICKS_HOST": "<workspace-url>",
    "DATABRICKS_TOKEN": "<token-value>"
  }
}

Kommentar

Om mer än en profil matchar --host värdet visas ett fel som anger att den inte kan hitta en enda matchande profil. Du kan till exempel ha en profil som bara har ett värdvärde och en annan profil som har samma värdvärde men också ett tokenvärde. I det här fallet väljer Databricks CLI inte en profil och stoppar. Om du vill hjälpa Databricks CLI att välja önskad profil kan du prova att ange ett annat --host värde. För --host värden som är url:er för kontokonsolen kan du prova att ange ett --account-id värde i stället för ett --host värde.

Information om hur du skapar en konfigurationsprofil finns i konfigurera kommandogruppen.

Autentisera med OAuth

I stället för att autentisera med Azure Databricks med hjälp av åtkomsttoken och konfigurationsprofiler kan du använda U2M-autentisering (OAuth user-to-machine). OAuth tillhandahåller token med snabbare förfallotider än personliga åtkomsttoken för Azure Databricks och ger bättre sessionsintegrering och omfång på serversidan. Eftersom OAuth-åtkomsttoken upphör att gälla på mindre än en timme minskar risken för oavsiktlig kontroll av token i källkontrollen. Se Autentisera åtkomst till Azure Databricks med ett användarkonto med OAuth (OAuth U2M).

Information om hur du konfigurerar OAuth U2M-autentisering finns i OAuth-autentisering från användare till dator (U2M).

Hämta information om OAuth-åtkomsttoken

Om du vill se information om den cachelagrade OAuth-åtkomsttoken som Databricks CLI tidigare genererade för en Azure Databricks-arbetsyta kör auth token du kommandot där <workspace-url> representerar Url:en för Azure Databricks-arbetsytan enligt följande:

databricks auth token <workspace-url>

Utdata:

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

Hämta autentiseringsinformation

Kör kommandot för att få information om konfigurationen som Databricks CLI använder för att autentisera auth describe .

Om inga alternativ anges auth describe följer kommandot standardmetoderna för klientad autentisering.

databricks auth describe

Utdata:

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>

Utdata:

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>

Utdata:

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 <profile-name>

Utdata:

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: <profile-name> (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

Utdata:

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