Partilhar via


secrets grupo de comando

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Pré-Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer disposições de Dados de Uso.

O secrets grupo de comandos dentro da CLI Databricks permite-lhe gerir segredos, escopos secretos e permissões de acesso. Por vezes, o acesso a dados requer que se autentique em origens de dados externas através de JDBC. Em vez de inserir diretamente suas credenciais em um bloco de anotações, use os segredos do Databricks para armazenar suas credenciais e consultá-las em blocos de anotações e trabalhos. Consulte Gestão secreta.

Databricks Secrets Create-Scope

Crie um novo escopo de segredo.

O nome do escopo deve consistir em caracteres alfanuméricos, traços, sublinhados e pontos, e não pode exceder 128 caracteres.

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Nome do escopo solicitado pelo usuário. Os nomes de escopo são exclusivos.

Opções

--initial-manage-principal string

    A entidade de segurança que recebe inicialmente a permissão MANAGE para o escopo criado.

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--scope-backend-type ScopeBackendType

    O tipo de back-end com o qual o escopo será criado. Valores suportados: AZURE_KEYVAULT, DATABRICKS

Bandeiras globais

databricks segredos delete-acl

Elimine o ACL fornecido no escopo especificado.

Os usuários devem ter a MANAGE permissão para invocar esse comando. Lança RESOURCE_DOES_NOT_EXIST se não existir tal escopo secreto, principal ou ACL. Lança PERMISSION_DENIED se o utilizador não tiver permissão para fazer a chamada à API.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    O nome do escopo de que se devem remover permissões.

PRINCIPAL

    A entidade da qual remover uma ACL existente.

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

segredos do databricks delete-scope

Excluir um escopo secreto.

Lança RESOURCE_DOES_NOT_EXIST se o escopo não existir. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets delete-scope SCOPE [flags]

Arguments

SCOPE

    Nome do escopo a ser excluído.

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

databricks segredos delete-secret

Exclua o segredo armazenado neste escopo secreto. Você deve ter WRITE ou MANAGE permissão para o âmbito secreto.

Lança RESOURCE_DOES_NOT_EXIST se não existir tal escopo secreto ou segredo. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets delete-secret SCOPE KEY [flags]

Arguments

SCOPE

    O nome do escopo que contém o segredo a ser excluído.

KEY

    Nome do segredo a eliminar.

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

databricks segredos get-acl

Obtenha os detalhes sobre a ACL fornecida, como o grupo e a permissão. Os usuários devem ter a MANAGE permissão para invocar essa API.

Lança RESOURCE_DOES_NOT_EXIST se não existir tal espaço secreto. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets get-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    O nome do escopo do qual buscar informações de ACL.

PRINCIPAL

    O principal para o qual buscar informações de ACL.

Opções

Bandeiras globais

databricks segredos obter-segredo

Obtenha a representação em bytes de um valor secreto para o escopo especificado e a chave.

Os usuários precisam da READ permissão para fazer essa chamada.

Observe que o valor secreto retornado é em bytes. A interpretação dos bytes é determinada pelo chamador em DBUtils e o tipo em que os dados são decodificados.

Lança PERMISSION_DENIED se o utilizador não tiver permissão para fazer a chamada à API. Lança RESOURCE_DOES_NOT_EXIST se não existir tal segredo ou escopo secreto.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    O nome do escopo para obter dados confidenciais.

KEY

    A chave para obter a chave secreta.

Opções

Bandeiras globais

Em databricks, utilize o comando "secrets list-acls" para listar as ACLs dos segredos.

Liste as ACLs de um determinado escopo secreto. Os usuários devem ter a MANAGE permissão para invocar essa API.

Lança RESOURCE_DOES_NOT_EXIST se não existir tal espaço secreto. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets list-acls SCOPE [flags]

Arguments

SCOPE

    O nome do escopo do qual buscar informações de ACL.

Opções

Bandeiras globais

Comando Databricks secrets list-scopes

Liste todos os escopos secretos disponíveis no espaço de trabalho.

Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets list-scopes [flags]

Opções

Bandeiras globais

databricks segredos lista segredos

Liste as chaves secretas armazenadas neste escopo. Esta é uma operação somente de metadados; dados secretos não podem ser recuperados usando este comando. Os usuários precisam da READ permissão para fazer essa chamada.

Desde o Epoch, o lastUpdatedTimestamp retornado é em milissegundos. Lança RESOURCE_DOES_NOT_EXIST se não existir tal espaço secreto. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets list-secrets SCOPE [flags]

Arguments

SCOPE

    O nome do escopo para listar os segredos.

Opções

Bandeiras globais

databricks segredos put-acl

Crie ou substitua a Lista de Controle de Acesso (ACL) associada ao principal (usuário ou grupo) no ponto de escopo especificado.

Em geral, um usuário ou grupo usará a permissão mais poderosa disponível para ele, e as permissões são ordenadas da seguinte maneira:

  • MANAGE Permite alterar ACLs e ler e gravar neste escopo secreto.
  • WRITE Permissão para ler e escrever neste escopo secreto.
  • READ Permissão para ler este escopo secreto e listar quais segredos estão disponíveis.

Observe que, em geral, os valores secretos só podem ser lidos de dentro de um comando em um cluster (por exemplo, através de um bloco de anotações). Não há nenhuma API para ler o material de valor secreto real fora de um cluster. No entanto, a permissão do usuário será aplicada com base em quem está executando o comando, e eles devem ter pelo menos a permissão READ.

Os usuários devem ter a MANAGE permissão para invocar esse comando.

O principal é um nome de usuário ou grupo correspondente a um principal Databricks existente para concessão ou revogação de acesso.

Lança RESOURCE_DOES_NOT_EXIST se não existir tal espaço secreto. Lança RESOURCE_ALREADY_EXISTS se já existir uma permissão para o principal. Lança INVALID_PARAMETER_VALUE se a permissão ou principal for inválida. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]

Arguments

SCOPE

    O nome do escopo ao qual aplicar permissões.

PRINCIPAL

    A entidade principal na qual a permissão é aplicada.

PERMISSION

    O nível de permissão aplicado ao principal. Valores suportados: MANAGE, READ, WRITE

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

databricks segredos put-secret

Insira um segredo dentro do escopo fornecido com o nome indicado. Se já existir um segredo com o mesmo nome, este comando substitui o valor do segredo existente. O servidor criptografa o segredo usando as configurações de criptografia do escopo secreto antes de armazená-lo.

Você deve ter WRITE ou MANAGE permissão para o âmbito secreto. A chave secreta deve consistir em caracteres alfanuméricos, traços, sublinhados e pontos, e não pode exceder 128 caracteres. O tamanho máximo permitido do valor secreto é 128 KB. O número máximo de segredos num determinado âmbito é 1000.

Os argumentos string-value ou bytes-value especificar o tipo do segredo, que determinará o valor retornado quando o valor secreto for solicitado.

Você pode especificar o valor secreto de uma das três maneiras:

  • Especifique o valor como uma cadeia de caracteres usando o --string-value sinalizador.
  • Insira o segredo quando solicitado interativamente (segredos de linha única).
  • Passe o segredo através da entrada padrão (segredos de várias linhas).
databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    O nome do escopo no qual armazenar o segredo.

KEY

    O nome-chave para o segredo.

Opções

--bytes-value string

    Se especificado, o valor será armazenado como bytes.

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--string-value string

    Se especificado, observe que o valor será armazenado no formato UTF-8 (MB4).

Bandeiras globais

Bandeiras globais

--debug

  Se o log de depuração deve ser habilitado.

-h ou --help

    Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

    Uma cadeia de caracteres que representa o arquivo para gravar logs de saída. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.

--log-format Formato

    O tipo text de formato de log ou json. O valor predefinido é text.

--log-level string

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desativado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor predefinido é text.

-p, --profile string

    O nome do perfil no ~/.databrickscfg arquivo a ser usado para executar o comando. Se esse sinalizador não for especificado, se ele existir, o perfil nomeado DEFAULT será usado.

--progress-format Formato

    O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target string

    Se aplicável, o destino do pacote a ser usado