Grupo de comandos secrets-uc

Note

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

Importante

Esse recurso está em Visualização Pública.

O secrets-uc grupo de comando dentro da CLI Databricks gerencia os segredos do Catálogo Unity. Um segredo é um objeto seguro do Unity Catalog que armazena dados sensíveis de credenciais (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 Catálogo Unity e são direcionados para um esquema dentro de um catálogo.

Databricks Secrets-UC create-secret

Cria um novo segredo no Catálogo Unity. Você deve ser o dono do esquema pai ou ter os CREATE_SECRET e USE SCHEMA privilégios no esquema pai e USE CATALOG no catálogo pai. O segredo é armazenado no catálogo e esquema especificados, e o campo de valor contém os dados sensíveis a serem armazenados de forma segura.

databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]

Arguments

NAME

    O nome do segredo, relativo ao seu esquema pai.

CATALOG_NAME

    O nome do catálogo onde residem o esquema e o segredo.

SCHEMA_NAME

    O nome do esquema onde reside o segredo.

VALUE

    O valor secreto para armazenar. Esse campo é apenas de entrada e não retorna nas respostas — use o campo effective_value (via GetSecret com include_value definido como verdadeiro) para ler o valor secreto. O tamanho máximo é de 60 KiB (antes da criptografia). O conteúdo aceito inclui senhas, tokens, chaves e outros dados sensíveis de credenciais.

Opções

--comment string

    Descrição em texto livre fornecida pelo usuário do segredo.

--expire-time string

    Tempo de expiração fornecido pelo usuário para o segredo.

--json JSON

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

--owner string

    O dono do segredo.

Sinalizadores globais

Databricks Secrets-UC Delete-Secret

Exclui um segredo pelo seu nome de três níveis (totalmente qualificado). Você deve ser o dono do segredo ou um administrador da metastore.

databricks secrets-uc delete-secret FULL_NAME [flags]

Arguments

FULL_NAME

    O nome de três níveis (totalmente qualificado) do segredo (por exemplo, catalog_name nome_de_esquema.nome_de_segredo).

Opções

Sinalizadores globais

Databricks Secrets-UC get-secret

Fica um segredo pelo nome de três níveis (totalmente qualificado). Você deve ser administrador da metastore, o dono do segredo ou ter o privilégio GERENCIAR sobre o segredo. O valor secreto não é devolvido por padrão. Para recuperá-lo, você também deve ter o privilégio READ_SECRET e definir include_value como verdadeiro na solicitação.

databricks secrets-uc get-secret FULL_NAME [flags]

Arguments

FULL_NAME

    O nome de três níveis (totalmente qualificado) do segredo (por exemplo, catalog_name nome_de_esquema.nome_de_segredo).

Opções

Sinalizadores globais

Databricks Secrets-UC list-secrets

Lista segredos no Catálogo Unity. Você deve ser administrador da metastore, o dono do segredo ou ter o privilégio GERENCIAR sobre o 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 as páginas seguintes.

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 serem retornados.

--page-size int

    Número máximo de segredos para devolver.

--schema-name string

    O nome do esquema sob o qual listar segredos.

Sinalizadores globais

Databricks Secrets-UC Update-Secret

Atualiza um segredo existente no Unity Catalog. Você deve ser o dono do segredo ou um administrador da metastore. Se você for administrador da metastore, apenas o campo proprietário pode ser alterado. Use o campo update_mask para especificar quais campos atualizar. Campos atualizáveis suportados incluem valor,comentário, proprietário e expire_time.

databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]

Arguments

FULL_NAME

    O nome de três níveis (totalmente qualificado) do segredo (por exemplo, catalog_name nome_de_esquema.nome_de_segredo).

UPDATE_MASK

    A máscara de campo especifica quais campos do segredo atualizar. Se update_mask for "*", todos os campos especificados em segredo são atualizados. Se update_mask especificar um ou mais campos, apenas esses campos são atualizados. Cada campo especificado deve ser definido em segredo. Campos suportados: valor,comentário, proprietário, expire_time. Para mudar o nome do segredo, apague e recrie o segredo.

NAME

    O nome do segredo, relativo ao seu esquema pai.

CATALOG_NAME

    O nome do catálogo onde residem o esquema e o segredo.

SCHEMA_NAME

    O nome do esquema onde reside o segredo.

VALUE

    O valor secreto para armazenar. Esse campo é apenas de entrada e não retorna nas respostas — use o campo effective_value (via GetSecret com include_value definido como verdadeiro) para ler o valor secreto. O tamanho máximo é de 60 KiB (antes da criptografia). O conteúdo aceito inclui senhas, tokens, chaves e outros dados sensíveis de credenciais.

Opções

--comment string

    Descrição em texto livre fornecida pelo usuário do segredo.

--expire-time string

    Tempo de expiração fornecido pelo usuário para o segredo.

--json JSON

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

--owner string

    O dono do segredo.

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 onde serão gravados os logs de saída. Caso esse sinalizador não seja especificado, o padrão é registrar os 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 do comando, text ou json. O valor padrão é text.

-p, --profile corda

    O nome do perfil no arquivo ~/.databrickscfg, que deverá ser usado para 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