Pular para o conteúdo principal

Secrets CLI (legado)

important

Essa documentação foi descontinuada e pode não estar atualizada.

Esta informação se aplica ao legado Databricks CLI versões 0.18 e abaixo. Databricks recomenda que o senhor use a versão mais recente do Databricks CLI 0.205 ou o acima. Consulte O que é a CLI do Databricks? Para encontrar sua versão do site Databricks CLI, execute databricks -v.

Para migrar de Databricks CLI versão 0.18 ou abaixo para Databricks CLI versão 0.205 ou acima, consulte Databricks CLI migration.

O senhor executa Databricks secrets CLI subcomandos anexando-os a databricks secrets. Esses subcomandos chamam a API Secrets.

Para obter mais informações sobre segredos, consulte Gerenciamento de segredos.

nota

O Secrets CLI requer Databricks CLI 0.7.1 ou acima.

Bash
databricks secrets --help
Usage: databricks secrets [OPTIONS] COMMAND [ARGS]...

  Utility to interact with secret API.

Options:
  -v, --version   [VERSION]
  --profile TEXT  CLI connection profile to use. The default profile is
                  "DEFAULT".
  -h, --help      Show this message and exit.

Commands:
  create-scope  Creates a secret scope.
    Options:
      --scope SCOPE                  The name of the secret scope.
      --initial-manage-principal     The initial principal that can manage the created secret scope.
                                      If specified, the initial ACL with MANAGE permission applied
                                      to the scope is assigned to the supplied principal (user or group).
                                      The only supported principal is the group
                                      "users", which contains all users in the workspace. If not
                                      specified, the initial ACL with MANAGE permission applied to
                                      the scope is assigned to request issuer's user identity.
  delete        Deletes a secret.
    Options:
      --scope SCOPE                  The name of the secret scope.
      --key KEY                      The name of secret key.
  delete-acl    Deletes an access control rule for a principal.
    Options:
      --scope SCOPE                  The name of the scope.
      --principal PRINCIPAL          The name of the principal.
  delete-scope  Deletes a secret scope.
    Options:
      --scope SCOPE                  The name of the secret scope.
  get-acl       Gets the details for an access control rule.
    Options:
      --scope SCOPE                  The name of the secret scope.
      --principal PRINCIPAL          The name of the principal.
      --output FORMAT                JSON or TABLE. Set to TABLE by default.
  list          Lists all the secrets in a scope.
    Options:
      --scope SCOPE                  The name of the secret scope.
      --output FORMAT                JSON or TABLE. Set to TABLE by default.
  list-acls     Lists all access control rules for a given secret scope.
    Options:
      --scope SCOPE                  The name of the secret scope.
      --output FORMAT                JSON or TABLE. Set to TABLE by default.
  list-scopes   Lists all secret scopes.
      --output FORMAT                JSON or TABLE. Set to TABLE by default.
  put           Puts a secret in a scope.
    Options:
      --scope SCOPE                  The name of the secret scope.
      --key KEY                      The name of the secret key.
      --string-value TEXT            Read value from string and stored in UTF-8 (MB4) form
      --binary-file PATH             Read value from binary-file and stored as bytes.
  put-acl       Creates or overwrites an access control rule for a principal
                applied to a given secret scope.
    Options:
      --scope SCOPE                    The name of the secret scope.
      --principal PRINCIPAL            The name of the principal.
      --permission [MANAGE|WRITE|READ] The permission to apply.
  write         Puts a secret in a scope. "write" is an alias for "put".
    Options:
      --scope SCOPE                  The name of the secret scope.
      --key KEY                      The name of the secret key.
      --string-value TEXT            Read value from string and stored in UTF-8 (MB4) form
      --binary-file PATH             Read value from binary-file and stored as bytes.
  write-acl     Creates or overwrites an access control rule for a principal
                applied to a given secret scope. "write-acl" is an alias for
                "put-acl".
    Options:
      --scope SCOPE                    The name of the secret scope.
      --principal PRINCIPAL            The name of the principal.
      --permission [MANAGE|WRITE|READ] The permission to apply.

Criar um escopo secreto​

Para exibir a documentação de uso, execute databricks secrets create-scope --help.

Bash
databricks secrets create-scope --scope my-scope

Se for bem-sucedido, nenhuma saída será exibida.

Excluir um segredo​

Para exibir a documentação de uso, execute databricks secrets delete --help.

Bash
databricks secrets delete --scope my-scope --key my-key

Se for bem-sucedido, nenhuma saída será exibida.

Revogar uma ACL para um principal​

Para exibir a documentação de uso, execute databricks secrets delete-acl --help.

Bash
databricks secrets delete-acl --scope my-scope --principal someone@example.com

Se for bem-sucedido, nenhuma saída será exibida.

Excluir um escopo secreto​

Para exibir a documentação de uso, execute databricks secrets delete-scope --help.

Bash
databricks secrets delete-scope --scope my-scope

Se for bem-sucedido, nenhuma saída será exibida.

Obter uma ACL para um diretor​

Para exibir a documentação de uso, execute databricks secrets get-acl --help.

Bash
databricks secrets get-acl --scope my-scope --principal someone@example.com --output JSON
Console
{
  "principal": "sonmeone@example.com",
  "permission": "MANAGE"
}

Liste a chave secreta armazenada em um escopo secreto​

Para exibir a documentação de uso, execute databricks secrets list --help.

Bash
databricks secrets list --scope my-scope --output JSON
Console
{
  "secrets": [
    {
      "key": "my-key",
      "last_updated_timestamp": 1621284092605
    }
  ]
}
nota

O senhor não pode acessar os valores secretos usando a CLI do Databricks. Para acessar os valores secretos, o senhor deve usar o utilitário Databricks utilidades secrets utilidades em um Notebook Databricks.

Listar as ACLs para um escopo secreto​

Para exibir a documentação de uso, execute databricks secrets list-acls --help.

Bash
databricks secrets list-acls --scope my-scope --output JSON
Console
{
  "items": [
    {
      "principal": "someone@example.com",
      "permission": "MANAGE"
    }
  ]
}

Liste todos os escopos secretos disponíveis no workspace​

Para exibir a documentação de uso, execute databricks secrets list-scopes --help.

Bash
databricks secrets list-scopes --output JSON
Console
{
  "scopes": [
    {
      "name": "my-scope",
      "backend_type": "DATABRICKS"
    }
  ]
}

Crie ou atualize um segredo​

Para exibir a documentação de uso, execute databricks secrets put --help ou databricks secrets write --help.

Há três maneiras de guardar um segredo. A maneira mais fácil é usar a opção --string-value; o segredo será armazenado no formato UTF-8 (MB4). O senhor deve ter cuidado com essa opção, pois seu segredo pode ser armazenado no histórico da linha de comando em texto simples.

Bash
databricks secrets put --scope my-scope --key my-key --string-value my-value

Ou:

Bash
databricks secrets write --scope my-scope --key my-key --string-value my-value

Se for bem-sucedido, nenhuma saída será exibida.

Você também pode usar a opção --binary-file para fornecer um segredo armazenado em um arquivo. O conteúdo do arquivo será lido como está e armazenado como bytes.

Bash
databricks secrets put --scope my-scope --key my-key --binary-file my-secret.txt

Ou:

Bash
databricks secrets write --scope my-scope --key my-key --binary-file my-secret.txt

Se for bem-sucedido, nenhuma saída será exibida.

Se você não especificar uma opção, um editor será aberto para você inserir seu segredo. Siga as instruções mostradas no editor para inserir seu segredo.

Bash
databricks secrets put --scope my-scope --key my-key

Ou:

Bash
databricks secrets write --scope my-scope --key my-key
Console

# ----------------------------------------------------------------------
# Do not edit the above line. Everything below it will be ignored.
# Please input your secret value above the line. Text will be stored in
# UTF-8 (MB4) form and any trailing new line will be stripped.
# Exit without saving will abort writing secret.

Conceder ou alterar um ACL para um escopo secreto para um diretor​

Para exibir a documentação de uso, execute databricks secrets put-acl --help ou databricks secrets write-acl --help.

Bash
databricks secrets put-acl --scope my-scope --principal someone@example.com --permission MANAGE

Ou:

Bash
databricks secrets write-acl --scope my-scope --principal someone@example.com --permission MANAGE

Se for bem-sucedido, nenhuma saída será exibida.

Última atualização em