secrets parancscsoport

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 secretsDatabricks parancssori felületén található parancscsoport lehetővé teszi a titkos kódok, titkos hatókörök és hozzáférési engedélyek kezelését. Az adatokhoz való hozzáféréshez egyes esetekben szükség van JDBC-n keresztüli, külső adatforrásokon történő hitelesítésre. Ahelyett, hogy közvetlenül beírja a hitelesítő adatait egy jegyzetfüzetbe, használja a Databricks titkos kulcsait a hitelesítő adatok tárolásához, és hivatkozzon rájuk jegyzetfüzetekben és feladatokban. Lásd: Titkos kódok kezelése.

databricks titkos kulcsok létrehozási hatóköre

Hozzon létre egy új titkos hatókört.

A hatókör nevének alfanumerikus karakterekből, kötőjelekből, aláhúzásjelekből és pontokból kell állnia, és nem haladhatja meg a 128 karaktert.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    A felhasználó által kért hatókörnév. A hatókörnevek egyediek.

Beállítások

--initial-manage-principal string

    Az a személy vagy entitás, aki kezdetben MANAGE-engedélyt kapott a létrehozott hatókörhöz.

--json JSON

    A beágyazott JSON-sztring vagy a @path JSON-fájl a kérelem törzsével.

--scope-backend-type ScopeBackendType

    A háttérrendszer típusa, amellyel a hatókör létrejön. Támogatott értékek: AZURE_KEYVAULT, DATABRICKS

Globális jelzők

databricks titkok törlés-acl (hozzáférés-vezérlési lista)

Törölje a megadott ACL-t az adott hatókörben.

A felhasználóknak engedéllyel kell rendelkezniük a MANAGE parancs meghívásához. Megad egy hibát RESOURCE_DOES_NOT_EXIST, ha nincs ilyen titkos hatókör, alany vagy ACL. Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye az API-hívás végrehajtására.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Annak a hatókörnek a neve, amelyből engedélyeket szeretne eltávolítani.

PRINCIPAL

    A meglévő ACL eltávolításához használt tag.

Beállítások

--json JSON

    A beágyazott JSON-sztring vagy a @path JSON-fájl a kérelem törzsével.

Globális jelzők

databricks titkos kulcsok törlési hatóköre

Titkos hatókör törlése.

Eldobja RESOURCE_DOES_NOT_EXIST , ha a hatókör nem létezik. Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye a hívás elvégzésére.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    A törölni kívánt hatókör neve.

Beállítások

--json JSON

    A beágyazott JSON-sztring vagy a @path JSON-fájl a kérelem törzsével.

Globális jelzők

databricks secrets delete-secret

Törölje a titkos hatókörben tárolt titkot. Rendelkeznie kell a WRITE vagy MANAGE engedéllyel a titkos hatókörön.

Eldobja, RESOURCE_DOES_NOT_EXIST ha nincs ilyen titkos hatókör vagy titkos kód. Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye a hívás elvégzésére.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    A törölni kívánt titkos kulcsot tartalmazó hatókör neve.

KEY

    A törölni kívánt titkos kód neve.

Beállítások

--json JSON

    A beágyazott JSON-sztring vagy a @path JSON-fájl a kérelem törzsével.

Globális jelzők

databricks titkok elérésének ACL beállítása

Kérje le a megadott ACL részleteit, például a csoportot és az engedélyt. A felhasználóknak engedéllyel kell rendelkezniük az MANAGE API meghívásához.

Eldobja, RESOURCE_DOES_NOT_EXIST ha nincs ilyen titkos tárolási hatókör. Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye a hívás elvégzésére.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Annak a hatókörnek a neve, amelyből beolvassa az ACL-adatokat.

PRINCIPAL

    Az azonosító, amelyhez az ACL-információt le kell kérni.

Beállítások

Globális jelzők

databricks titkos kulcsok get-secret

Kérje le a megadott hatókör és kulcs titkos értékének bájtos ábrázolását.

A felhasználóknak engedélyre van szükségük READ a hívás indításához.

Vegye figyelembe, hogy a visszaadott titkos kód értéke bájtban van. A bájtok értelmezését a DBUtils hívója határozza meg, és az adatok típusát a program dekódolja.

Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye az API-hívás végrehajtására. Kivételt dob RESOURCE_DOES_NOT_EXIST, ha nincs ilyen titkos kulcs vagy titkos hatókör.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    Annak a hatókörnek a neve, amelyből titkos adatokat szeretne lekérni.

KEY

    A titok lekéréséhez szükséges kulcs.

Beállítások

Globális jelzők

databricks secrets list-acls – Ez a parancs a Databricks titkosításaihoz tartozó hozzáférési vezérlési listák felsorolására szolgál.

Listázni kell egy adott titkos kulcs hatókörének ACL-jeit. A felhasználóknak engedéllyel kell rendelkezniük az MANAGE API meghívásához.

Eldobja, RESOURCE_DOES_NOT_EXIST ha nincs ilyen titkos tárolási hatókör. Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye a hívás elvégzésére.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    Annak a hatókörnek a neve, amelyből beolvassa az ACL-adatokat.

Beállítások

Globális jelzők

databricks titkos kulcsok lista-hatókörei

A munkaterületen elérhető összes titkos hatókör listázása.

Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye a hívás elvégzésére.

databricks secrets list-scopes [flags]

Beállítások

Globális jelzők

databricks titkos kulcsok listája-titkos kódok

Sorolja fel az ebben a hatókörben tárolt titkos kulcsokat. Ez csak metaadat-művelet; a titkos adatok nem kérhetők le ezzel a paranccsal. A felhasználóknak engedélyre van szükségük READ a hívás indításához.

A lastUpdatedTimestamp visszaadott érték a korszak óta ezredmásodpercben van. Eldobja, RESOURCE_DOES_NOT_EXIST ha nincs ilyen titkos tárolási hatókör. Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye a hívás elvégzésére.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    Annak a hatókörnek a neve, amelyen belül a titkok felsorolását kérhetjük.

Beállítások

Globális jelzők

databricks secrets put-acl (hozzáférési lista beállítása)

Hozza létre vagy írja felül a megadott hatókörpont adott tagjával (felhasználójával vagy csoportjával) társított hozzáférés-vezérlési listát (ACL).

A felhasználók vagy csoportok általában a számukra elérhető leghatékonyabb engedélyeket használják, és az engedélyek az alábbiak szerint vannak rendezve:

  • MANAGE Módosíthatja az ACL-eket, és olvashat és írhat ebbe a titkos hatókörbe.
  • WRITE Engedélyezett az olvasás és írás ebben a titkos tartományban.
  • READ Elolvashatja ezt a titkos kulcstartományt, és listázhatja, hogy mely titkos kódok érhetők el.

Vegye figyelembe, hogy a titkos értékek általában csak egy fürt parancsán belül olvashatók (például egy jegyzetfüzeten keresztül). A tényleges titkos értékadatok fürtön kívüli beolvasására nincs API. A felhasználó engedélye azonban attól függ, hogy ki hajtja végre a parancsot, és legalább OLVASÁSi engedéllyel kell rendelkeznie.

A felhasználóknak engedéllyel kell rendelkezniük a MANAGE parancs meghívásához.

A jogosultság a Databricks egyik meglévő felhasználójához vagy csoportjához tartozó név, amelynek a hozzáférését meg kell adni vagy visszavonni.

Eldobja, RESOURCE_DOES_NOT_EXIST ha nincs ilyen titkos tárolási hatókör. Eldobja, RESOURCE_ALREADY_EXISTS ha már létezik engedély az egyszerű felhasználóhoz. Dob INVALID_PARAMETER_VALUE akkor, ha az engedély vagy a főszemély érvénytelen. Kivételt dob PERMISSION_DENIED, ha a felhasználónak nincs engedélye a hívás elvégzésére.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    Annak a hatókörnek a neve, amelyre engedélyeket kíván alkalmazni.

PRINCIPAL

    Az a jogosultság birtokosa, amelyre az engedély vonatkozik.

PERMISSION

    Az entitásra vagy felhasználóra alkalmazott engedélyszint. Támogatott értékek: MANAGE, READ, WRITE

Beállítások

--json JSON

    A beágyazott JSON-sztring vagy a @path JSON-fájl a kérelem törzsével.

Globális jelzők

databricks titkos kulcsok put-secret

Szúrjon be egy titkos kódot a megadott hatókörbe a megadott névvel. Ha egy titkos kód már létezik ugyanazzal a névvel, ez a parancs felülírja a meglévő titkos kód értékét. A kiszolgáló a titkos kulcs hatókörének titkosítási beállításaival titkosítja a titkos kulcsokat a tárolás előtt.

Rendelkeznie kell a WRITE vagy MANAGE engedéllyel a titkos hatókörön. A titkos kulcsnak alfanumerikus karakterekből, kötőjelekből, aláhúzásjelekből és pontokból kell állnia, és nem haladhatja meg a 128 karaktert. A titkos kódok maximális megengedett mérete 128 KB. Egy adott hatókör titkos kulcsainak maximális száma 1000.

Az argumentumok string-value vagy bytes-value a titkos kód típusának megadása, amely meghatározza a titkos kulcs kérésekor visszaadott értéket.

A titkos kulcs értékét háromféleképpen adhatja meg:

  • Adja meg az értéket sztringként a --string-value jelölő használatával.
  • Írja be a titkos kódot, amikor a rendszer interaktívan kéri (egysoros titkos kulcsok).
  • Adja át a titkos kódot standard bemeneten keresztül (többsoros titkos kódok).
databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    A titkos kulcs tárolására használt hatókör neve.

KEY

    A titkos kulcs neve.

Beállítások

--bytes-value string

    Ha meg van adva, az érték bájtként lesz tárolva.

--json JSON

    A beágyazott JSON-sztring vagy a @path JSON-fájl a kérelem törzsével.

--string-value string

    Ha meg van adva, vegye figyelembe, hogy az érték UTF-8 (MB4) formátumban lesz tárolva.

Globális jelzők

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 húr

    A kimeneti naplók írásához a fájlt jelképező sztring. 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 vagy textjson. Az alapértelmezett érték a text.

--log-level húr

    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 kimenettípusa vagy textjson. Az alapértelmezett érték a text.

-p, --profile húr

    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 húr

    Adott esetben a használni kívánt csomagcél