secrets grupo de comando
Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.
Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.
O grupo de comandos secrets dentro do Databricks CLI permite gerenciar segredos, Secret Scope e permissões de acesso. Às vezes, o acesso aos dados requer que você se autentique em uma fonte de dados externa através de JDBC. Em vez de inserir diretamente suas credenciais em um Notebook, utilize os segredos do Databricks para armazenar suas credenciais e referenciá-las no Notebook e no Job. Veja Gerenciamento secreto.
segredos do databricks create-scope
Crie um novo Escopo Secreto.
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]
Argumentos
SCOPE
Nome do escopo solicitado pelo usuário. Os nomes dos escopos são exclusivos.
Opções
--initial-manage-principal string
O principal que recebe inicialmente a permissão gerenciar para o escopo criado.
--json JSON
As cadeias de caracteres JSON ou o caminho @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
segredos do databricks delete-acl
Exclua a ACL especificada no escopo indicado.
Os usuários devem ter permissão para acessar o diretório " MANAGE " para executar este comando. Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se não existir um Secret Scope, principal ou ACL. Gera uma exceção " PERMISSION_DENIED " se o usuário não tiver permissão para fazer esta chamada de API.
databricks secrets delete-acl SCOPE PRINCIPAL [flags]
Argumentos
SCOPE
O nome do escopo do qual remover as permissões.
PRINCIPAL
O principal do qual se deseja remover uma ACL existente.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
Databricks secrets 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]
Argumentos
SCOPE
Nome do escopo a ser excluído.
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
databricks secrets delete-secret
Exclua o segredo armazenado neste Escopo Secreto. É necessário ter permissão WRITE ou MANAGE no Escopo Secreto.
Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se não existir tal Secret Scope 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]
Argumentos
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
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
segredos do databricks get-acl
Obter os detalhes sobre a ACL fornecida, como o grupo e a permissão. Os usuários devem ter a permissão MANAGE para invocar esta API.
Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se não existir um Secret Scope desse tipo. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.
databricks secrets get-acl SCOPE PRINCIPAL [flags]
Argumentos
SCOPE
O nome do escopo do qual se deseja obter uma informação d ACL.
PRINCIPAL
O principal para obter informações sobre ACL.
Opções
Os segredos do Databricks ficam secretos
Obter a representação em bytes de um valor secreto para o escopo especificado e um key.
Os usuários precisam da permissão READ para fazer essa chamada.
Observe que o valor secreto retornado está em bytes. A interpretação dos bytes é determinada pelo chamador em DBUtils e pelo tipo em que os dados são decodificados.
Gera uma exceção " PERMISSION_DENIED " se o usuário não tiver permissão para fazer esta chamada de API. Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se não existir tal segredo ou Secret Scope.
databricks secrets get-secret SCOPE KEY [flags]
Argumentos
SCOPE
O nome do escopo do qual as informações secretas devem ser obtidas.
KEY
key , para obter o segredo.
Opções
lista de segredos do databricks - acls
Liste as ACLs para um determinado Escopo Secreto. Os usuários devem ter a permissão MANAGE para invocar esta API.
Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se não existir um Secret Scope desse tipo. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.
databricks secrets list-acls SCOPE [flags]
Argumentos
SCOPE
O nome do escopo do qual se deseja obter uma informação d ACL.
Opções
escopos da lista de segredos do databricks
Listar todos os Secret Scope disponíveis no workspace.
Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.
databricks secrets list-scopes [flags]
Opções
lista de segredos do databricks - segredos
Liste as chaves secretas armazenadas neste escopo. Esta é uma operação apenas de metadados; dados secretos não podem ser recuperados utilizando este comando. Os usuários precisam da permissão READ para fazer essa chamada.
O lastUpdatedTimestamp retornado está em milissegundos desde a Epoch. Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se não existir um Secret Scope desse tipo. Lança PERMISSION_DENIED se o usuário não tiver permissão para fazer essa chamada.
databricks secrets list-secrets SCOPE [flags]
Argumentos
SCOPE
O nome do escopo no qual listar segredos.
Opções
segredos do databricks 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, e as permissões são ordenadas da seguinte forma:
MANAGEAutorizado a alterar ACLs e ler e gravar neste Escopo Secreto.WRITEAutorizado a ler e escrever neste Escopo Secreto.READAutorizado a ler este Escopo Secreto e listar quais segredos estão disponíveis.
Observe que, em geral, os valores secretos só podem ser lidos a partir de um comando em um clustering (por exemplo, por meio de um Notebook). Não existe um API para ler o valor secreto real fora de um agrupamento. No entanto, a permissão do usuário será aplicada com base em quem está executando o comando, e ele deve ter pelo menos permissão de LEITURA.
Os usuários devem ter a permissão MANAGE para invocar este comando.
O principal é um nome de usuário ou grupo correspondente a um principal Databricks existente ao qual será concedido ou revogado o acesso.
Gera uma exceção " RESOURCE_DOES_NOT_EXIST " se não existir um Secret Scope desse tipo. Lança RESOURCE_ALREADY_EXISTS se já existir uma permissão para o diretor. Lança INVALID_PARAMETER_VALUE se a permissão ou o principal forem inválidos. 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]
Argumentos
SCOPE
O nome do escopo ao qual aplicar permissões.
PRINCIPAL
O principal no qual a permissão é aplicada.
PERMISSION
O nível de permissão aplicado ao diretor. Valores suportados: MANAGE, READ, WRITE
Opções
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
segredos de databricks colocados em segredo
Insira um segredo no escopo fornecido com o nome fornecido. Se já existir um segredo com o mesmo nome, este comando substituirá o valor do segredo existente. O servidor criptografa o segredo utilizando as configurações de criptografia do Escopo Secreto antes de armazená-lo.
É necessário ter permissão para acessar o escopo secreto ( WRITE ou MANAGE ). 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 em um determinado escopo é 1000.
Os argumentos string-value ou bytes-value especificam 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 string utilizando o sinalizador
--string-value. - Insira o segredo quando solicitado de forma interativa (segredos de linha única).
- Passe o segredo por meio da entrada padrão (segredos de várias linhas).
databricks secrets put-secret SCOPE KEY [flags]
Argumentos
SCOPE
O nome do escopo no qual armazenar o segredo.
KEY
O nome do segredo no key.
Opções
--bytes-value string
Se especificado, o valor será armazenado como bytes.
--json JSON
As cadeias de caracteres JSON ou o caminho @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
--debug
Se deve habilitar o registro de depuração.
-h ou --help
Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.
--log-file string
Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.
--log-format Formato
O tipo de formato do log, text ou json. O valor de default é text.
--log-level string
Uma string que representa o nível de formato do log. Se não for especificado, o nível de formato do log será desativado.
-o, --output Tipo
O tipo de saída do comando, text ou json. O valor de default é text.
-p, --profile string
O nome do perfil no arquivo ~/.databrickscfg a ser utilizado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil chamado DEFAULT será usado.
--progress-format Formato
O formato para exibir o progresso logs: default, append, inplace ou json
-t, --target string
Se aplicável, o destino do pacote a ser usado