Udostępnij przez

auth grupa poleceń

Note

Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs CLI Databricks jest w publicznej wersji testowej.

Korzystanie z interfejsu wiersza polecenia usługi Databricks podlega licencjom usługi Databricks i powiadomieniom o ochronie prywatności usługi Databricks, w tym wszelkim przepisom dotyczącym danych użycia.

Grupa auth poleceń w interfejsie wiersza polecenia usługi Databricks zawiera polecenia powiązane z uwierzytelnianiem, w tym następujące:

  • Wyświetl listę wszystkich dostępnych profilów konfiguracji uwierzytelniania.
  • Uzyskaj informacje o profilu konfiguracji indywidualnego uwierzytelniania.
  • Uwierzytelnianie użytkownika do komputera (U2M) protokołu OAuth umożliwia uwierzytelnianie interfejsu wiersza polecenia usługi Databricks przy użyciu kont i obszarów roboczych usługi Azure Databricks.
  • Uzyskaj informacje o wszystkich tokenach dostępu OAuth, które mogły być buforowane przez interfejs wiersza polecenia usługi Databricks.
  • Uzyskaj szczegółowe informacje na temat konfiguracji używanej przez interfejs wiersza polecenia usługi Databricks do uwierzytelniania.

Tip

Aby uzyskać informacje o bieżącym użytkowniku interfejsu wiersza polecenia usługi Databricks, uruchom polecenie databricks current-user me.

Opis uwierzytelniania usługi databricks

Opisuje konfigurację używaną przez interfejs wiersza polecenia usługi Databricks do uwierzytelniania, w tym poświadczenia i źródło tych poświadczeń. Jeśli nie określono żadnych opcji, auth describe polecenie jest zgodne z priorytetem metody uwierzytelniania.

databricks auth describe [flags]

Opcje

--sensitive

    Uwzględnianie poufnych pól, takich jak hasła i tokeny w danych wyjściowych

Flagi globalne

Przykłady

W poniższym przykładzie opisano bieżącą konfigurację uwierzytelniania:

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)

Aby określić, że są używane informacje o określonym obszarze roboczym usługi Azure Databricks, określ --host opcję wraz z adresem URL obszaru roboczego.

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>

Aby określić, że są używane informacje o określonym koncie usługi Azure Databricks, określ --host opcję wraz z adresem URL konsoli konta usługi 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>

Aby określić, że są używane informacje o określonym profilu konfiguracji usługi Azure Databricks, określ -p opcję lub --profile wraz z nazwą profilu:

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>

Aby uwzględnić poufne informacje w danych wyjściowych (takich jak osobiste tokeny dostępu usługi Azure Databricks i wpisy tajne klienta), określ --sensitive opcję:

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

env auth usługi databricks

Uzyskaj informacje o istniejącym profilu konfiguracji przy użyciu nazwy profilu lub adresu URL konsoli konta usługi Azure Databricks lub adresu URL obszaru roboczego usługi Azure Databricks.

databricks auth env [flags]

Tip

Możesz nacisnąć Tab po --profile lub -p, aby wyświetlić listę istniejących dostępnych profilów konfiguracji do wyboru, zamiast ręcznie wprowadzać nazwę profilu konfiguracji.

Aby utworzyć profil konfiguracji, zobacz configure polecenie .

Opcje

--host string

    Nazwa hosta, aby uzyskać env auth for

Note

Jeśli więcej niż jeden profil jest zgodny z --host wartością, zostanie wyświetlony błąd z informacją, że nie może odnaleźć jednego pasującego profilu. Na przykład może istnieć jeden profil, który ma tylko wartość hosta i inny profil, który ma tę samą wartość hosta, ale także wartość tokenu. W takim przypadku interfejs wiersza polecenia usługi Databricks nie wybiera profilu i zatrzymuje się. Aby ułatwić interfejsowi wiersza polecenia usługi Databricks wybranie odpowiedniego profilu, spróbuj określić inną --host wartość. W przypadku wartości --host, które są adresami URL konsoli konta, spróbuj określić wartość --account-id zamiast wartości --host.

--profile string

    Profil umożliwiający uzyskanie env uwierzytelniania dla

Flagi globalne

Przykłady

Poniższy przykład pobiera domyślne środowisko uwierzytelniania:

databricks auth env

Poniższy przykład pobiera środowisko uwierzytelniania dla określonego hosta:

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

Dane wyjściowe profilu skonfigurowanego przy użyciu uwierzytelniania tokenu dostępu usługi Azure Databricks mogą być następujące:

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

Poniższy przykład pobiera środowisko uwierzytelniania dla określonego profilu:

databricks auth env --profile my-test-environment

logowanie do uwierzytelniania usługi databricks

Zaloguj się do obszaru roboczego lub konta usługi Databricks i zapisz konfigurację uwierzytelniania w profilu ( ~/.databrickscfg domyślnie). Profil może następnie służyć do uwierzytelniania innych poleceń interfejsu wiersza polecenia usługi Databricks przy użyciu flagi --profile . Profil może również służyć do uwierzytelniania innych narzędzi usługi Databricks, które obsługują ujednolicone uwierzytelnianie usługi Databricks, w tym zestawy SDK języka Python, Java i Go usługi Databricks.

databricks auth login HOST [flags]

To polecenie wymaga adresu URL hosta usługi Databricks (przy użyciu --host argumentu pozycyjnego lub niejawnie wnioskowanego z określonej nazwy profilu) i nazwy profilu (przy użyciu metody --profile) do określenia. Jeśli te wartości nie zostaną określone, zostanie wyświetlony monit o podanie wartości w czasie wykonywania.

Chociaż to polecenie zawsze rejestruje Cię na określonym hoście, zachowanie zależy od istniejących profilów ustawionych w pliku konfiguracji (domyślnie ~/.databrickscfg ):

  1. Jeśli profil o określonej nazwie istnieje i określa hosta, nastąpi zalogowanie do hosta określonego przez profil. Profil zostanie zaktualizowany tak, aby używał polecenia "databricks-cli" jako typu uwierzytelniania, jeśli tak nie było wcześniej.
  2. Jeśli profil o określonej nazwie istnieje, ale nie określi hosta, zostanie wyświetlony monit o określenie hosta. Profil zostanie zaktualizowany do korzystania z określonego hosta. Typ uwierzytelniania zostanie zaktualizowany do "databricks-cli", jeśli tak nie było wcześniej.
  3. Jeśli profil o określonej nazwie istnieje i określa hosta, ale określisz hosta przy użyciu --host (lub jako HOST arg pozycyjny), profil zostanie zaktualizowany do używania nowo określonego hosta. Typ uwierzytelniania zostanie zaktualizowany do "databricks-cli", jeśli tak nie było wcześniej.
  4. Jeśli profil o określonej nazwie nie istnieje, zostanie utworzony nowy profil z określonym hostem. Typ uwierzytelniania zostanie ustawiony na wartość "databricks-cli".

Argumenty (w programowaniu)

HOST

    Adres URL hosta usługi Databricks (opcjonalnie)

Opcje

--configure-cluster

    Prośby o skonfigurowanie klastra (klasyczna obliczeniowa)

--configure-serverless

    Polecenia do skonfigurowania bezserwerowego przetwarzania

--timeout duration

    Limit czasu ukończenia zadania logowania w przeglądarce (domyślnie 1h0m0s)

Flagi globalne

Przykłady

Poniższy przykład rejestruje się w obszarze roboczym usługi Databricks:

databricks auth login

Poniższy przykład rejestruje się w określonym obszarze roboczym usługi Databricks:

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

Poniższy przykład rejestruje się przy użyciu określonego profilu i konfiguruje ustawienia klastra:

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

W poniższym przykładzie ustawiono niestandardowy limit czasu procesu logowania:

databricks auth login --timeout 30m

Profile uwierzytelniania usługi databricks

Wyświetl listę wszystkich dostępnych profilów konfiguracji (domyślnie ~/.databrickscfg ) i sprawdź, czy są one prawidłowymi profilami.

databricks auth profiles [flags]

To polecenie generuje profile w następującym formacie:

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

Aby określić, czy każdy profil jest prawidłowy, interfejs wiersza polecenia usługi Databricks wyświetla obszary robocze dla każdego profilu na poziomie konta i uruchamia polecenie get current user dla każdego profilu na poziomie obszaru roboczego. Jeśli polecenie zakończy się pomyślnie, YES zostanie wyświetlony element ; w przeciwnym razie NO zostanie wyświetlony komunikat.

Dane wyjściowe auth profiles polecenia nie wyświetlają żadnych tokenów dostępu. Aby wyświetlić token dostępu, zobacz databricks auth env (Env auth usługi databricks).

Domyślnie profile konfiguracji są przechowywane w pliku ~/.databrickscfg w systemie Linux lub macOS lub %USERPROFILE%\.databrickscfg w systemie Windows. Możesz zmienić domyślną ścieżkę tego pliku, ustawiając zmienną środowiskową DATABRICKS_CONFIG_FILE.

Aby utworzyć profile konfiguracji, zapoznaj się z configure poleceniem.

Opcje

--skip-validate

    Czy pominąć walidację profilów

Flagi globalne

Przykłady

W poniższym przykładzie wymieniono wszystkie profile uwierzytelniania:

databricks auth profiles

W poniższym przykładzie wymieniono profile bez sprawdzania ich poprawności:

databricks auth profiles --skip-validate

token uwierzytelniania usługi databricks

Pobierz token uwierzytelniania z lokalnej pamięci podręcznej w programie ~/.databricks/token-cache.json. Odśwież token dostępu, jeśli wygasł. To polecenie działa tylko z uwierzytelnianiem U2M (przy użyciu databricks auth login polecenia ). Uwierzytelnianie M2M przy użyciu identyfikatora klienta i wpisu tajnego nie jest obsługiwane.

databricks auth token [HOST] [flags]

Aby skonfigurować i ustawić uwierzytelnianie OAuth U2M, zobacz Uwierzytelnianie użytkownika do komputera OAuth (U2M).

Argumenty (w programowaniu)

HOST

    Adres URL hosta usługi Databricks (opcjonalnie)

Opcje

--account-id string

    Identyfikator konta usługi Databricks

--timeout duration

    Limit czasu uzyskiwania tokenu. (domyślnie 1h0m0s)

Flagi globalne

Przykłady

Poniższy przykład pobiera token uwierzytelniania:

databricks auth token

Poniższy przykład pobiera token uwierzytelniania dla określonego hosta:

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

Dane wyjściowe mogą być następujące:

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

W poniższym przykładzie ustawiono niestandardowy limit czasu pozyskiwania tokenu:

databricks auth token --timeout 30m

Flagi globalne

--debug

  Czy włączyć logowanie debugowe.

-h lub --help

    Wyświetl pomoc dla Databricks CLI lub dla powiązanej grupy poleceń czy pojedynczego polecenia.

--log-file łańcuch znaków

    Ciąg tekstowy reprezentujący plik do zapisywania logów wyjściowych. Jeśli ta flaga nie zostanie określona, wartością domyślną jest zapisywanie dzienników wyjściowych w programie stderr.

--log-format formatowanie

    Format typu logu text lub json. Wartość domyślna to text.

--log-level łańcuch znaków

    Ciąg reprezentujący poziom formatu zapisu dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony.

-o, --output typ

    Typ danych wyjściowych polecenia: text lub json. Wartość domyślna to text.

-p, --profile łańcuch znaków

    Nazwa profilu w pliku ~/.databrickscfg, który ma być użyty do uruchomienia polecenia. Jeśli ta flaga nie zostanie określona, to jeśli istnieje, zostanie użyty profil o nazwie DEFAULT.

--progress-format formatowanie

    Format wyświetlania dzienników postępu: default, , appendinplacelubjson

-t, --target łańcuch znaków

    Jeśli ma to zastosowanie, docelowy obiekt pakietu do użycia

  • Last updated on