secrets kommandogrupp

The secrets command group within the Databricks CLI allows you to manage secrets, secret scopes, and access permissions. Ibland kräver åtkomst till data att du autentiserar till externa datakällor via JDBC. I stället för att ange dina autentiseringsuppgifter direkt i en notebook-fil använder du Databricks-hemligheter för att lagra dina autentiseringsuppgifter och referera till dem i notebook-filer och jobb. See Secret management.

databricks secrets create-scope

Skapa ett nytt hemligt omfång.

Omfångsnamnet måste bestå av alfanumeriska tecken, bindestreck, understreck och punkter och får inte överstiga 128 tecken.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Namn på sektionen efterfrågat av användaren. Omfångsnamn är unika.

Options

--initial-manage-principal string

    Det huvudnamn som ursprungligen beviljas MANAGE-behörighet till det skapade omfånget.

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

--scope-backend-type ScopeBackendType

    Serverdelstypen med vilken omfånget skapas. Värden som stöds: AZURE_KEYVAULT, DATABRICKS

Global flags

databricks secrets delete-acl

Ta bort den angivna ACL:en för det angivna omfånget.

Användarna måste ha MANAGE behörighet att anropa det här kommandot. Genererar RESOURCE_DOES_NOT_EXIST om det inte finns något sådant hemligt omfång, huvudnamn eller ACL. Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här API-anropet.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Namnet på omfånget som du vill ta bort behörigheter från.

PRINCIPAL

    Det huvudnamn som du vill ta bort en befintlig ACL från.

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

databricks secrets delete-scope

Ta bort ett hemligt omfång.

Genererar RESOURCE_DOES_NOT_EXIST om omfånget inte finns. Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här anropet.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    Namnet på omfånget som ska tas bort.

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

databricks hemligheter delete-secret

Ta bort hemligheten som lagras i det här hemliga omfånget. Du måste ha WRITE eller MANAGE behörighet för det hemliga omfånget.

Genererar RESOURCE_DOES_NOT_EXIST om det inte finns någon sådan hemlig omfattning eller hemlighet. Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här anropet.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    Namnet på omfånget som innehåller hemligheten som ska tas bort.

KEY

    Namnet på hemligheten som ska tas bort.

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

databricks secrets get-acl

Hämta information om den angivna ACL:en, till exempel gruppen och behörigheten. Användarna måste ha behörighet att anropa det här API:et MANAGE .

Genererar RESOURCE_DOES_NOT_EXIST om det inte finns något sådant hemligt omfång. Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här anropet.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Namnet på omfånget som ACL-information ska hämtas från.

PRINCIPAL

    Det huvudnamn som ACL-information ska hämtas för.

Options

Global flags

databricks hemligheter get-secret

Hämta byterepresentationen av ett hemligt värde för det angivna omfånget och nyckeln.

Användarna behöver behörighet att göra det här anropet READ .

Observera att det hemliga värde som returneras är i byte. Tolkningen av byte bestäms av anroparen i DBUtils och typen som data avkodas till.

Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här API-anropet. Genererar RESOURCE_DOES_NOT_EXIST om det inte finns någon sådan hemlighet eller hemlig omfattning.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    Namnet på omfånget som du vill hämta hemlig information från.

KEY

    Nyckeln att hämta hemligheten för.

Options

Global flags

databricks secrets list-acls

Visa en lista över ACL:er för ett visst hemligt omfång. Användarna måste ha behörighet att anropa det här API:et MANAGE .

Genererar RESOURCE_DOES_NOT_EXIST om det inte finns något sådant hemligt omfång. Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här anropet.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    Namnet på omfånget som ACL-information ska hämtas från.

Options

Global flags

databricks secrets list-scopes

Visa en lista över alla hemliga omfång som är tillgängliga på arbetsytan.

Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här anropet.

databricks secrets list-scopes [flags]

Options

Global flags

databricks secrets list-secrets

Visa en lista över de hemliga nycklar som lagras i det här omfånget. Det här är en åtgärd endast för metadata. det går inte att hämta hemliga data med det här kommandot. Användarna behöver behörighet att göra det här anropet READ .

Den lastUpdatedTimestamp returnerade är i millisekunder sedan epoken. Genererar RESOURCE_DOES_NOT_EXIST om det inte finns något sådant hemligt omfång. Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här anropet.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    Namnet på omfånget för att lista hemligheter inom.

Options

Global flags

databricks secrets put-acl

Skapa eller skriv över åtkomstkontrollistan (ACL) som är associerad med det angivna huvudkontot (användare eller grupp) på den angivna omfångspunkten.

I allmänhet använder en användare eller grupp den mest kraftfulla behörigheten som är tillgänglig för dem, och behörigheter sorteras enligt följande:

• MANAGE Tillåts att ändra ACL:er och läsa och skriva till det här hemliga omfånget.
• WRITE Tillåts att läsa och skriva till det här hemliga omfånget.
• READ Tillåts att läsa det här hemliga omfånget och lista vilka hemligheter som är tillgängliga.

Observera att i allmänhet kan hemliga värden bara läsas inifrån ett kommando i ett kluster (till exempel via en notebook-fil). Det finns inget API för att läsa det faktiska hemliga värdematerialet utanför ett kluster. Användarens behörighet tillämpas dock baserat på vem som kör kommandot och måste ha minst LÄS-behörighet.

Användarna måste ha MANAGE behörighet att anropa det här kommandot.

Huvudnamnet är ett användar- eller gruppnamn som motsvarar ett befintligt Databricks-huvudnamn som ska beviljas eller återkallas.

Genererar RESOURCE_DOES_NOT_EXIST om det inte finns något sådant hemligt omfång. Genererar RESOURCE_ALREADY_EXISTS om det redan finns en behörighet för huvudkontot. Genererar INVALID_PARAMETER_VALUE om behörigheten eller huvudnamnet är ogiltigt. Genererar PERMISSION_DENIED om användaren inte har behörighet att göra det här anropet.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    Namnet på det omfång som behörigheter ska tillämpas på.

PRINCIPAL

    Det huvudnamn där behörigheten tillämpas.

PERMISSION

    Behörighetsnivån som tillämpas på huvudkontot. Värden som stöds: MANAGE, READ, WRITE

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

databricks hemligheter put-secret

Infoga en hemlighet under det angivna omfånget med det angivna namnet. Om det redan finns en hemlighet med samma namn skriver det här kommandot över den befintliga hemlighetens värde. Servern krypterar hemligheten med hjälp av krypteringsinställningarna för det hemliga omfånget innan den lagras.

Du måste ha WRITE eller MANAGE behörighet för det hemliga omfånget. Den hemliga nyckeln måste bestå av alfanumeriska tecken, bindestreck, understreck och punkter och får inte överstiga 128 tecken. Den maximala tillåtna hemliga värdestorleken är 128 KB. Det maximala antalet hemligheter i ett visst omfång är 1 000.

Argumenten string-value eller bytes-value ange typen av hemlighet, vilket avgör vilket värde som returneras när det hemliga värdet begärs.

Du kan ange det hemliga värdet på något av tre sätt:

• Ange värdet som en sträng med hjälp av --string-value flaggan.
• Ange hemligheten när du uppmanas att göra det interaktivt (enkelradshemligheter).
• Skicka hemligheten via standardindata (flerradshemligheter).

databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    Namnet på omfånget som hemligheten ska lagras i.

KEY

    Nyckelnamnet för hemligheten.

Options

--bytes-value string

    Om värdet anges lagras det som byte.

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

--string-value string

    Observera att värdet lagras i UTF-8-formulär (MB4) om det anges.

Global flags

Global flags

--debug

  Om felsökningsloggning ska aktiveras.

-h eller --help

    Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.

--log-file sträng

    En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.

--log-format format

    Loggformattypen eller textjson. Standardvärdet är text.

--log-level sträng

    En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.

-o, --output typ

    Kommandots utdatatyp, text eller json. Standardvärdet är text.

-p, --profile sträng

    Namnet på profilen i filen som ~/.databrickscfg ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.

--progress-format format

    Formatet för att visa förloppsloggar: default, append, inplaceeller json

-t, --target sträng

    Om tillämpligt, paketmålet som ska användas