grupo de comandosecrets-uc
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.
Visualização
Esse recurso está em Pré-lançamento público.
O grupo de comandos secrets-uc dentro da CLI do Databricks gerencia segredos do Unity Catalog. Um segredo é um objeto protegível do Unity Catalog que armazena dados de credenciais confidenciais (como senhas, tokens e chaves) dentro de um namespace de três níveis (catalog_name.schema_name.secret_name). Os segredos podem ser gerenciados usando permissões padrão do Unity Catalog e têm escopo definido para um esquema dentro de um catálogo.
databricks secrets-uc create-secret
Cria um novo segredo no Unity Catalog. Você deve ser o proprietário do esquema pai ou ter os privilégios CREATE_SECRET e USE SCHEMA no esquema pai e USE CATALOG no catálogo pai. O segredo é armazenado no catálogo e esquema especificados, e o campo value contém os dados confidenciais a serem armazenados com segurança.
databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Argumentos
NAME
O nome do segredo, relativo ao seu esquema pai.
CATALOG_NAME
O nome do catálogo onde o esquema e o segredo residem.
SCHEMA_NAME
O nome do esquema onde o segredo reside.
VALUE
O valor secreto a ser armazenado. Este campo é apenas de entrada e não é retornado nas respostas — use o campo effective_value (via GetSecret com include_value definido como true) para ler o valor secreto. O tamanho máximo é 60 KiB (pré-criptografia). O conteúdo aceito inclui senhas, tokens, chaves e outros dados de credenciais sensíveis.
Opções
--comment string
Descrição em texto livre fornecida pelo usuário do segredo.
--expire-time string
Tempo de expiração do segredo fornecido pelo usuário.
--json JSON
A string JSON inline ou o @path para o arquivo JSON com o corpo da solicitação.
--owner string
O proprietário do segredo.
databricks secrets-uc delete-secret
Exclui um segredo pelo seu nome de três níveis (totalmente qualificado). Você deve ser o proprietário do segredo ou um administrador do metastore.
databricks secrets-uc delete-secret FULL_NAME [flags]
Argumentos
FULL_NAME
O nome de três níveis (totalmente qualificado) do segredo (por exemplo, catalog_name.schema_name.secret_name ).
Opções
databricks secrets-uc get-secret
Obtém um segredo pelo seu nome de três níveis (totalmente qualificado). Você deve ser um administrador do metastore, o proprietário do segredo ou ter o privilégio de gerenciar no segredo. O valor secreto não é retornado por default. Para recuperá-lo, você também deve ter o privilégio READ_SECRET e definir include_value como true na solicitação.
databricks secrets-uc get-secret FULL_NAME [flags]
Argumentos
FULL_NAME
O nome de três níveis (totalmente qualificado) do segredo (por exemplo, catalog_name.schema_name.secret_name ).
Opções
databricks secrets-uc list-secrets
Lista segredos no Unity Catalog. Você deve ser um administrador do metastore, o proprietário do segredo ou ter o privilégio de gerenciar no segredo. Tanto catalog_name quanto schema_name devem ser especificados juntos para filtrar segredos dentro de um esquema específico. Os resultados são paginados; use o campo page_token da resposta para recuperar páginas subsequentes.
databricks secrets-uc list-secrets [flags]
Opções
--catalog-name string
O nome do catálogo sob o qual listar segredos.
--limit int
Número máximo de resultados a retornar.
--page-size int
Número máximo de segredos a retornar.
--schema-name string
O nome do esquema sob o qual listar segredos.
databricks secrets-uc update-secret
Atualiza um segredo existente no Unity Catalog. Você deve ser o proprietário do segredo ou um administrador do metastore. Se você for um administrador do metastore, apenas o campo owner poderá ser alterado. Use o campo update_mask para especificar quais campos atualizar. Os campos atualizáveis suportados incluem value , comment , owner e expire_time .
databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Argumentos
FULL_NAME
O nome de três níveis (totalmente qualificado) do segredo (por exemplo, catalog_name.schema_name.secret_name ).
UPDATE_MASK
A máscara de campo que especifica quais campos do segredo devem ser atualizados. Se update_mask for "*" , todos os campos especificados em secret serão atualizados. Se update_mask especificar um ou mais campos, apenas esses campos serão atualizados. Cada campo especificado deve ser definido em secret . Campos compatíveis: value , comment , owner , expire_time . Para alterar o nome secreto, exclua e recrie o segredo.
NAME
O nome do segredo, relativo ao seu esquema pai.
CATALOG_NAME
O nome do catálogo onde o esquema e o segredo residem.
SCHEMA_NAME
O nome do esquema onde o segredo reside.
VALUE
O valor secreto a ser armazenado. Este campo é apenas de entrada e não é retornado nas respostas — use o campo effective_value (via GetSecret com include_value definido como true) para ler o valor secreto. O tamanho máximo é 60 KiB (pré-criptografia). O conteúdo aceito inclui senhas, tokens, chaves e outros dados de credenciais sensíveis.
Opções
--comment string
Descrição em texto livre fornecida pelo usuário do segredo.
--expire-time string
Tempo de expiração do segredo fornecido pelo usuário.
--json JSON
A string JSON inline ou o @path para o arquivo JSON com o corpo da solicitação.
--owner string
O proprietário do segredo.
Sinalizadores globais
--debug
Se deve habilitar o log de depuração.
-h ou --help
Exibe a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.
--log-file string
Uma string que representa o arquivo no qual os logs de saída serão gravados. Se este sinalizador não for especificado, o default será gravar os logs de saída em stderr.
--log-format Formato
O tipo de formato de log, text ou json. O valor default é text.
--log-level string
Uma string 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 default é text.
-p, --profile string
O nome do perfil no arquivo ~/.databrickscfg a ser usado para execução do comando. Se este sinalizador não for especificado, então, se existir, o perfil chamado 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