Grupo de comandos secrets

O secrets grupo de comandos dentro da CLI do Databricks permite que você gerencie segredos, escopos secretos e permissões de acesso. Às vezes, o acesso aos dados exige que você se autentique em fontes de dados externas por meio do JDBC. Em vez de inserir diretamente suas credenciais em um notebook, use os segredos do Databricks para armazenar suas credenciais e referenciá-las em notebooks e trabalhos. Confira Gerenciamento de segredos.

databricks secrets create-scope

Crie um novo escopo de segredo.

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

databricks secrets create-scope SCOPE [flags]

Arguments

SCOPE

    Nome de escopo solicitado pelo usuário. Nomes de escopo são exclusivos.

Opções

--initial-manage-principal string

    Entidade de segurança que inicialmente recebeu permissão MANAGE para o escopo criado.

--json JSON

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

--scope-backend-type ScopeBackendType

    O tipo de backend com o qual o escopo será criado. Valores com suporte: AZURE_KEYVAULT, DATABRICKS

Sinalizadores globais

databricks secrets delete-acl

Exclui a ACL determinada no escopo fornecido.

Os usuários devem ter permissão MANAGE para invocar esse comando. Lançará RESOURCE_DOES_NOT_EXIST se nenhum escopo secreto, entidade de segurança ou ACL existir. Gerará PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada à API.

databricks secrets delete-acl SCOPE PRINCIPAL [flags]

Arguments

SCOPE

    O nome do escopo do qual as permissões devem ser removidas.

PRINCIPAL

    A entidade de segurança da qual remover uma ACL.

Opções

--json JSON

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

Sinalizadores globais

escopo de exclusão de segredos do databricks

Excluir um escopo de segredo.

Lançará RESOURCE_DOES_NOT_EXIST se o escopo não existir. Gerará 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 inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

segredos do databricks delete-secret

Exclua o segredo armazenado nesse escopo secreto. Você deve ter permissões WRITE ou MANAGE no escopo de segredo.

Lançará RESOURCE_DOES_NOT_EXIST se nenhum escopo secreto ou segredo existir. Gerará 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 ser excluído.

Opções

--json JSON

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

Sinalizadores globais

databricks secrets get-acl

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

Lançará RESOURCE_DOES_NOT_EXIST se esse escopo secreto não existir. Gerará 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 no qual buscará informações de ACL.

PRINCIPAL

    A entidade de segurança para a qual buscará informações de ACL.

Opções

Sinalizadores globais

obtenha-segredo do databricks secrets

Obtenha a representação de bytes de um valor de segredo para o escopo e a chave especificados.

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

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

Gerará PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada à API. Lançará RESOURCE_DOES_NOT_EXIST se nenhum escopo secreto ou segredo existir.

databricks secrets get-secret SCOPE KEY [flags]

Arguments

SCOPE

    O nome do escopo no qual buscará informações de segredo.

KEY

    A chave para a qual buscar o segredo.

Opções

Sinalizadores globais

databricks secrets list-acls

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

Lançará RESOURCE_DOES_NOT_EXIST se esse escopo secreto não existir. Gerará 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 no qual buscará informações de ACL.

Opções

Sinalizadores globais

escopos de lista de segredos do databricks

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

Gerará PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.

databricks secrets list-scopes [flags]

Opções

Sinalizadores globais

databricks secrets list-secrets

Liste as chaves secretas armazenadas nesse 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.

O lastUpdatedTimestamp retornado está em milissegundos desde Época. Lançará RESOURCE_DOES_NOT_EXIST se esse escopo secreto não existir. Gerará 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 no qual listar segredos.

Opções

Sinalizadores globais

databricks secrets put-acl

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

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

• MANAGE Permite alterar ACLs e ler e gravar no escopo de segredo.
• WRITE Permite ler e gravar no escopo de segredo.
• READ Permite ler o escopo de segredo e listar os segredos disponíveis.

Observe que, em geral, os valores secretos só podem ser lidos de dentro de um comando em um cluster (por exemplo, por meio de um notebook). 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 ele deve ter pelo menos a permissão READ.

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

A entidade de segurança é um nome de usuário ou grupo correspondente a uma entidade de segurança do Databricks existente que terá acesso concedido ou revogado.

Lançará RESOURCE_DOES_NOT_EXIST se esse escopo secreto não existir. Lançará RESOURCE_ALREADY_EXISTS se uma permissão para a entidade de segurança já existir. Gerará INVALID_PARAMETER_VALUE se a permissão ou a entidade de segurança for inválida. Gerará 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 à entidade de segurança. Valores com suporte: MANAGE, READ, WRITE

Opções

--json JSON

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

Sinalizadores globais

segredos do databricks put-secret

Insira um segredo no escopo fornecido com o nome fornecido. Se já existir um segredo com o mesmo nome, esse comando substituirá o valor do segredo existente. O servidor criptografa o segredo usando as configurações de criptografia do escopo de segredo antes de o armazenar.

Você deve ter permissões WRITE ou MANAGE no escopo de segredo. A chave secreta deve consistir em caracteres alfanuméricos, traços, sublinhados e períodos e não pode exceder 128 caracteres. O tamanho máximo do valor do segredo permitido é de 128 KB. O número máximo de segredos em um determinado escopo é 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 do segredo de uma das três maneiras:

• Especifique o valor como uma cadeia de caracteres usando o --string-value sinalizador.
• Insira o segredo quando solicitado de forma interativa (segredos de linha única).
• Passe o segredo por meio de entrada padrão (segredos de várias linhas).

databricks secrets put-secret SCOPE KEY [flags]

Arguments

SCOPE

    O nome do escopo no qual restaurar o segredo.

KEY

    O nome da chave para o segredo.

Opções

--bytes-value string

    Se especificado, o valor será armazenado como bytes.

--json JSON

    A cadeia de caracteres JSON inserida em linha 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 formulário UTF-8 (MB4).

Sinalizadores globais

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

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

--log-file corda

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

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    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á desabilitado.

-o, --output tipo

    O tipo de saída de comando, text ou json. O valor padrão é text.

-p, --profile corda

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

--progress-format formato

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

-t, --target corda

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