secrets gruppo di comandi

Note

Queste informazioni si applicano all'interfaccia della riga di comando di Databricks versione 0.205 e successive. L'interfaccia della riga di comando di Databricks è disponibile in anteprima pubblica.

L'uso della CLI di Databricks è soggetto alla Licenza di Databricks e all'Informativa sulla privacy di Databricks, incluse eventuali disposizioni sui dati di utilizzo.

Il secrets gruppo di comandi all'interno dell'interfaccia della riga di comando di Databricks consente di gestire segreti, ambiti segreti e autorizzazioni di accesso. Per l'accesso ai dati è necessario talvolta eseguire l'autenticazione a origini dati esterne tramite JDBC. Anziché immettere direttamente le credenziali in un notebook, usare i segreti di Databricks per archiviare le credenziali e farvi riferimento in notebook e processi. Vedere Gestione dei segreti.

Creazione dell'ambito di creazione dei segreti di databricks

Creare un nuovo ambito segreto.

Il nome dell'ambito deve essere costituito da caratteri alfanumerici, trattini, caratteri di sottolineatura e punti e non può superare i 128 caratteri.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Nome dell'ambito richiesto dall'utente. I nomi di ambito sono univoci.

Options

--initial-manage-principal string

    Entità principale a cui viene inizialmente concessa l'autorizzazione MANAGE per l'ambito creato.

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

--scope-backend-type ScopeBackendType

    Il tipo di back-end con cui verrà creato lo scope. Valori supportati: AZURE_KEYVAULT, DATABRICKS

Flag globali

eliminare acl dei segreti di Databricks

Eliminare l'ACL specificato nell'ambito specificato.

Gli utenti devono disporre dell'autorizzazione MANAGE per richiamare questo comando. Genera un'eccezione RESOURCE_DOES_NOT_EXIST se non esiste alcun ambito, un'entità o un elenco di controllo di accesso di questo tipo. Genera PERMISSION_DENIED se l'utente non ha l'autorizzazione per effettuare questa chiamata API.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Nome dell'ambito da cui rimuovere le autorizzazioni.

PRINCIPAL

    Entità da cui rimuovere un ACL esistente.

Options

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

Flag globali

ambito di eliminazione dei segreti di databricks

Eliminare un ambito segreto.

Genera un'eccezione RESOURCE_DOES_NOT_EXIST se l'ambito non esiste. PERMISSION_DENIED Genera un'eccezione se l'utente non dispone dell'autorizzazione per effettuare questa chiamata.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    Nome dell'ambito da eliminare.

Options

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

Flag globali

segreti di databricks delete-secret

Eliminare il segreto archiviato nell'ambito del segreto. È necessario disporre dell'autorizzazione WRITE o MANAGE per l'ambito del segreto.

Genera un'eccezione RESOURCE_DOES_NOT_EXIST se non esiste alcun ambito o segreto segreto di questo tipo. PERMISSION_DENIED Genera un'eccezione se l'utente non dispone dell'autorizzazione per effettuare questa chiamata.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nome dell'ambito che contiene il segreto da eliminare.

KEY

    Nome del segreto da eliminare.

Options

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

Flag globali

get-acl dei segreti di databricks

Ottenere i dettagli sull'ACL specificato, ad esempio il gruppo e l'autorizzazione. Gli utenti devono avere l'autorizzazione MANAGE per richiamare questa API.

RESOURCE_DOES_NOT_EXIST Genera un'eccezione se non esiste alcun ambito segreto di questo tipo. PERMISSION_DENIED Genera un'eccezione se l'utente non dispone dell'autorizzazione per effettuare questa chiamata.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    Nome dell'ambito da cui recuperare le informazioni ACL.

PRINCIPAL

    Principale da cui recuperare le informazioni ACL.

Options

Flag globali

ottenere-segreto da databricks secrets

Ottiene la rappresentazione in byte di un valore segreto per l'ambito e la chiave specificati.

Gli utenti devono disporre dell'autorizzazione READ per effettuare questa chiamata.

Si noti che il valore del segreto restituito è in byte. L'interpretazione dei byte è determinata dal chiamante in DBUtils e il tipo in cui i dati vengono decodificati.

Genera PERMISSION_DENIED se l'utente non ha l'autorizzazione per effettuare questa chiamata API. Genera RESOURCE_DOES_NOT_EXIST se non esiste alcun segreto o ambito segreto.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nome dell'ambito da cui recuperare le informazioni segrete.

KEY

    Chiave per recuperare il segreto.

Options

Flag globali

databricks secrets list-acls

Elencare le ACL per un determinato ambito segreto. Gli utenti devono avere l'autorizzazione MANAGE per richiamare questa API.

RESOURCE_DOES_NOT_EXIST Genera un'eccezione se non esiste alcun ambito segreto di questo tipo. PERMISSION_DENIED Genera un'eccezione se l'utente non dispone dell'autorizzazione per effettuare questa chiamata.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    Nome dell'ambito da cui recuperare le informazioni ACL.

Options

Flag globali

list-scope dei segreti di databricks

Elencare tutti gli ambiti segreti disponibili nell'area di lavoro.

PERMISSION_DENIED Genera un'eccezione se l'utente non dispone dell'autorizzazione per effettuare questa chiamata.

databricks secrets list-scopes [flags]

Options

Flag globali

elenca-segreti di Databricks list-secrets

Elencare le chiavi segrete archiviate in questo ambito. Si tratta di un'operazione di sola metadati; non è possibile recuperare i dati segreti usando questo comando. Gli utenti devono disporre dell'autorizzazione READ per effettuare questa chiamata.

L'oggetto lastUpdatedTimestamp restituito è espresso in millisecondi rispetto a Epoch. RESOURCE_DOES_NOT_EXIST Genera un'eccezione se non esiste alcun ambito segreto di questo tipo. PERMISSION_DENIED Genera un'eccezione se l'utente non dispone dell'autorizzazione per effettuare questa chiamata.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    Nome dell'ambito in cui elencare i segreti.

Options

Flag globali

put-acl dei segreti di databricks

Creare o sovrascrivere l'elenco di controllo di accesso (ACL) associato all'entità (utente o gruppo) specificata nel punto di ambito specificato.

In generale, un utente o un gruppo userà l'autorizzazione più potente disponibile e le autorizzazioni vengono ordinate come indicato di seguito:

• MANAGE È consentito modificare gli elenchi di controllo di accesso e leggere e scrivere in questo ambito di segreti.
• WRITE Consentito di leggere e scrivere nell'ambito del segreto.
• READ È consentito leggere questo ambito segreto e elencare i segreti disponibili.

Si noti che in generale, i valori dei segreti possono essere letti solo dall'interno di un comando in un cluster, ad esempio tramite un notebook. Non c'è un'API per leggere il materiale sostanziale del valore segreto all'esterno di un cluster. Tuttavia, l'autorizzazione dell'utente verrà applicata in base all'utente che esegue il comando e deve disporre almeno dell'autorizzazione READ.

Gli utenti devono disporre dell'autorizzazione MANAGE per richiamare questo comando.

Il principale è un nome di utente o di gruppo corrispondente a un principale Databricks esistente a cui concedere o revocare l'accesso.

RESOURCE_DOES_NOT_EXIST Genera un'eccezione se non esiste alcun ambito segreto di questo tipo. Solleva RESOURCE_ALREADY_EXISTS se esiste già un'autorizzazione per il principale. INVALID_PARAMETER_VALUE Genera un'eccezione se l'autorizzazione o l'entità non è valida. PERMISSION_DENIED Genera un'eccezione se l'utente non dispone dell'autorizzazione per effettuare questa chiamata.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    Nome dell'ambito a cui applicare le autorizzazioni.

PRINCIPAL

    Entità in cui viene applicata l'autorizzazione.

PERMISSION

    Il livello di autorizzazione applicato al principale. Valori supportati: MANAGE, READ, WRITE

Options

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

Flag globali

segreto inserisci di databricks

Inserire un segreto nell'ambito specificato con il nome specificato. Se esiste già un segreto con lo stesso nome, questo comando sovrascrive il valore del segreto esistente. Il server crittografa il segreto usando le impostazioni di crittografia dell'ambito del segreto prima di archiviarlo.

È necessario disporre dell'autorizzazione WRITE o MANAGE per l'ambito del segreto. La chiave privata deve essere costituita da caratteri alfanumerici, trattini, caratteri di sottolineatura e punti e non può superare 128 caratteri. La dimensione massima consentita del valore del segreto è 128 KB. Il numero massimo di segreti in un determinato ambito è 1000.

Gli argomenti string-value o bytes-value specificano il tipo del segreto, che determinerà il valore restituito quando viene richiesto il valore del segreto.

È possibile specificare il valore del segreto in uno dei tre modi seguenti:

• Specificare il valore come stringa usando il --string-value flag .
• Immettere il segreto quando richiesto in modo interattivo (segreti a riga singola).
• Passare il segreto tramite input standard (segreti su più righe).

databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    Nome dell'ambito in cui archiviare il segreto.

KEY

    Nome della chiave per il segreto.

Options

--bytes-value string

    Se specificato, il valore verrà archiviato come byte.

--json JSON

    Stringa JSON inline o nel @path file JSON con il corpo della richiesta.

--string-value string

    Se specificato, si noti che il valore verrà archiviato in formato UTF-8 (MB4).

Flag globali

Bandiere globali

--debug

  Indica se abilitare la registrazione di debug.

-h oppure --help

    Mostra la guida per il Databricks CLI, il gruppo di comandi correlato o il comando correlato.

--log-file corda

    Stringa che rappresenta il file in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.

--log-format formato

    Tipo di text formato del log o json. Il valore predefinito è text.

--log-level corda

    Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.

tipo

    Tipo di text output del comando o json. Il valore predefinito è text.

-p, --profile corda

    Nome del profilo nel ~/.databrickscfg file da usare per eseguire il comando . Se questo flag non viene specificato, se esiste, viene usato il profilo denominato DEFAULT .

--progress-format formato

    Formato per visualizzare i log di stato: default, append, inplaceo json

-t, --target corda

    Se applicabile, la destinazione del bundle da usare