`auth` grupa poleceń

Artykuł
01/22/2025

Uwaga

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

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 umożliwia:

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.

auth Uruchamiasz polecenia, dołączając je do databricks authelementu . Aby wyświetlić pomoc dotyczącą auth polecenia, uruchom polecenie databricks auth -h.

Wyświetlanie listy profilów konfiguracji

Aby uzyskać listę wszystkich dostępnych profilów konfiguracji i sprawdzić, czy są prawidłowe, uruchom polecenie auth profiles w następujący sposób:

databricks auth profiles

Dane wyjściowe (wielokropek reprezentuje pominiętą zawartość dla zwięzłości):

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

Aby określić, czy każdy profil jest prawidłowy, CLI Databricks uruchamia polecenie list workspaces 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 Aby uzyskać informacje o profilu konfiguracji.

Profile konfiguracji są przechowywane w pliku ~/.databrickscfg w systemie Linux lub macOS lub %USERPROFILE%\.databrickscfg w systemie Windows domyślnie. Możesz zmienić domyślną ścieżkę tego pliku, ustawiając zmienną środowiskową DATABRICKS_CONFIG_FILE. Aby dowiedzieć się, jak ustawić zmienne środowiskowe, zobacz dokumentację systemu operacyjnego.

Aby utworzyć profile konfiguracji, zobacz konfigurowanie grupy poleceń.

Uzyskiwanie informacji o profilu konfiguracji

Aby uzyskać informacje o istniejącym profilu konfiguracji, uruchom polecenie auth env, gdzie <profile-name> reprezentuje nazwę profilu, a <account-or-workspace-url> reprezentuje adres URL konsoli konta usługi Azure Databricks lub adres URL obszaru roboczego usługi Azure Databricks w następujący sposób:

databricks auth env --profile <profile-name>

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

Napiwek

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.

Na przykład poniżej przedstawiono dane wyjściowe profilu skonfigurowanego przy użyciu uwierzytelniania tokenu dostępu usługi Azure Databricks:

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

Uwaga

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.

Aby utworzyć profil konfiguracji, zobacz konfigurowanie grupy poleceń.

Uwierzytelnianie przy użyciu protokołu OAuth

Zamiast uwierzytelniania w usłudze Azure Databricks przy użyciu tokenów dostępu i profilów konfiguracji, możesz użyć uwierzytelniania OAuth typu użytkownik-komputer (U2M). Protokół OAuth zapewnia tokeny z krótszym czasem wygaśnięcia niż osobiste tokeny dostępu usługi Azure Databricks i oferuje lepsze unieważnienie sesji po stronie serwera i określanie zakresu. Ponieważ tokeny dostępu OAuth wygasają w mniej niż godzinę, zmniejsza to ryzyko związane z przypadkowym sprawdzaniem tokenów w kontroli źródła. Zobacz Autoryzowanie interakcyjnego dostępu do zasobów usługi Azure Databricks przy użyciu konta użytkownika przy użyciu protokołu OAuth.

Aby skonfigurować i ustawić uwierzytelnianie OAuth U2M, zobacz OAuth user-to-machine (U2M) authentication.

Uzyskiwanie szczegółów tokenu dostępu OAuth

Jeśli chcesz wyświetlić informacje o zapamiętanym tokenie dostępu OAuth, który został wcześniej wygenerowany przez interfejs wiersza poleceń Databricks dla obszaru roboczego usługi Azure Databricks, należy uruchomić polecenie auth token, gdzie <workspace-url> reprezentuje adres URL obszaru roboczego usługi Azure Databricks w następujący sposób:

databricks auth token <workspace-url>

Wyjście:

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

Pobieranie szczegółów uwierzytelniania

Aby uzyskać szczegółowe informacje na temat konfiguracji używanej przez interfejs wiersza polecenia usługi Databricks do uwierzytelniania, uruchom polecenie auth describe.

Jeśli nie określono żadnych opcji, auth describe polecenie jest zgodne z domyślnymi metodami ujednoliconego uwierzytelniania klienta.

databricks auth describe

Wyjście:

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>

Wyjście:

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>

Wyjście:

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

Wyjście:

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>

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

Wyjście:

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

Udostępnij za pośrednictwem

`auth` grupa poleceń

Wyświetlanie listy profilów konfiguracji

Uzyskiwanie informacji o profilu konfiguracji

Uwierzytelnianie przy użyciu protokołu OAuth

Uzyskiwanie szczegółów tokenu dostępu OAuth

Pobieranie szczegółów uwierzytelniania

Opinia

Dodatkowe zasoby

Udostępnij za pośrednictwem

auth grupa poleceń

Wyświetlanie listy profilów konfiguracji

Uzyskiwanie informacji o profilu konfiguracji

Uwierzytelnianie przy użyciu protokołu OAuth

Uzyskiwanie szczegółów tokenu dostępu OAuth

Pobieranie szczegółów uwierzytelniania

Opinia

Dodatkowe zasoby

`auth` grupa poleceń