Aller au contenu principal
Dernière mise à jour le

Secrets CLI (hérité)

important

Cette documentation a été retirée et pourrait ne pas être mise à jour.

Ces informations s'appliquent aux anciennes versions de la CLI Databricks 0.18 et antérieures. Databricks vous recommande d'utiliser plutôt la version 0.205 ou ultérieure de Databricks CLI. Voir CLI Databricks. Pour trouver votre version de la CLI Databricks, exécutez databricks -v.

Pour migrer de Databricks CLI version 0.18 ou inférieure vers Databricks CLI version 0.205 ou supérieure, consultez la migration de Databricks CLI.

Vous exécutez les sous-commandes Databricks secrets CLI en les ajoutant à databricks secrets. Ces sous-commandes appellent l'API Secrets.

Pour plus d'informations sur les secrets, consultez Gestion des secrets.

remarque

Le CLI Secrets nécessite Databricks CLI 0.7.1 ou une version ultérieure.

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.

Créez un Secret Scope​

Pour afficher la documentation d'utilisation, exécutez databricks secrets create-scope --help.

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

En cas de succès, aucune sortie n'est affichée.

Supprimer un secret​

Pour afficher la documentation d'utilisation, exécutez databricks secrets delete --help.

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

En cas de succès, aucune sortie n'est affichée.

Révoquer une ACL pour un principal​

Pour afficher la documentation d'utilisation, exécutez databricks secrets delete-acl --help.

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

En cas de succès, aucune sortie n'est affichée.

Supprimer un Secret Scope​

Pour afficher la documentation d'utilisation, exécutez databricks secrets delete-scope --help.

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

En cas de succès, aucune sortie n'est affichée.

Obtenir une ACL pour un principal​

Pour afficher la documentation d'utilisation, exécutez 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"
}

Lister les clés secrètes stockées dans un Secret Scope​

Pour afficher la documentation d'utilisation, exécutez databricks secrets list --help.

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

Vous ne pouvez pas accéder aux valeurs secrètes en utilisant la CLI Databricks. Pour accéder aux valeurs secrètes, vous devez utiliser l'utilitaire de secrets des utilitaires Databricks dans un notebook Databricks.

Lister les ACL pour un Secret Scope​

Pour afficher la documentation d'utilisation, exécutez databricks secrets list-acls --help.

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

Lister tous les Secret Scope disponibles dans le Workspace​

Pour afficher la documentation d'utilisation, exécutez databricks secrets list-scopes --help.

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

Créer ou mettre à jour un secret​

Pour afficher la documentation d'utilisation, exécutez databricks secrets put --help ou databricks secrets write --help.

Il existe trois façons de stocker un secret. Le moyen le plus simple est d'utiliser l'option --string-value ; le secret sera stocké au format UTF-8 (MB4). Vous devez faire attention avec cette option, car votre secret peut être stocké en texte brut dans l'historique de votre ligne de commande.

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

En cas de succès, aucune sortie n'est affichée.

Vous pouvez également utiliser l'option --binary-file pour fournir un secret stocké dans un fichier. Le contenu du fichier sera lu tel quel et stocké en octets.

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

En cas de succès, aucune sortie n'est affichée.

Si vous ne spécifiez aucune option, un éditeur s'ouvrira pour que vous puissiez saisir votre secret. Suivez les instructions affichées dans l'éditeur pour saisir votre secret.

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.

Accorder ou modifier une ACL à un Secret Scope pour un principal​

Pour afficher la documentation d'utilisation, exécutez 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

En cas de succès, aucune sortie n'est affichée.

Sur cette page