Delen via

auth opdrachtgroep

  • Artikel

Notitie

Deze informatie is van toepassing op Databricks CLI-versies 0.205 en hoger. De Databricks CLI bevindt zich in openbare preview.

Databricks CLI-gebruik is onderhevig aan de Databricks-licentie en de privacyverklaring van Databricks, met inbegrip van alle bepalingen voor gebruiksgegevens.

Met auth de opdrachtgroep in de Databricks CLI kunt u het volgende doen:

  • Geef alle beschikbare configuratieprofielen voor verificatie weer.
  • Informatie ophalen over een configuratieprofiel voor afzonderlijke verificatie.
  • Gebruik OAuth-gebruikers-naar-machine-verificatie (U2M) om de Databricks CLI te verifiëren met uw Azure Databricks-accounts en -werkruimten.
  • Informatie ophalen over OAuth-toegangstokens die de Databricks CLI mogelijk in de cache heeft opgeslagen.
  • Meer informatie over de configuratie die de Databricks CLI gebruikt om te verifiëren.

U voert opdrachten uit auth door ze toe te voegen aan databricks auth. Als u help voor de auth opdracht wilt weergeven, voert u het volgende uit databricks auth -h.

Configuratieprofielen weergeven

Als u een lijst met al uw beschikbare configuratieprofielen wilt ophalen en wilt controleren of deze geldig zijn, voert u de auth profiles opdracht als volgt uit:

databricks auth profiles

Uitvoer (de weglatingstekens vertegenwoordigen weggelaten inhoud, voor beknoptheid):

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

Als u wilt bepalen of elk profiel geldig is, voert de Databricks CLI een opdracht voor lijstwerkruimten uit voor elk profiel op accountniveau en voert u een huidige gebruikersopdracht uit voor elk profiel op werkruimteniveau. Als de opdracht slaagt, wordt er een YES weergegeven; anders wordt er een NO weergegeven.

In de uitvoer van de auth profiles opdracht worden geen toegangstokens weergegeven. Zie Informatie over een configuratieprofiel ophalen om een toegangstoken weer te geven.

Configuratieprofielen worden standaard opgeslagen in het bestand ~/.databrickscfg in Linux of macOS of %USERPROFILE%\.databrickscfg in Windows. U kunt het standaardpad van dit bestand wijzigen door de omgevingsvariabele DATABRICKS_CONFIG_FILEin te stellen. Zie de documentatie van uw besturingssysteem voor meer informatie over het instellen van omgevingsvariabelen.

Zie de opdrachtgroep configureren om configuratieprofielen te maken.

Informatie over een configuratieprofiel ophalen

Als u informatie wilt over een bestaand configuratieprofiel, voert u de auth env opdracht uit, waarbij <profile-name> u de naam van het profiel vertegenwoordigt en <account-or-workspace-url> de URL van de Azure Databricks-accountconsole of de URL van de Azure Databricks-werkruimte als volgt vertegenwoordigt:

databricks auth env --profile <profile-name>

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

Tip

U kunt erna Tab drukken --profile of -p een lijst weergeven met bestaande beschikbare configuratieprofielen waaruit u kunt kiezen, in plaats van de naam van het configuratieprofiel handmatig in te voeren.

Hier ziet u bijvoorbeeld de uitvoer voor een profiel dat is geconfigureerd met Azure Databricks-toegangstokenverificatie:

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

Notitie

Als meer dan één profiel overeenkomt met de --host waarde, wordt er een fout weergegeven waarin wordt aangegeven dat er geen enkel overeenkomend profiel kan worden gevonden. U hebt bijvoorbeeld één profiel met alleen een hostwaarde en een ander profiel met dezelfde hostwaarde, maar ook een tokenwaarde. In dit geval kiest de Databricks CLI geen profiel en stopt het. Als u de Databricks CLI wilt helpen bij het kiezen van het gewenste profiel, probeert u een andere --host waarde op te geven. Voor --host waarden die accountconsole-URL's zijn, geeft u een --account-id waarde op in plaats van een --host waarde.

Als u een configuratieprofiel wilt maken, raadpleegt u de opdrachtgroep configureren.

Verifiëren met OAuth

In plaats van verificatie met Azure Databricks met behulp van toegangstokens en configuratieprofielen, kunt u OAuth-gebruikers-naar-machine-verificatie (U2M) gebruiken. OAuth biedt tokens met snellere verlooptijden dan persoonlijke toegangstokens van Azure Databricks en biedt betere server-side sessie ongeldigheid en bereik. Omdat OAuth-toegangstokens binnen een uur verlopen, vermindert dit het risico dat is gekoppeld aan het per ongeluk controleren van tokens in broncodebeheer. Zie Interactieve toegang tot Azure Databricks-resources autoriseren met een gebruikersaccount met behulp van OAuth.

Als u OAuth U2M-verificatie wilt configureren en instellen, raadpleegt u OAuth-gebruikers-naar-machine-verificatie (U2M).

Details van OAuth-toegangstoken ophalen

Als u informatie wilt zien over het OAuth-toegangstoken in de cache dat de Databricks CLI eerder heeft gegenereerd voor een Azure Databricks-werkruimte, voert u de auth token opdracht uit, waarbij <workspace-url> de URL van de Azure Databricks-werkruimte als volgt wordt aangegeven:

databricks auth token <workspace-url>

Uitvoer:

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

Verificatiedetails ophalen

Voer de auth describe opdracht uit om meer informatie te krijgen over de configuratie die de Databricks CLI gebruikt om te verifiëren.

Als er geen opties zijn opgegeven, volgt de auth describe opdracht de standaardmethoden voor geïntegreerde clientverificatie.

databricks auth describe

Uitvoer:

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)

Als u wilt opgeven dat informatie over een specifieke Azure Databricks-werkruimte wordt gebruikt, geeft u de --host optie op samen met de URL van de werkruimte.

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

Uitvoer:

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>

Als u wilt opgeven dat informatie over een specifiek Azure Databricks-account wordt gebruikt, geeft u de --host optie op, samen met de URL van de Azure Databricks-accountconsole. https://accounts.azuredatabricks.net

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

Uitvoer:

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>

Als u wilt opgeven dat informatie over een specifiek Azure Databricks-configuratieprofiel wordt gebruikt, geeft u de -p of --profile optie op samen met de naam van het profiel.

databricks auth describe -p <profile-name>

Uitvoer:

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>

Als u gevoelige informatie wilt opnemen in de uitvoer (zoals persoonlijke toegangstokens en clientgeheimen van Azure Databricks), geeft u de --sensitive optie op.

databricks auth describe --sensitive

Uitvoer:

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