Udostępnij za pośrednictwem

Interfejs wiersza polecenia wpisów tajnych (starsza wersja)

  • Artykuł

Ważne

Ta dokumentacja została wycofana i może nie zostać zaktualizowana.

Te informacje dotyczą starszych wersji interfejsu wiersza polecenia usługi Databricks w wersji 0.18 i poniżej. Usługa Databricks zaleca użycie nowszego interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Zobacz Co to jest interfejs wiersza polecenia usługi Databricks?. Aby znaleźć swoją wersję interfejsu wiersza polecenia usługi Databricks, uruchom polecenie databricks -v.

Aby przeprowadzić migrację z interfejsu wiersza polecenia usługi Databricks w wersji 0.18 lub nowszej do interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej, zobacz Migracja interfejsu wiersza polecenia usługi Databricks.

Uruchamiasz polecenia interfejsu wiersza polecenia interfejsu wiersza polecenia usługi Databricks, dołączając je do polecenia databricks secrets. Te podpolecenia wywołają interfejs API wpisów tajnych.

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

Uwaga

Interfejs wiersza polecenia wpisy tajne wymaga interfejsu wiersza polecenia usługi Databricks w wersji 0.7.1 lub nowszej.

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.

Tworzenie zakresu wpisów tajnych

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 użyć interfejsu wiersza polecenia usługi Databricks do utworzenia zakresu wpisów tajnych opartego na usłudze Azure Key Vault, uruchom polecenie databricks secrets create-scope --help , aby wyświetlić informacje o dodatkowych --scope-backend-typeopcjach , --resource-idi --dns-name . Aby uzyskać więcej informacji, zobacz Zarządzanie wpisami tajnymi.

Usuń klucz tajny

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ływanie listy ACL dla podmiotu zabezpieczeń

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.

Usuwanie zakresu wpisu 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.

Uzyskiwanie listy ACL dla podmiotu zabezpieczeń

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"
}

Wyświetlanie listy kluczy tajnych przechowywanych w zakresie wpisu tajnego

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
    }
  ]
}

Uwaga

Nie można uzyskać dostępu do wartości wpisów tajnych przy użyciu interfejsu wiersza polecenia usługi Databricks. Aby uzyskać dostęp do wartości wpisów tajnych, należy użyć narzędzia do obsługi wpisów tajnych usługi Databricks w notesie usługi Databricks.

Wyświetlanie listy ACL dla zakresu wpisu 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"
    }
  ]
}

Wyświetlanie listy wszystkich dostępnych zakresów wpisów tajnych 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 wpisu tajnego

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

Istnieją trzy sposoby przechowywania wpisu tajnego. Najprostszym sposobem jest użycie opcji . Wpis tajny będzie przechowywany w formularzu --string-value 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ć --binary-file opcji , aby podać wpis tajny przechowywany 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 listy ACL na zakres wpisu tajnego dla podmiotu zabezpieczeń

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.