secrets-uc Befehlsgruppe

Note

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Important

Dieses Feature befindet sich in der Public Preview.

Die secrets-uc Befehlsgruppe innerhalb der Databricks-CLI verwaltet die Unity-Katalog-Geheimnisse. Ein Secret ist ein Unity Catalog securable Objekt, das sensible Zugangsdaten (wie Passwörter, Token und Schlüssel) innerhalb eines dreistufigen Namensraums speichert (catalog_name.schema_name.secret_name). Geheimnisse können mit den Standardrechten des Unity-Katalogs verwaltet werden und sind auf ein Schema innerhalb eines Katalogs beschränkt.

Databricks Secrets-UC Create-Secret

Erstellt ein neues Geheimnis im Unity-Katalog. Du musst Eigentümer des Elternschemas sein oder die CREATE_SECRET und USE SCHEMA Rechte auf dem Elternschema und USE CATALOG im Elternkatalog haben. Das Geheimnis wird im angegebenen Katalog und Schema gespeichert, und das Wertfeld enthält die sensiblen Daten, die sicher gespeichert werden sollen.

databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]

Arguments

NAME

    Der Name des Geheimnisses, relativ zu seinem Elternschema.

CATALOG_NAME

    Der Name des Katalogs, in dem sich das Schema und das Geheimnis befinden.

SCHEMA_NAME

    Der Name des Schemas, in dem das Geheimnis liegt.

VALUE

    Der geheime Wert zum Speichern. Dieses Feld ist nur eingabebasiert und wird in Antworten nicht zurückgegeben – verwenden Sie das effective_value-Feld (über GetSecret mit include_value auf true gesetzt), um den Secret-Wert auszulesen. Die maximale Größe beträgt 60 KiB (vor der Verschlüsselung). Akzeptierte Inhalte umfassen Passwörter, Tokens, Schlüssel und andere sensible Zugangsdaten.

Options

--comment string

    Vom Nutzer bereitgestellte freie Textbeschreibung des Geheimnisses.

--expire-time string

    Vom Nutzer bereitgestellte Verfallszeit des Geheimnisses.

--json JSON

    Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.

--owner string

    Der Besitzer des Geheimnisses.

Globale Kennzeichnungen

Databricks Secrets-UC delete-secret

Löscht ein Geheimnis durch seinen dreistufigen (vollständig qualifizierten) Namen. Du musst der Besitzer des Geheimnisses oder ein Metastore-Admin sein.

databricks secrets-uc delete-secret FULL_NAME [flags]

Arguments

FULL_NAME

    Der dreistufige (vollständig qualifizierte) Name des Geheimnisses (zum Beispiel catalog_name.schema_name.secret_name).

Options

Globale Kennzeichnungen

Databricks Secrets-UC get-secret

Bekommt ein Geheimnis durch seinen dreistufigen (vollständig qualifizierten) Namen. Du musst ein Metastore-Administrator sein, der Besitzer des Geheimnisses sein oder das VERWALTUNGSRECHT für das Geheimnis haben. Der geheime Wert wird standardmäßig nicht zurückgegeben. Um sie abzurufen, musst du außerdem das READ_SECRET Privileg haben und include_value in der Anfrage auf wahr setzen.

databricks secrets-uc get-secret FULL_NAME [flags]

Arguments

FULL_NAME

    Der dreistufige (vollständig qualifizierte) Name des Geheimnisses (zum Beispiel catalog_name.schema_name.secret_name).

Options

Globale Kennzeichnungen

Databricks secrets-uc list-secrets

Listet Geheimnisse im Unity-Katalog auf. Du musst ein Metastore-Administrator sein, der Besitzer des Geheimnisses sein oder das VERWALTUNGSRECHT für das Geheimnis haben. Sowohl catalog_name als auch schema_name müssen gemeinsam angegeben werden, um Geheimnisse innerhalb eines bestimmten Schemas zu filtern. Die Ergebnisse sind paginiert; Verwenden Sie das page_token-Feld aus der Antwort , um nachfolgende Seiten abzurufen.

databricks secrets-uc list-secrets [flags]

Options

--catalog-name string

    Der Name des Katalogs, unter dem Geheimnisse aufgelistet werden.

--limit int

    Maximale Anzahl der zurückzugebenden Ergebnisse.

--page-size int

    Maximale Anzahl an Geheimnissen, die zurückgegeben werden müssen.

--schema-name string

    Der Name des Schemas, unter dem Geheimnisse aufgelistet werden sollen.

Globale Kennzeichnungen

Databricks Secrets-UC Update-Secret

Aktualisiert ein bestehendes Geheimnis im Unity-Katalog. Du musst der Besitzer des Geheimnisses oder ein Metastore-Admin sein. Wenn du ein Metastore-Administrator bist, kann nur das Eigentümerfeld geändert werden. Verwenden Sie das Feld update_mask , um anzugeben, welche Felder aktualisiert werden sollen. Unterstützte updatierbare Felder sind Wert,Kommentar, Besitzer und expire_time.

databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]

Arguments

FULL_NAME

    Der dreistufige (vollständig qualifizierte) Name des Geheimnisses (zum Beispiel catalog_name.schema_name.secret_name).

UPDATE_MASK

    Die Feldmaske gibt an, welche Felder des Geheimnisses aktualisiert werden sollen. Wenn update_mask"*" ist, werden alle im Secret angegebenen Felder aktualisiert. Wenn update_mask ein oder mehrere Felder angibt, werden nur diese Felder aktualisiert. Jedes angegebene Feld muss geheim gesetzt werden. Unterstützte Felder: Wert,Kommentar, Eigentümer, expire_time. Um den Geheimnamen zu ändern, löschen und erstellen Sie das Geheimnis erneut.

NAME

    Der Name des Geheimnisses, relativ zu seinem Elternschema.

CATALOG_NAME

    Der Name des Katalogs, in dem sich das Schema und das Geheimnis befinden.

SCHEMA_NAME

    Der Name des Schemas, in dem das Geheimnis liegt.

VALUE

    Der geheime Wert zum Speichern. Dieses Feld ist nur eingabebasiert und wird in Antworten nicht zurückgegeben – verwenden Sie das effective_value-Feld (über GetSecret mit include_value auf true gesetzt), um den Secret-Wert auszulesen. Die maximale Größe beträgt 60 KiB (vor der Verschlüsselung). Akzeptierte Inhalte umfassen Passwörter, Tokens, Schlüssel und andere sensible Zugangsdaten.

Options

--comment string

    Vom Nutzer bereitgestellte freie Textbeschreibung des Geheimnisses.

--expire-time string

    Vom Nutzer bereitgestellte Verfallszeit des Geheimnisses.

--json JSON

    Die Inline-JSON-Zeichenfolge oder die JSON-Datei mit dem @path Anforderungstext.

--owner string

    Der Besitzer des Geheimnisses.

Globale Kennzeichnungen

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel