`auth` skupina příkazů

Note

Tyto informace platí pro Databricks CLI verze 0.205 a vyšší. Rozhraní příkazového řádku Databricks je ve veřejné ukázce.

Použití rozhraní příkazového řádku Databricks podléhá licenci Databricks a oznámení o ochraně osobních údajů Databricks, včetně všech ustanovení o využití.

Skupina auth příkazů v rozhraní příkazového řádku Databricks obsahuje příkazy související s ověřováním, včetně následujících:

Uveďte seznam všech dostupných konfiguračních profilů ověřování.
Získejte informace o individuálním konfiguračním profilu ověřování.
Ověřování uživateleM (U2M) OAuth použijte k ověření rozhraní příkazového řádku Databricks pomocí účtů a pracovních prostorů Azure Databricks.
Získejte informace o všech přístupových tokenech OAuth, které může rozhraní příkazového řádku Databricks ukládat do mezipaměti.
Získejte podrobnosti o konfiguraci, kterou rozhraní příkazového řádku Databricks používá k ověření.

Tip

Chcete-li získat informace o aktuálním uživateli rozhraní příkazového řádku Databricks, spusťte databricks current-user me.

Popis ověřování databricks

Popisuje konfiguraci, kterou rozhraní příkazového řádku Databricks používá k ověření, včetně přihlašovacích údajů a zdroje těchto přihlašovacích údajů. Pokud nejsou zadány žádné možnosti, auth describe příkaz se řídí prioritou metody ověřování.

databricks auth describe [flags]

Možnosti

--sensitive

Do výstupu zahrňte citlivá pole, jako jsou hesla a tokeny.

Globální příznaky

Příklady

Následující příklad popisuje aktuální konfiguraci ověřování:

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)

Pokud chcete určit, že se použijí informace o konkrétním pracovním prostoru Azure Databricks, zadejte --host možnost spolu s adresou URL pracovního prostoru.

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>

Pokud chcete určit, že se použijí informace o konkrétním účtu Azure Databricks, zadejte --host možnost spolu s adresou URL https://accounts.azuredatabricks.netkonzoly účtu Azure Databricks.

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>

Pokud chcete určit, že se použijí informace o konkrétním konfiguračním profilu Azure Databricks, zadejte -p nebo --profile možnost spolu s názvem 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>

Pokud chcete do výstupu zahrnout citlivé informace (například osobní přístupové tokeny Azure Databricks a tajné kódy klienta), zadejte --sensitive možnost:

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

Ověřování databricks – env

Získejte informace o existujícím konfiguračním profilu pomocí názvu profilu nebo adresy URL konzoly účtu Azure Databricks nebo adresy URL pracovního prostoru Azure Databricks.

databricks auth env [flags]

Tip

Po Tab nebo --profile můžete stisknout -p a zobrazit seznam existujících dostupných konfiguračních profilů, ze které si můžete vybrat, a nemusíte zadávat název konfiguračního profilu ručně.

Pokud chcete vytvořit konfigurační profil, podívejte se na configure příkaz.

Možnosti

--host string

Název hostitele pro získání ověřovacího env pro

Note

Pokud hodnota odpovídá --host více než jednomu profilu, zobrazí se chyba s oznámením, že nemůže najít jeden odpovídající profil. Můžete mít například jeden profil, který má pouze hodnotu hostitele a jiný profil, který má stejnou hodnotu hostitele, ale také hodnotu tokenu. V takovém případě rozhraní příkazového řádku Databricks nevybere profil a zastaví se. Pokud chcete rozhraní příkazového řádku Databricks pomoct zvolit požadovaný profil, zkuste zadat jinou --host hodnotu. U --host hodnot, které jsou adresami URL konzoly účtu, zkuste místo hodnoty --account-id zadat hodnotu --host.

--profile string

Profil pro získání ověřování pro

Globální příznaky

Příklady

Následující příklad získá výchozí ověřovací prostředí:

databricks auth env

Následující příklad získá ověřovací prostředí pro konkrétního hostitele:

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

Výstup profilu, který je nakonfigurovaný pomocí ověřování přístupového tokenu Azure Databricks, může být následující:

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

Následující příklad získá ověřovací prostředí pro konkrétní profil:

databricks auth env --profile my-test-environment

Přihlaste se k pracovnímu prostoru nebo účtu Databricks a uložte konfiguraci ověřování do profilu ( ~/.databrickscfg ve výchozím nastavení). Profil se pak dá použít k ověření dalších příkazů Rozhraní příkazového řádku Databricks pomocí příznaku --profile . Profil se dá použít také k ověřování dalších nástrojů Databricks, které podporují jednotné ověřování Databricks, včetně sad SDK Databricks v Pythonu, Javě a Go.

databricks auth login HOST [flags]

Tento příkaz vyžaduje adresu URL hostitele Databricks (použití --host nebo jako poziční argument nebo implicitně odvozené ze zadaného názvu profilu) a název profilu (pomocí --profile) k zadání. Pokud tyto hodnoty nezadáte, zobrazí se výzva k zadání hodnot za běhu.

I když se tento příkaz vždy přihlásí k zadanému hostiteli, chování závisí na existujících profilech, které jste nastavili v konfiguračním souboru ( ~/.databrickscfg ve výchozím nastavení):

Pokud profil se zadaným názvem existuje a určuje hostitele, budete přihlášeni k hostiteli určenému profilem. Profil se aktualizuje tak, aby jako typ ověřování používal databricks-cli, pokud tomu tak nebylo.
Pokud profil se zadaným názvem existuje, ale neurčí hostitele, zobrazí se výzva k zadání hostitele. Profil se aktualizuje tak, aby používal zadaného hostitele. Typ ověřování se aktualizuje na databricks-cli, pokud tomu tak nebylo dříve.
Pokud profil se zadaným názvem existuje a určuje hostitele, ale určíte hostitele pomocí --host (nebo jako HOST pozice arg), profil se aktualizuje tak, aby používal nově zadaného hostitele. Typ ověřování se aktualizuje na databricks-cli, pokud tomu tak nebylo dříve.
Pokud profil se zadaným názvem neexistuje, vytvoří se nový profil se zadaným hostitelem. Typ ověřování se nastaví na databricks-cli.

Argumenty

HOST

Adresa URL hostitele Databricks (volitelné)

Možnosti

--configure-cluster

Výzva ke konfiguraci clusteru (klasické výpočetní prostředí)

--configure-serverless

Výzva ke konfiguraci bezserverového výpočetního prostředí

--timeout duration

Vypršení časového limitu pro dokončení výzvy přihlášení v prohlížeči (výchozí 1h0m0s)

Globální příznaky

Příklady

Následující příklad se přihlásí do pracovního prostoru Databricks:

databricks auth login

Následující příklad se přihlásí do konkrétního pracovního prostoru Databricks:

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

Následující příklad se přihlásí s konkrétním profilem a nakonfiguruje nastavení clusteru:

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

Následující příklad nastaví vlastní časový limit pro proces přihlášení:

databricks auth login --timeout 30m

Profily ověřování databricks

Vypíše všechny dostupné konfigurační profily ( ~/.databrickscfg ve výchozím nastavení) a zkontroluje, jestli jsou platné profily.

databricks auth profiles [flags]

Tento příkaz vypíše profily v následujícím formátu:

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

Pokud chcete zjistit, jestli je každý profil platný, rozhraní příkazového řádku Databricks zobrazí seznam pracovních prostorů pro každý profil na úrovni účtu a spustí příkaz get current user command for each workspace-level profile. Pokud je příkaz úspěšný, YES zobrazí se příkaz. V opačném případě se NO zobrazí displej.

Výstup auth profiles příkazu nezobrazuje žádné přístupové tokeny. Pokud chcete zobrazit přístupový token, přečtěte si článek o ověřování Databricks.

Ve výchozím nastavení jsou konfigurační profily uložené v souboru ~/.databrickscfg v Linuxu nebo macOS nebo %USERPROFILE%\.databrickscfg ve Windows. Výchozí cestu k tomuto souboru můžete změnit nastavením proměnné DATABRICKS_CONFIG_FILEprostředí .

Pokud chcete vytvořit konfigurační profily, podívejte se na configure příkaz.

Možnosti

--skip-validate

Jestli se má přeskočit ověřování profilů

Globální příznaky

Příklady

Následující příklad uvádí všechny profily ověřování:

databricks auth profiles

Následující příklad uvádí profily bez jejich ověření:

databricks auth profiles --skip-validate

Ověřovací token databricks

Získejte ověřovací token z místní mezipaměti v ~/.databricks/token-cache.json. Pokud platnost přístupového tokenu vypršela, aktualizujte ho. Tento příkaz funguje jenom s ověřováním U2M (pomocí databricks auth login příkazu). Ověřování M2M pomocí ID klienta a tajného klíče se nepodporuje.

databricks auth token [HOST] [flags]

Informace o konfiguraci a nastavení ověřování OAuth user-to-machine (U2M) najdete v tématu ověřování OAuth user-to-machine (U2M).

Argumenty

HOST

Adresa URL hostitele Databricks (volitelné)

Možnosti

--account-id string

ID účtu Databricks

--timeout duration

Časový limit pro získání tokenu (výchozí 1h0m0s)

Globální příznaky

Příklady

Následující příklad získá ověřovací token:

databricks auth token

Následující příklad získá ověřovací token pro konkrétního hostitele:

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

Výstupem může být:

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

Následující příklad nastaví vlastní časový limit pro získání tokenu:

databricks auth token --timeout 30m

Globální příznaky

--debug

Zda povolit protokolování ladění.

-h nebo --help

Zobrazení nápovědy k rozhraní příkazového řádku Databricks nebo související skupině příkazů nebo souvisejícímu příkazu

--log-file řetězec

Řetězec představující soubor, do kterého se zapisují výstupní protokoly. Pokud tento příznak není zadaný, výchozí hodnota je zápis výstupních protokolů do stderru.

--log-format formát

Typ formátu protokolu, text nebo json. Výchozí hodnota je text.

--log-level řetězec

Řetězec představující úroveň formátu protokolu. Pokud není zadána, je úroveň formátu protokolu zakázaná.

-o, --output typ

Typ výstupu příkazu, text nebo json. Výchozí hodnota je text.

-p, --profile řetězec

Název profilu v ~/.databrickscfg souboru, který se má použít ke spuštění příkazu. Pokud tento příznak není zadán, použije se profil s názvem DEFAULT, pokud existuje.

--progress-format formát

Formát pro zobrazení protokolů průběhu: default, append, inplacenebo json

-t, --target řetězec

Pokud je to relevantní, cílový balíček, který se má použít

Váš názor

Byla tato stránka užitečná?

Last updated on 2025-10-24

Sdílet prostřednictvím

auth skupina příkazů

Popis ověřování databricks

Možnosti

Příklady

Ověřování databricks – env

Možnosti

Příklady

Přihlášení k ověřování databricks

Argumenty

Možnosti

Příklady

Profily ověřování databricks

Možnosti

Příklady

Ověřovací token databricks

Argumenty

Možnosti

Příklady

Globální příznaky

Váš názor

Další materiály

`auth` skupina příkazů