secrets 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 secrets příkazů v rozhraní příkazového řádku Databricks umožňuje spravovat tajné kódy, obory tajných kódů a přístupová oprávnění. Někdy je pro přístup k datům nutné, abyste se v externích zdrojích ověřili prostřednictvím JDBC. Místo přímého zadávání přihlašovacích údajů do poznámkového bloku použijte tajné kódy Databricks k ukládání přihlašovacích údajů a odkazování na ně v poznámkových blocích a úlohách. Viz správa tajemství.

Rozsah vytvoření tajných kódů databricks

Vytvořte nový tajný prostor.

Název oboru musí obsahovat alfanumerické znaky, pomlčky, podtržítka a tečky a nesmí být delší než 128 znaků.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Název oboru požadovaný uživatelem Názvy oborů jsou jedinečné.

Možnosti

--initial-manage-principal string

    Uživatel, kterému bylo původně uděleno oprávnění MANAGE pro vytvořený obor.

--json JSON

    Vložený řetězec JSON nebo @path soubor JSON s textem požadavku.

--scope-backend-type ScopeBackendType

    Typ back-endu, s kterým bude obor vytvořen. Podporované hodnoty: AZURE_KEYVAULT, DATABRICKS

Globální příznaky

Odstranění tajných kódů Databricks –acl

Odstraňte daný seznam ACL pro daný obor.

Uživatelé musí mít MANAGE oprávnění k vyvolání tohoto příkazu. RESOURCE_DOES_NOT_EXIST Vyvolá chybu, pokud neexistuje žádný takový obor tajných kódů, objekt zabezpečení nebo seznam ACL. Vyvolá výjimku PERMISSION_DENIED, pokud uživatel nemá oprávnění k uskutečnění tohoto API volání.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Název oboru pro odebrání oprávnění.

PRINCIPAL

    Principál pro odebrání existujícího seznamu řízení přístupu (ACL).

Možnosti

--json JSON

    Vložený řetězec JSON nebo @path soubor JSON s textem požadavku.

Globální příznaky

Rozsah odstranění tajných kódů Databricks

Odstraňte oblast tajemství.

Vyvolá výjimku RESOURCE_DOES_NOT_EXIST, pokud obor neexistuje. Vyhodí PERMISSION_DENIED, pokud uživatel nemá oprávnění k provedení tohoto volání.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    Název oboru, který chcete odstranit.

Možnosti

--json JSON

    Vložený řetězec JSON nebo @path soubor JSON s textem požadavku.

Globální příznaky

Tajné kódy databricks delete-secret

Odstraňte tajemství uložené v tomto oboru tajemství. Musíte mít oprávnění WRITE nebo MANAGE pro práci s tajným rozsahem.

RESOURCE_DOES_NOT_EXIST Vyvolá se, pokud neexistuje žádný takový obor tajného kódu nebo tajný klíč. Vyhodí PERMISSION_DENIED, pokud uživatel nemá oprávnění k provedení tohoto volání.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    Název oboru, který obsahuje tajný klíč k odstranění.

KEY

    Název tajného kódu, který chcete odstranit.

Možnosti

--json JSON

    Vložený řetězec JSON nebo @path soubor JSON s textem požadavku.

Globální příznaky

Tajné kódy databricks get-acl

Získejte podrobnosti o daném seznamu ACL, například o skupině a oprávnění. Uživatelé musí mít MANAGE oprávnění k vyvolání tohoto rozhraní API.

RESOURCE_DOES_NOT_EXIST Vyvolá výjimku, pokud neexistuje žádný takový obor tajného kódu. Vyhodí PERMISSION_DENIED, pokud uživatel nemá oprávnění k provedení tohoto volání.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Název oboru, ze kterého se načítají informace ze seznamu ACL.

PRINCIPAL

    Hlavní subjekt, pro který se načítají informace ACL.

Možnosti

Globální příznaky

Tajné kódy databricks get-secret

Získejte bajtovou reprezentaci tajné hodnoty pro zadaný obor a klíč.

Uživatelé potřebují READ oprávnění k provedení tohoto volání.

Všimněte si, že vrácená hodnota tajného kódu je v bajtech. Interpretace bajtů závisí na volajícím v DBUtils a na typu, do kterého se data dekódují.

Vyvolá výjimku PERMISSION_DENIED, pokud uživatel nemá oprávnění k uskutečnění tohoto API volání. RESOURCE_DOES_NOT_EXIST Vyvolá výjimku, pokud neexistuje žádný takový tajný klíč nebo obor tajných kódů.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    Název rozsahu pro načtení tajných informací.

KEY

    Klíč pro načtení tajného kódu.

Možnosti

Globální příznaky

Seznam acls tajných kódů databricks

Vypsat seznam ACL pro danou oblast tajemství. Uživatelé musí mít MANAGE oprávnění k vyvolání tohoto rozhraní API.

RESOURCE_DOES_NOT_EXIST Vyvolá výjimku, pokud neexistuje žádný takový obor tajného kódu. Vyhodí PERMISSION_DENIED, pokud uživatel nemá oprávnění k provedení tohoto volání.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    Název oboru, ze kterého se načítají informace ze seznamu ACL.

Možnosti

Globální příznaky

** Obory seznamů tajných klíčů Databricks

Seznam všech tajných uložišť dostupných v pracovním prostoru.

Vyhodí PERMISSION_DENIED, pokud uživatel nemá oprávnění k provedení tohoto volání.

databricks secrets list-scopes [flags]

Možnosti

Globální příznaky

Seznam tajných kódů databricks

Uveďte seznam tajných klíčů uložených v tomto rozsahu. Jedná se o operaci, která je určena pouze pro metadata; Pomocí tohoto příkazu nelze načíst tajná data. Uživatelé potřebují READ oprávnění k provedení tohoto volání.

Hodnota lastUpdatedTimestamp, která je vrácena, je v milisekundách od počátku epochy. RESOURCE_DOES_NOT_EXIST Vyvolá výjimku, pokud neexistuje žádný takový obor tajného kódu. Vyhodí PERMISSION_DENIED, pokud uživatel nemá oprávnění k provedení tohoto volání.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    Název rozsahu pro výpis tajných dat.

Možnosti

Globální příznaky

Put-acl tajných kódů databricks

Vytvořte nebo přepište seznam řízení přístupu (ACL) přidružený k danému objektu zabezpečení (uživatel nebo skupina) v zadaném bodě oboru.

Obecně platí, že uživatel nebo skupina budou používat nejvýkonnější dostupná oprávnění a oprávnění jsou seřazená takto:

• MANAGE Povoleno měnit seznamy ACL a číst a zapisovat do tohoto oboru tajných kódů.
• WRITE Povoleno číst a zapisovat do této utajené oblasti.
• READ Povoleno číst tento obor tajných kódů a zobrazit seznam dostupných tajných kódů.

Obecně platí, že tajné hodnoty se dají číst jenom z příkazu v clusteru (například prostřednictvím poznámkového bloku). Neexistuje žádné rozhraní API ke čtení skutečného materiálu hodnoty tajného kódu mimo cluster. Oprávnění uživatele se ale použije na základě toho, kdo příkaz spouští, a musí mít alespoň oprávnění KE ČTENÍ.

Uživatelé musí mít MANAGE oprávnění k vyvolání tohoto příkazu.

Principál je název uživatele nebo skupiny odpovídající existujícímu principálu v Databricks, kterému má být přístup udělen nebo odebrán.

RESOURCE_DOES_NOT_EXIST Vyvolá výjimku, pokud neexistuje žádný takový obor tajného kódu. RESOURCE_ALREADY_EXISTS Vyvolá výjimku, pokud již existuje oprávnění pro hlavní subjekt. INVALID_PARAMETER_VALUE Vyvolá chybu, pokud je oprávnění nebo objekt zabezpečení neplatný. Vyhodí PERMISSION_DENIED, pokud uživatel nemá oprávnění k provedení tohoto volání.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    Název oboru, na který se mají použít oprávnění.

PRINCIPAL

    Subjekt, na který se oprávnění použije.

PERMISSION

    Úroveň oprávnění přiřazená zástupci. Podporované hodnoty: MANAGE, READ, WRITE

Možnosti

--json JSON

    Vložený řetězec JSON nebo @path soubor JSON s textem požadavku.

Globální příznaky

Tajné kódy databricks put-secret

Vložte tajný klíč do zadaného oboru s daným názvem. Pokud tajný kód již existuje se stejným názvem, tento příkaz přepíše hodnotu existujícího tajného kódu. Server před uložením zašifruje tajemství pomocí nastavení šifrování oboru tajemství.

Musíte mít oprávnění WRITE nebo MANAGE pro práci s tajným rozsahem. Tajný klíč musí obsahovat alfanumerické znaky, pomlčky, podtržítka a tečky a nesmí být delší než 128 znaků. Maximální povolená velikost hodnoty tajného kódu je 128 kB. Maximální počet tajných kódů v daném oboru je 1000.

Argumenty string-value nebo bytes-value zadejte typ tajného klíče, který určí hodnotu vrácenou při vyžádání hodnoty tajného kódu.

Hodnotu tajného kódu můžete zadat jedním ze tří způsobů:

• Zadejte hodnotu jako řetězec pomocí příznaku --string-value .
• Po zobrazení výzvy zadejte tajný kód interaktivně (jednořádkové tajné kódy).
• Předání tajného kódu standardním vstupem (víceřádkové tajné kódy)

databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    Název oboru pro uložení tajného kódu.

KEY

    Název klíče pro tajemství.

Možnosti

--bytes-value string

    Pokud zadáte, hodnota se uloží jako bajty.

--json JSON

    Vložený řetězec JSON nebo @path soubor JSON s textem požadavku.

--string-value string

    Pokud je zadáno, všimněte si, že hodnota bude uložena ve formátu UTF-8 (MB4).

Globální příznaky

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 pro zápis výstupních protokolů do. 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 nebo textjson. 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 nebo textjson. 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 název DEFAULT profilu, 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 možné, cíl sady prostředků, který se má použít