Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Note
Ezek az információk a Databricks CLI 0.205-ös és újabb verzióira vonatkoznak. A Databricks parancssori felülete nyilvános előzetes verzióban érhető el.
A Databricks CLI használatára a Databricks Licenc és a Databricks adatvédelmi nyilatkozata vonatkozik, beleértve a használati adatokra vonatkozó rendelkezéseket is.
A authDatabricks parancssori felületének parancscsoportja a hitelesítéssel kapcsolatos parancsokat tartalmaz, beleértve a következőket:
- Listázhatja az elérhető hitelesítési konfigurációs profilokat.
- Az egyes hitelesítési konfigurációs profilokkal kapcsolatos információk lekérése.
- OAuth felhasználó–gép (U2M) hitelesítéssel hitelesítheti a Databricks PARANCSSOR-t az Azure Databricks-fiókokkal és -munkaterületekkel.
- Jelentkezzen ki egy profilból a gyorsítótárazott OAuth-jogkivonatok törlésével és a profilbejegyzés opcionális eltávolításával.
- Információt kaphat a Databricks PARANCSSOR által gyorsítótárazott OAuth hozzáférési jogkivonatokról.
- Részletes információk a Databricks parancssori felület hitelesítéséhez használt konfigurációjáról.
Tip
Az aktuális Databricks CLI-felhasználóval kapcsolatos információk lekéréséhez futtassa a következőt databricks current-user me: .
databricks hitelesítés leírása
A Databricks parancssori felület által a hitelesítéshez használt konfigurációt ismerteti, beleértve a hitelesítő adatokat és a hitelesítő adatok forrását. Ha nincs megadva beállítás, a parancs a auth describehitelesítési módszer prioritását követi.
databricks auth describe [flags]
Beállítások
--sensitive
Bizalmas mezők, például jelszavak és jogkivonatok felvétele a kimenetbe
Példák
Az alábbi példa az aktuális hitelesítési konfigurációt ismerteti:
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)
Egy adott Azure Databricks-munkaterület adatainak megadásához adja meg a --host lehetőséget a munkaterület URL-címével együtt.
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>
Egy adott Azure Databricks-fiók adatainak megadásához adja meg a --host lehetőséget az Azure Databricks-fiók konzolJÁNAK URL-címével https://accounts.azuredatabricks.netegyütt.
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>
Egy adott Azure Databricks-konfigurációs profil adatainak megadásához adja meg a -p--profile profil nevét és a lehetőséget:
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>
Ha bizalmas adatokat szeretne belefoglalni a kimenetbe (például az Azure Databricks személyes hozzáférési jogkivonatait és titkos ügyfélkulcsait), adja meg a --sensitive következő lehetőséget:
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
databricks hitelesítési környezet
Warning
Ez a parancs elavult.
A profil vagy az Azure Databricks-fiók konzoljának URL-címével vagy az Azure Databricks-munkaterület URL-címével információkat kaphat egy meglévő konfigurációs profilról.
databricks auth env [flags]
Tip
A Tab--profile vagy -p után lenyomva megjelenítheti a választható meglévő konfigurációs profilok listáját ahelyett, hogy manuálisan adja meg a konfigurációs profil nevét.
Konfigurációs profil létrehozásához tekintse meg a configure parancsot.
Beállítások
--host string
Hitelesítési környezet lekéréséhez használt hosztnév
Note
Ha egynél több profil felel meg az --host értéknek, hibaüzenet jelenik meg, amely szerint nem talál egyetlen egyező profilt. Előfordulhat például, hogy egy profil csak gazdagép értékkel és egy másik profillal rendelkezik, amely ugyanazt a gazdagépértéket, de tokenértéket is magában foglalja. Ebben az esetben a Databricks parancssori felület nem választ profilt, és leáll. Ha segíteni szeretne a Databricks parancssori felületének a kívánt profil kiválasztásában, próbáljon meg másik --host értéket megadni. A fiókkonzol URL-címeit tartalmazó értékeknél --host próbáljon meg értéket megadni --account-id érték helyett --host .
--profile string
Profil az auth env for
Példák
Az alábbi példa az alapértelmezett hitelesítési környezetet kapja meg:
databricks auth env
Az alábbi példa lekéri egy adott gazdagép hitelesítési környezetét:
databricks auth env --host https://my-workspace.cloud.databricks.com
Az Azure Databricks hozzáférési jogkivonat-hitelesítéssel konfigurált profil kimenete a következő lehet:
{
"env": {
"DATABRICKS_AUTH_TYPE": "pat",
"DATABRICKS_CONFIG_PROFILE": "TEST",
"DATABRICKS_HOST": "https://my-workspace.cloud.databricks.com",
"DATABRICKS_TOKEN": "<token-value>"
}
}
Az alábbi példa lekéri egy adott profil hitelesítési környezetét:
databricks auth env --profile my-test-environment
databricks hitelesítési bejelentkezés
Jelentkezzen be egy Databricks-munkaterületre vagy -fiókba, és mentse a hitelesítési konfigurációt egy profilba ~/.databrickscfg (alapértelmezés szerint). A profil ezután használható más Databricks CLI-parancsok hitelesítésére a --profile jelölő használatával. A profil más Databricks-eszközök hitelesítésére is használható, amelyek támogatják a Databricks egységes hitelesítését, beleértve a Databricks Python, Java és Go SDK-kat is.
databricks auth login HOST [flags]
Ehhez a parancshoz meg kell adni egy Databricks-gazdagép URL-címét ( --host pozíció argumentumként vagy implicit módon a megadott profilnévből következtetve), valamint egy profilnevet (a használatával --profile). Ha nem adja meg ezeket az értékeket, a rendszer futásidőben kéri az értékek megadását.
Bár ez a parancs mindig bejelentkezteti a megadott gazdagépre, a viselkedés a konfigurációs fájlban beállított meglévő profiloktól függ ( ~/.databrickscfg alapértelmezés szerint):
- Ha létezik egy megadott nevű profil, és megad egy gazdagépet, a rendszer bejelentkezik a profil által megadott gazdagépre. A profil úgy frissül, hogy a "databricks-cli" hitelesítési típust használja, ha ez korábban nem történt meg.
- Ha a megadott névvel rendelkező profil létezik, de nem ad meg gazdagépet, a rendszer kérni fogja, hogy adjon meg egy gazdagépet. A profil frissül a megadott gazdagép használatára. A hitelesítési típus a "databricks-cli" értékre frissül, ha korábban nem ez volt a helyzet.
- Ha létezik egy megadott nevű profil, és megad egy gazdagépet, de ön egy gazdagépet ad meg a (vagy
--hosta pozíció arg) használatávalHOST, a profil frissül az újonnan megadott gazdagép használatára. A hitelesítési típus a "databricks-cli" értékre frissül, ha korábban nem ez volt a helyzet. - Ha a megadott névvel rendelkező profil nem létezik, a rendszer új profilt hoz létre a megadott gazdagéppel. A hitelesítés típusa "databricks-cli" lesz.
Érvek
HOST
Databricks-gazdagép URL-címe (nem kötelező)
Beállítások
--configure-cluster
A fürt konfigurálására vonatkozó kérések (klasszikus számítás)
--configure-serverless
A kiszolgáló nélküli számítás konfigurálására vonatkozó kérések
--timeout duration
Időtúllépés a bejelentkezési feladat böngészőben való teljesítéséhez (alapértelmezett 1h0m0s)
Példák
Az alábbi példa egy Databricks-munkaterületre jelentkezik be:
databricks auth login
Az alábbi példa egy adott Databricks-munkaterületre jelentkezik be:
databricks auth login https://my-workspace.cloud.databricks.com
Az alábbi példa egy adott profillal jelentkezik be, és konfigurálja a fürt beállításait:
databricks auth login --profile my-profile --configure-cluster
Az alábbi példa egyéni időtúllépést állít be a bejelentkezési folyamathoz:
databricks auth login --timeout 30m
databricks hitelesítési kijelentkezés
Jelentkezzen ki egy Azure Databricks profilból a gyorsítótárazott OAuth-jogkivonatok törlésével. Újra kell futtatnia databricks auth login a hitelesítést. A profil a konfigurációs fájlban marad (~/.databrickscfg alapértelmezés szerint), kivéve, ha ön is megadja --delete.
databricks auth logout [PROFILE] [flags]
Ez a viselkedés csak a (auth_typebeállítottdatabricks-cli) beállítással databricks auth login létrehozott profilokra vonatkozik. Az egyéb hitelesítési módszereket, például személyes hozzáférési jogkivonatokat vagy gépről gépre hitelesítő adatokat használó profilok nem tárolnak gyorsítótárazott OAuth-jogkivonatokat, ezért nincs mit törölni. Ha több profil is ugyanazt a gyorsítótárazott jogkivonatot használja, a kijelentkezés nem érinti a többit.
Parancs viselkedése:
- Ha megad egy profilt (argumentumként vagy argumentumként
PROFILE--profile), a parancs kijelentkezik a profilból. Megadhatja a gazdagép URL-címét is, amelyet a parancs felold az egyező profilra. Egy interaktív terminálban megerősítést kér, kivéve, ha Ön is megadja--auto-approve. - Ha kihagyja a profilt egy interaktív terminálban, a parancs egy kereshető profilválasztót jelenít meg. Kereshet profilnév, gazdagép vagy fiókazonosító alapján. Miután kiválasztott egy profilt, a parancs megerősítést kér, kivéve, ha Ön is megadja
--auto-approve. - Ha nem interaktív környezetben hagyja ki a profilt, a parancs meghiúsul, és megkéri, hogy adjon meg egy profilt.
- Nem interaktív környezetben adjon meg egy profilt, és
--auto-approvehagyja ki a megerősítést.
Érvek
PROFILE
Profilnév vagy gazdagép URL-címe a kijelentkezéshez (nem kötelező). Az argumentum először egyezik a meglévő profilnevekkel. Ha nincs egyező profil, és az argumentum gazdagép URL-címének tűnik, a parancs feloldja azt az adott gazdagéphez konfigurált profil(ok)ra. Ha több profil egyezik egy gazdagéppel, a parancssor kéri, hogy válasszon egyet (vagy nem interaktív módban felmerülő hibák).
Beállítások
--delete
Emellett távolítsa el a profilt a konfigurációs fájlból (~/.databrickscfg alapértelmezés szerint)
--auto-approve
A megerősítést kérő üzenet kihagyása
Példák
Az alábbi példa egy adott profilból naplóz:
databricks auth logout my-profile
Az alábbi példa kijelentkezik a gazdagép URL-címéhez társított profilból:
databricks auth logout https://my-workspace.cloud.databricks.com
Az alábbi példa kijelentkezteti és eltávolítja a profilt a konfigurációs fájlból:
databricks auth logout --profile my-profile --delete
Az alábbi példa a CI/CD-hez megfelelő megerősítési kérés nélkül jelentkezik ki:
databricks auth logout my-profile --auto-approve
databricks hitelesítési profilok
Listázhatja az összes elérhető konfigurációs profilt ~/.databrickscfg (alapértelmezés szerint), és ellenőrizheti, hogy érvényes profilok-e.
databricks auth profiles [flags]
Ez a parancs a következő formátumban adja ki a profilokat:
Name Host Valid
DEFAULT https://<host-url> YES
<profile-name> https://<host-url> NO
Annak megállapításához, hogy az egyes profilok érvényesek-e, a Databricks parancssori felülete felsorolja az egyes fiókszintű profilok munkaterületeit, és futtat egy aktuális felhasználói parancsot az egyes munkaterületszintű profilokhoz. Ha a parancs sikeres, megjelenik egy YES ; ellenkező esetben megjelenik egy NO .
A parancs kimenete auth profiles nem jelenít meg hozzáférési jogkivonatokat. A hozzáférési jogkivonat megjelenítéséhez lásd: databricks auth env.
A konfigurációs profilok alapértelmezés szerint Linuxon vagy macOS-en, illetve ~/.databrickscfg Windows rendszeren vannak tárolva a fájlban%USERPROFILE%\.databrickscfg. A fájl alapértelmezett elérési útját a környezeti változó DATABRICKS_CONFIG_FILEbeállításával módosíthatja.
Konfigurációs profilok létrehozásához tekintse meg a configure parancsot.
Beállítások
--skip-validate
A profilok ellenőrzésének kihagyása
Példák
Az alábbi példa az összes hitelesítési profilt felsorolja:
databricks auth profiles
Az alábbi példa a profilokat érvényesítés nélkül sorolja fel:
databricks auth profiles --skip-validate
databricks hitelesítési kapcsoló
Névvel ellátott profil beállítása alapértelmezettként a következőben ~/.databrickscfg: . A kiválasztott profil nevét a kulcs alatti konfigurációs fájl egy [__settings__] szakaszában tárolja a default_profile rendszer. Itt databricks auth profiles láthatja, hogy jelenleg melyik profil az alapértelmezett.
databricks auth switch [flags]
Beállítások
Példák
Az alábbi példa interaktívan kiválaszt egy alapértelmezettként beállított profilt:
databricks auth switch
Az alábbi példa egy adott profilt állít be alapértelmezettként:
databricks auth switch --profile my-profile
databricks hitelesítési jogkivonat
Kérje le a hitelesítési jogkivonatot a helyi gyorsítótárból a következőben ~/.databricks/token-cache.json: . Frissítse a hozzáférési jogkivonatot, ha lejárt vagy a lejárati idő közelében van. Ez a parancs csak U2M-hitelesítéssel működik (a databricks auth login parancs használatával). Az ügyfél-azonosítót és titkos kódokat használó M2M-hitelesítés nem támogatott.
databricks auth token [HOST_OR_PROFILE] [flags]
Az OAuth U2M-hitelesítés konfigurálásához és beállításához lásd : OAuth user-to-machine (U2M) hitelesítés.
Érvek
HOST_OR_PROFILE
Databricks-gazdagép URL-címe vagy profilneve (nem kötelező)
Beállítások
--account-id string
Databricks-fiók azonosítója
--force-refresh
Jogkivonat frissítésének kényszerítése akkor is, ha a gyorsítótárazott jogkivonat még érvényes.
--timeout duration
Jogkivonat beszerzésének időtúllépése. (alapértelmezett 1h0m0s)
Példák
A következő példa lekéri a hitelesítési jogkivonatot:
databricks auth token
Az alábbi példa lekéri egy adott gazdagép hitelesítési jogkivonatát:
databricks auth token https://my-workspace.cloud.databricks.com
A kimenet a következő lehet:
{
"access_token": "<token-value>",
"token_type": "Bearer",
"expiry": "<token-expiration-date-time>"
}
Az alábbi példa egyéni időtúllépést állít be a jogkivonatok beszerzéséhez:
databricks auth token --timeout 30m
Globális jelzők
--debug
Engedélyezze-e a hibakeresési naplózást.
-h vagy --help
Súgó megjelenítése a Databricks parancssori felületéhez, a kapcsolódó parancscsoporthoz vagy a kapcsolódó parancshoz.
--log-file karakterlánc
A karakterlánc, amely megadja, melyik fájlba írja az kimeneti naplókat. Ha ez a jelző nincs megadva, akkor az alapértelmezett beállítás a kimeneti naplók stderrbe írása.
--log-format formátum
A naplóformátum típusa, text vagy json. Az alapértelmezett érték a text.
--log-level karakterlánc
A naplóformátum szintjét képviselő karakterlánc. Ha nincs megadva, a naplóformátum szintje le van tiltva.
-o, --output típus
A parancs kimenetének típusa: text vagy json. Az alapértelmezett érték a text.
-p, --profile karakterlánc
A parancs futtatásához használni kívánt fájl profiljának ~/.databrickscfg neve. Ha ez a jelző nincs megadva, akkor ha létezik, a rendszer a névvel ellátott DEFAULT profilt használja.
--progress-format formátum
A folyamatnaplók megjelenítésének formátuma: default, append, inplacevagy json
-t, --target karakterlánc
Ha alkalmazható, a használni kívánt célcsomag