Geheimen-CLI

Notitie

Voor de Secrets CLI is Databricks CLI 0.7.1 of hoger vereist.

U kunt CLI-subcommands voor Databricks-geheimen uitvoeren door ze toe te voeren aan databricks secrets .

Zie Geheimbeheer voor meer informatie over geheimen.

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.

Een geheim bereik maken

Voer uit om gebruiksdocumentatie weer te databricks secrets create-scope --help geven.

databricks secrets create-scope --scope my-scope

Als dit lukt, wordt er geen uitvoer weergegeven.

Als u de Databricks CLI wilt gebruiken om een geheim bereik Azure Key Vault, moet u uitvoeren om informatie weer te geven over aanvullende databricks secrets create-scope --help--scope-backend-type opties , en --resource-id--dns-name . Zie Geheimen voor meer informatie.

Een geheim verwijderen

Voer uit om gebruiksdocumentatie weer te databricks secrets delete --help geven.

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

Als dit lukt, wordt er geen uitvoer weergegeven.

Een ACL voor een principal intrekken

Voer uit om gebruiksdocumentatie weer te databricks secrets delete-acl --help geven.

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

Als dit lukt, wordt er geen uitvoer weergegeven.

Een geheim bereik verwijderen

Voer uit om gebruiksdocumentatie weer te databricks secrets delete-scope --help geven.

databricks secrets delete-scope --scope my-scope

Als dit lukt, wordt er geen uitvoer weergegeven.

Een ACL voor een principal krijgen

Voer uit om gebruiksdocumentatie weer te databricks secrets get-acl --help geven.

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

De geheime sleutels die zijn opgeslagen binnen een geheim bereik

Voer uit om gebruiksdocumentatie weer te databricks secrets list --help geven.

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

Notitie

U hebt geen toegang tot geheime waarden met behulp van de Databricks CLI. Als u toegang wilt krijgen tot geheime waarden, moet u het hulpprogramma Databricks Utilities secrets in een Databricks-notebook gebruiken.

De ACL's voor een geheim bereik

Voer uit om gebruiksdocumentatie weer te databricks secrets list-acls --help geven.

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

Een lijst met alle beschikbare geheime scopes in de werkruimte maken

Voer uit om gebruiksdocumentatie weer te databricks secrets list-scopes --help geven.

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

Een geheim maken of bijwerken

Voer of uit om gebruiksdocumentatie databricks secrets put --help weer te databricks secrets write --help geven.

Er zijn drie manieren om een geheim op te slaan. De eenvoudigste manier is om de optie te gebruiken. Het geheim wordt --string-value opgeslagen in de vorm UTF-8 (MB4). Wees voorzichtig met deze optie, omdat uw geheim kan worden opgeslagen in de geschiedenis van de opdrachtregel in tekst zonder tekst.

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

Of:

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

Als dit lukt, wordt er geen uitvoer weergegeven.

U kunt ook de optie --binary-file gebruiken om een geheim op te geven dat is opgeslagen in een bestand. De bestandsinhoud wordt als het goed is gelezen en opgeslagen als bytes.

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

Of:

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

Als dit lukt, wordt er geen uitvoer weergegeven.

Als u geen optie opgeeft, wordt er een editor geopend waarin u uw geheim kunt invoeren. Volg de instructies in de editor om uw geheim in te voeren.

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

Of:

databricks secrets write --scope my-scope --key my-key

# ----------------------------------------------------------------------
# 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.

Een ACL verlenen of wijzigen in een geheim bereik voor een principal

Voer of uit om gebruiksdocumentatie databricks secrets put-acl --help weer te databricks secrets write-acl --help geven.

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

Of:

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

Als dit lukt, wordt er geen uitvoer weergegeven.