Condividi tramite

auth gruppo di comandi

Note

Queste informazioni si applicano all'interfaccia della riga di comando di Databricks versione 0.205 e successive. L'interfaccia della riga di comando di Databricks è disponibile in anteprima pubblica.

L'uso della CLI di Databricks è soggetto alla Licenza di Databricks e all'Informativa sulla privacy di Databricks, incluse eventuali disposizioni sui dati di utilizzo.

Il auth gruppo di comandi all'interno dell'interfaccia della riga di comando di Databricks contiene i comandi correlati all'autenticazione, tra cui:

  • Elencare i profili di configurazione di autenticazione disponibili.
  • Ottenere informazioni su un singolo profilo di configurazione di autenticazione.
  • Usare l'autenticazione da utente a computer (U2M) OAuth per autenticare il Databricks CLI con gli account e le aree di lavoro di Azure Databricks.
  • Ottenere informazioni sui token di accesso OAuth che l'interfaccia riga di comando di Databricks potrebbe avere memorizzato nella cache.
  • Ottenere informazioni dettagliate sulla configurazione usata dall'interfaccia della riga di comando di Databricks per l'autenticazione.

Tip

Per ottenere informazioni sull'utente corrente dell'interfaccia della riga di comando di Databricks, eseguire databricks current-user me.

Descrizione dell'autenticazione di databricks

Descrive la configurazione usata dall'interfaccia della riga di comando di Databricks per l'autenticazione, incluse le credenziali e l'origine di tali credenziali. Se non vengono specificate opzioni, il auth describe comando segue la priorità del metodo di autenticazione.

databricks auth describe [flags]

Opzioni

--sensitive

    Includere campi sensibili come password e token nell'output

Flag globali

Esempi

L'esempio seguente descrive la configurazione di autenticazione corrente:

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)

Per specificare che vengono usate informazioni su un'area di lavoro specifica di Azure Databricks, specificare l'opzione --host insieme all'URL dell'area di lavoro.

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>

Per specificare che vengono usate informazioni su un account Azure Databricks specifico, specificare l'opzione --host insieme all'URL della console dell'account Azure Databricks, 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>

Per specificare che vengono usate informazioni su un profilo di configurazione specifico di Azure Databricks, specificare l'opzione -p o --profile insieme al nome del profilo:

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>

Per includere informazioni riservate nell'output ,ad esempio token di accesso personali e segreti client di Azure Databricks, specificare l'opzione --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

ambiente autenticazione di Databricks

Ottenere informazioni su un profilo di configurazione esistente usando il nome del profilo o l'URL della console dell'account Azure Databricks o l'URL dell'area di lavoro di Azure Databricks.

databricks auth env [flags]

Tip

È possibile premere Tab dopo --profile o -p per visualizzare un elenco di profili di configurazione disponibili esistenti tra cui scegliere, anziché immettere manualmente il nome del profilo di configurazione.

Per creare un profilo di configurazione, vedere il configure comando .

Opzioni

--host string

    Nome host per cui ottenere l'autenticazione env

Note

Se più profili corrispondono al valore --host, viene visualizzato un errore che indica che non è possibile trovare un singolo profilo corrispondente. Ad esempio, si potrebbe avere un profilo con solo un valore host e un altro profilo con lo stesso valore host, ma anche un valore del token. In questo caso, il Databricks CLI non sceglie un profilo e si arresta. Per aiutare il Databricks CLI a scegliere il profilo desiderato, provare a specificare un valore --host diverso . Per valori --host che sono URL della console dell'account, provare a specificare un valore --account-id anziché un valore --host.

--profile string

    Profilo per ottenere l'autenticazione env per

Flag globali

Esempi

L'esempio seguente ottiene l'ambiente di autenticazione predefinito:

databricks auth env

L'esempio seguente ottiene l'ambiente di autenticazione per un host specifico:

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

L'output per un profilo configurato con l'autenticazione del token di accesso di Azure Databricks potrebbe essere:

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

L'esempio seguente ottiene l'ambiente di autenticazione per un profilo specifico:

databricks auth env --profile my-test-environment

account di accesso di autenticazione di databricks

Accedere a un'area di lavoro o a un account Databricks e salvare la configurazione di autenticazione in un profilo (per ~/.databrickscfg impostazione predefinita). Il profilo può quindi essere usato per autenticare altri comandi dell'interfaccia della riga di comando di Databricks usando il --profile flag . Il profilo può essere usato anche per autenticare altri strumenti di Databricks che supportano l'autenticazione unificata di Databricks, tra cui Databricks Python, Java e Go SDK.

databricks auth login HOST [flags]

Questo comando richiede un URL host di Databricks (usando --host o come argomento posizionale o dedotto in modo implicito dal nome del profilo specificato) e un nome del profilo (usando --profile) da specificare. Se non si specificano questi valori, verranno richiesti i valori in fase di esecuzione.

Anche se questo comando registra sempre l'utente nell'host specificato, il comportamento dipende dai profili esistenti impostati nel file di configurazione (per ~/.databrickscfg impostazione predefinita):

  1. Se esiste un profilo con il nome specificato e specifica un host, si accederà all'host specificato dal profilo. Il profilo verrà aggiornato in modo da usare "databricks-cli" come tipo di autenticazione se non è stato fatto prima.
  2. Se esiste un profilo con il nome specificato ma non specifica un host, verrà richiesto di specificare un host. Il profilo verrà aggiornato per usare l'host specificato. Il tipo di autenticazione verrà aggiornato a "databricks-cli" in caso contrario.
  3. Se esiste un profilo con il nome specificato e specifica un host, ma si specifica un host usando --host (o come HOST arg posizionale), il profilo verrà aggiornato per usare l'host appena specificato. Il tipo di autenticazione verrà aggiornato a "databricks-cli" in caso contrario.
  4. Se non esiste un profilo con il nome specificato, verrà creato un nuovo profilo con l'host specificato. Il tipo di autenticazione verrà impostato su "databricks-cli".

Argomenti

HOST

    URL host di Databricks (facoltativo)

Opzioni

--configure-cluster

    Istruzioni per configurare il cluster (calcolo di tipo classico)

--configure-serverless

    Richiede di configurare il calcolo serverless

--timeout duration

    Timeout per il completamento della richiesta di accesso nel browser (impostazione predefinita 1h0m0s)

Flag globali

Esempi

L'esempio seguente accede a un'area di lavoro di Databricks:

databricks auth login

L'esempio seguente accede a un'area di lavoro databricks specifica:

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

L'esempio seguente esegue l'accesso con un profilo specifico e configura le impostazioni del cluster:

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

Nell'esempio seguente viene impostato un timeout personalizzato per il processo di accesso:

databricks auth login --timeout 30m

Profili di autenticazione di databricks

Elencare tutti i profili di configurazione disponibili (per ~/.databrickscfg impostazione predefinita) e verificare se sono profili validi.

databricks auth profiles [flags]

Questo comando restituisce i profili nel formato seguente:

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

Per determinare se ogni profilo è valido, l'interfaccia della riga di comando di Databricks elenca le aree di lavoro per ogni profilo a livello di account ed esegue un comando get current user per ogni profilo a livello di area di lavoro. Se il comando ha esito positivo, viene visualizzato un oggetto YES; in caso contrario, viene visualizzato un oggetto NO.

L'output del comando auth profiles non visualizza token di accesso. Per visualizzare un token di accesso, vedere databricks auth env.

Per impostazione predefinita, i profili di configurazione vengono archiviati nel file ~/.databrickscfg in Linux o macOS o %USERPROFILE%\.databrickscfg in Windows. Puoi cambiare il percorso predefinito di questo file impostando la variabile d'ambiente K. DATABRICKS_CONFIG_FILE.

Per creare profili di configurazione, vedere il configure comando .

Opzioni

--skip-validate

    Se ignorare la convalida dei profili

Flag globali

Esempi

L'esempio seguente elenca tutti i profili di autenticazione:

databricks auth profiles

L'esempio seguente elenca i profili senza convalidarli:

databricks auth profiles --skip-validate

token di autenticazione di databricks

Ottenere il token di autenticazione dalla cache locale in ~/.databricks/token-cache.json. Aggiornare il token di accesso se è scaduto. Questo comando funziona solo con l'autenticazione U2M (usando il databricks auth login comando ). L'autenticazione M2M con un ID client e un segreto non è supportata.

databricks auth token [HOST] [flags]

Per configurare e impostare l'autenticazione OAuth U2M, vedere Autenticazione utente-a-macchina (U2M) OAuth.

Argomenti

HOST

    URL host di Databricks (facoltativo)

Opzioni

--account-id string

    ID dell'Account Databricks

--timeout duration

    Timeout per l'acquisizione di un token. (impostazione predefinita 1h0m0s)

Flag globali

Esempi

L'esempio seguente ottiene il token di autenticazione:

databricks auth token

L'esempio seguente ottiene il token di autenticazione per un host specifico:

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

L'output potrebbe essere:

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

L'esempio seguente imposta un timeout personalizzato per l'acquisizione del token:

databricks auth token --timeout 30m

Bandiere globali

--debug

  Indica se abilitare la registrazione di debug.

-h oppure --help

    Mostra la guida per il Databricks CLI, il gruppo di comandi correlato o il comando correlato.

--log-file stringa

    Stringa che rappresenta il file in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.

--log-format formato

    Tipo di formato del log, text o json. Il valore predefinito è text.

--log-level stringa

    Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.

tipo

    Tipo di output del comando, text o json. Il valore predefinito è text.

-p, --profile stringa

    Nome del profilo nel ~/.databrickscfg file da usare per eseguire il comando . Se questo flag non viene specificato, se esiste, viene usato il profilo denominato DEFAULT .

--progress-format formato

    Formato per visualizzare i log di stato: default, append, inplaceo json

-t, --target stringa

    Se applicabile, la destinazione del bundle da utilizzare

  • Last updated on