Interfejs wiersza polecenia wpisów tajnych (starsza wersja)

Uruchamiasz podpolecenia CLI sekretów usługi Databricks, dołączając je do polecenia databricks secrets. Te polecenia podrzędne wywołują Secrets API.

Aby uzyskać więcej informacji na temat wpisów tajnych, zobacz Zarządzanie wpisami tajnymi.

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.

Utwórz tajny zakres

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets create-scope --help.

databricks secrets create-scope --scope my-scope

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.

Aby skorzystać z interfejsu wiersza polecenia usługi Databricks do utworzenia zakresu tajemnic opartego na Azure Key Vault, uruchom databricks secrets create-scope --help aby wyświetlić informacje o dodatkowych opcjach: --scope-backend-type, --resource-id i --dns-name. Aby uzyskać więcej informacji, zobacz Zarządzanie tajemnicami.

Usuń sekret

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets delete --help.

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

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.

Odwołanie listy ACL dla podmiotu

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets delete-acl --help.

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

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.

Usunięcie zakresu tajnego

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets delete-scope --help.

databricks secrets delete-scope --scope my-scope

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.

Uzyskaj ACL dla podmiotu

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets get-acl --help.

databricks secrets get-acl --scope my-scope --principal someone@example.com --output JSON

{
  "principal": "sonmeone@example.com",
  "permission": "MANAGE"
}

Wymień klucze tajne przechowywane w zakresie tajnym

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets list --help.

databricks secrets list --scope my-scope --output JSON

{
  "secrets": [
    {
      "key": "my-key",
      "last_updated_timestamp": 1621284092605
    }
  ]
}

Wypisz listę ACL dla zakresu tajnego

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets list-acls --help.

databricks secrets list-acls --scope my-scope --output JSON

{
  "items": [
    {
      "principal": "someone@example.com",
      "permission": "MANAGE"
    }
  ]
}

Wypisz wszystkie dostępne zakresy tajne w obszarze roboczym

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets list-scopes --help.

databricks secrets list-scopes --output JSON

{
  "scopes": [
    {
      "name": "my-scope",
      "backend_type": "DATABRICKS"
    }
  ]
}

Tworzenie lub aktualizowanie tajemnicy

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets put --help lub databricks secrets write --help.

Istnieją trzy sposoby przechowywania tajemnicy. Najprostszym sposobem jest użycie opcji --string-value. Tajna informacja będzie przechowywana w formacie UTF-8 (MB4). Należy zachować ostrożność przy użyciu tej opcji, ponieważ wpis tajny może być przechowywany w historii wiersza polecenia w postaci zwykłego tekstu.

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

Lub:

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

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.

Możesz również użyć opcji --binary-file, aby podać tajemnicę przechowywaną w pliku. Zawartość pliku będzie odczytywana jako i przechowywana jako bajty.

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

Lub:

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

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.

Jeśli nie określisz opcji, zostanie otwarty edytor umożliwiający wprowadzenie wpisu tajnego. Postępuj zgodnie z instrukcjami wyświetlanymi w edytorze, aby wprowadzić wpis tajny.

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

Lub:

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.

Udzielanie lub zmienianie dostępu ACL do zakresu tajnego zasobu dla użytkownika lub systemu

Aby wyświetlić dokumentację użycia, uruchom polecenie databricks secrets put-acl --help lub databricks secrets write-acl --help.

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

Lub:

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

W przypadku powodzenia żadne dane wyjściowe nie są wyświetlane.