Anmerkung
Der Zugriff auf diese Seite erfordert eine Genehmigung. Du kannst versuchen, dich anzumelden oder die Verzeichnisse zu wechseln.
Der Zugriff auf diese Seite erfordert eine Genehmigung. Du kannst versuchen , die Verzeichnisse zu wechseln.
Note
Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.
Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.
Mit secrets der Befehlsgruppe in der Databricks CLI können Sie geheime Schlüssel, geheime Bereiche und Zugriffsberechtigungen verwalten. Für den Zugriff auf Daten ist es manchmal erforderlich, dass Sie sich über JDBC bei externen Datenquellen authentifizieren. Anstatt Ihre Anmeldeinformationen direkt in ein Notizbuch einzugeben, verwenden Sie Databricks-Geheimschlüssel, um Ihre Anmeldeinformationen zu speichern und in Notizbüchern und Aufträgen darauf zu verweisen. Siehe Verwaltung von Geheimnissen.
databricks secrets create-scope
Erstellen Sie einen neuen geheimen Bereich.
Der Bereichsname muss aus alphanumerischen Zeichen, Gedankenstrichen, Unterstrichen und Punkten bestehen und darf 128 Zeichen nicht überschreiten.
databricks secrets create-scope SCOPE [flags]
Arguments
SCOPE
Vom Benutzer angeforderter Bereichsname. Bereichsnamen sind eindeutig.
Options
--initial-manage-principal string
Der Prinzipal, der zunächst die Berechtigung MANAGE für den erstellten Bereich erhält.
--json JSON
Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.
--scope-backend-type ScopeBackendType
Der Backend-Typ, mit dem der Bereich erstellt werden soll. Unterstützte Werte: AZURE_KEYVAULT, DATABRICKS
databricks secrets delete-acl
Löschen Sie die angegebene Zugriffskontrollliste (ACL) für den angegebenen Bereich.
Benutzer müssen über die MANAGE Berechtigung zum Aufrufen dieses Befehls verfügen. Löst RESOURCE_DOES_NOT_EXIST aus, wenn kein solcher Geheimnisbereich, Prinzipal oder keine ACL vorhanden ist. Löst aus, wenn der Benutzer nicht über die Berechtigung zum Ausführen dieses API-Aufrufs PERMISSION_DENIED verfügt.
databricks secrets delete-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
Der Name des Bereichs, aus dem Berechtigungen entfernt werden sollen.
PRINCIPAL
Der Prinzipal, aus dem eine vorhandene ACL entfernt werden soll.
Options
--json JSON
Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.
databricks secrets delete-scope (löscht einen Bereich)
Einen geheimen Bereich löschen.
Löst RESOURCE_DOES_NOT_EXIST aus, wenn der Geltungsbereich nicht existiert. Löst PERMISSION_DENIED aus, wenn der Benutzer keine Berechtigung für diesen Aufruf hat.
databricks secrets delete-scope SCOPE [flags]
Arguments
SCOPE
Name des zu löschenden Bereichs.
Options
--json JSON
Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.
databricks secrets delete-secret
Löschen Sie das Geheimnis, das in diesem geheimen Bereich gespeichert ist. Sie müssen über die Berechtigung WRITE oder MANAGE für den Geheimnisbereich verfügen.
Löst RESOURCE_DOES_NOT_EXIST aus, wenn kein solcher Geheimnisbereich oder Geheimnis vorhanden ist. Löst PERMISSION_DENIED aus, wenn der Benutzer keine Berechtigung für diesen Aufruf hat.
databricks secrets delete-secret SCOPE KEY [flags]
Arguments
SCOPE
Der Name des Bereichs, der den zu löschenden Geheimschlüssel enthält.
KEY
Der Name des zu löschenden Geheimschlüssels.
Options
--json JSON
Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.
databricks secrets get-acl
Rufen Sie die Details zu der angegebenen ACL ab, z. B. die Gruppe und die zugehörigen Berechtigungen. Benutzer müssen über die MANAGE Berechtigung zum Aufrufen dieser API verfügen.
Löst RESOURCE_DOES_NOT_EXIST aus, wenn kein solcher Geheimnisbereich vorhanden ist. Löst PERMISSION_DENIED aus, wenn der Benutzer keine Berechtigung für diesen Aufruf hat.
databricks secrets get-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
Der Name des Geltungsbereichs, aus dem ACL-Informationen abgerufen werden sollen.
PRINCIPAL
Der Prinzipal, für den ACL-Informationen abgerufen werden sollen.
Options
databricks secrets get-secret
Erhalten Sie die Byte-Darstellung eines geheimen Werts für den angegebenen Schlüssel und Bereich.
Benutzer benötigen die READ Berechtigung, diesen Anruf zu tätigen.
Beachten Sie, dass der zurückgegebene geheime Wert in Bytes liegt. Die Interpretation der Bytes wird durch den Aufrufer in DBUtils und den Typ, in den die Daten dekodiert werden, bestimmt.
Löst aus, wenn der Benutzer nicht über die Berechtigung zum Ausführen dieses API-Aufrufs PERMISSION_DENIED verfügt. Löst RESOURCE_DOES_NOT_EXIST aus, wenn kein solcher Secret oder Secret-Bereich existiert.
databricks secrets get-secret SCOPE KEY [flags]
Arguments
SCOPE
Der Name des Bereichs, aus dem geheime Informationen abgerufen werden sollen.
KEY
Der Schlüssel, für den das Secret geholt werden soll.
Options
databricks secrets list-acls
Listet die ACLs für einen bestimmten Secret Bereich auf. Benutzer müssen über die MANAGE Berechtigung zum Aufrufen dieser API verfügen.
Löst RESOURCE_DOES_NOT_EXIST aus, wenn kein solcher Geheimnisbereich vorhanden ist. Löst PERMISSION_DENIED aus, wenn der Benutzer keine Berechtigung für diesen Aufruf hat.
databricks secrets list-acls SCOPE [flags]
Arguments
SCOPE
Der Name des Geltungsbereichs, aus dem ACL-Informationen abgerufen werden sollen.
Options
databricks secrets list-scopes
Listet alle geheimen Bereiche auf, die im Arbeitsbereich verfügbar sind.
Löst PERMISSION_DENIED aus, wenn der Benutzer keine Berechtigung für diesen Aufruf hat.
databricks secrets list-scopes [flags]
Options
databricks secrets list-secrets
Listen Sie die geheimen Schlüssel auf, die in diesem Bereich gespeichert sind. Dies ist ein Nur-Metadaten-Vorgang; Geheime Daten können nicht mit diesem Befehl abgerufen werden. Benutzer benötigen die READ Berechtigung, diesen Anruf zu tätigen.
Das zurückgegebene lastUpdatedTimestamp ist in Millisekunden seit Epoch. Löst RESOURCE_DOES_NOT_EXIST aus, wenn kein solcher Geheimnisbereich vorhanden ist. Löst PERMISSION_DENIED aus, wenn der Benutzer keine Berechtigung für diesen Aufruf hat.
databricks secrets list-secrets SCOPE [flags]
Arguments
SCOPE
Der Name des Bereichs, in dem Geheimnisse aufgelistet werden.
Options
databricks secrets put-acl
Erstellen oder überschreiben Sie die Zugriffssteuerungsliste (Access Control List, ACL), die dem angegebenen Prinzipal (Benutzer oder Gruppe) für den angegebenen Bereichspunkt zugeordnet ist.
Im Allgemeinen verwendet ein Benutzer oder eine Gruppe die leistungsstärkste Berechtigung, die ihnen zur Verfügung steht, und Berechtigungen werden wie folgt sortiert:
-
MANAGEBietet die Möglichkeit, ACLs zu ändern und in diesem Secret-Bereich zu lesen und zu schreiben. -
WRITEErlaubt das Lesen und Schreiben in diesem Secret Bereich. -
READDarf auf diesen geheimen Bereich zugreifen und auflisten, welche Geheimnisse verfügbar sind.
Beachten Sie, dass geheime Werte im Allgemeinen nur innerhalb eines Befehls in einem Cluster gelesen werden können (z. B. über ein Notizbuch). Es gibt keine API, um das tatsächliche Material für geheime Werte außerhalb eines Clusters zu lesen. Die Berechtigung des Benutzers wird jedoch basierend darauf angewendet, wer den Befehl ausführt, und er muss mindestens über LESEberechtigung verfügen.
Benutzer müssen über die MANAGE Berechtigung zum Aufrufen dieses Befehls verfügen.
Das Prinzipal ist ein Benutzer- oder Gruppenname, der einem bestehenden Databricks Prinzipal entspricht, dem der Zugriff gewährt oder entzogen werden soll.
Löst RESOURCE_DOES_NOT_EXIST aus, wenn kein solcher Geheimnisbereich vorhanden ist. Löst RESOURCE_ALREADY_EXISTS aus, wenn bereits eine Berechtigung für den Prinzipal vorhanden ist. Löst INVALID_PARAMETER_VALUE aus, wenn die Berechtigung oder das Prinzipal ungültig ist. Löst PERMISSION_DENIED aus, wenn der Benutzer keine Berechtigung für diesen Aufruf hat.
databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]
Arguments
SCOPE
Der Name des Bereichs, auf den Berechtigungen angewendet werden sollen.
PRINCIPAL
Das Prinzipal, auf das die Berechtigung angewendet wird.
PERMISSION
Die Berechtigungsebene, die auf den Prinzipal angewendet wird. Unterstützte Werte: MANAGE, READ, WRITE
Options
--json JSON
Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.
databricks geheime Geheimnisse
Fügen Sie unter dem angegebenen Bereich ein Geheimnis mit dem angegebenen Namen ein. Wenn bereits ein Geheimschlüssel mit demselben Namen vorhanden ist, überschreibt dieser Befehl den Wert des vorhandenen geheimen Schlüssels. Der Server verschlüsselt das Geheimnis mithilfe der Verschlüsselungseinstellungen des Geheimhaltungsbereichs, bevor es gespeichert wird.
Sie müssen über die Berechtigung WRITE oder MANAGE für den Geheimnisbereich verfügen. Der geheime Schlüssel muss aus alphanumerischen Zeichen, Gedankenstrichen, Unterstrichen und Punkten bestehen und darf 128 Zeichen nicht überschreiten. Die maximal zulässige Größe des geheimen Schlüssels beträgt 128 KB. Die maximale Anzahl geheimer Schlüssel in einem bestimmten Bereich beträgt 1000.
Die Argumente string-value oder bytes-value geben den Typ des geheimen Schlüssels an, der den Wert bestimmt, der zurückgegeben wird, wenn der geheime Wert angefordert wird.
Sie können den geheimen Wert auf drei Arten angeben:
- Geben Sie den Wert als Zeichenfolge mit dem
--string-valueFlag an. - Geben Sie das Geheimnis ein, wenn Sie interaktiv aufgefordert werden (einzeilige Geheimnisse).
- Übergeben Sie den geheimen Schlüssel über die Standardeingabe (mehrzeilige geheime Schlüssel).
databricks secrets put-secret SCOPE KEY [flags]
Arguments
SCOPE
Der Name des Bereichs, in dem das Geheimnis gespeichert werden soll.
KEY
Der Schlüsselname für das Geheimnis.
Options
--bytes-value string
Wenn angegeben, wird der Wert als Bytes gespeichert.
--json JSON
Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.
--string-value string
Wenn angegeben, beachten Sie, dass der Wert in UTF-8 (MB4)-Formular gespeichert wird.
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