Sdílet prostřednictvím

Rozhraní příkazového řádku tajných kódů (starší verze)

  • Článek

Důležité

Tato dokumentace byla vyřazena a nemusí být aktualizována.

Tyto informace platí pro starší verzi Rozhraní příkazového řádku Databricks verze 0.18 a novější. Databricks doporučuje místo toho použít novější rozhraní příkazového řádku Databricks verze 0.205 nebo vyšší. Podívejte se, co je rozhraní příkazového řádku Databricks? Pokud chcete zjistit svou verzi rozhraní příkazového řádku Databricks, spusťte databricks -vpříkaz .

Pokud chcete migrovat z Rozhraní příkazového řádku Databricks verze 0.18 nebo novější na Databricks CLI verze 0.205 nebo novější, přečtěte si téma Migrace rozhraní příkazového řádku Databricks.

Podpříkazy rozhraní příkazového řádku pro tajné kódy Databricks spustíte tak, že je připojíte k databricks secrets. Tyto dílčí příkazy volají rozhraní API tajných kódů.

Další informace o tajných klíči naleznete v tématu Správa tajných kódů.

Poznámka:

Rozhraní příkazového řádku tajných kódů vyžaduje Rozhraní příkazového řádku Databricks CLI 0.7.1 nebo novější.

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.

Vytvoření rozsahu tajných kódů

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets create-scope --helppříkaz .

databricks secrets create-scope --scope my-scope

V případě úspěchu se nezobrazí žádný výstup.

Pokud chcete pomocí rozhraní příkazového řádku Databricks vytvořit obor tajných kódů založený na službě Azure Key Vault, spusťte spuštěním příkazu databricks secrets create-scope --help zobrazit informace o dalších --scope-backend-type--resource-idmožnostech a --dns-name možnostech. Další informace najdete v tématu Správa tajných kódů.

Odstranění tajného kódu

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets delete --helppříkaz .

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

V případě úspěchu se nezobrazí žádný výstup.

Odvolání seznamu ACL pro objekt zabezpečení

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets delete-acl --helppříkaz .

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

V případě úspěchu se nezobrazí žádný výstup.

Odstranění rozsahu tajných kódů

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets delete-scope --helppříkaz .

databricks secrets delete-scope --scope my-scope

V případě úspěchu se nezobrazí žádný výstup.

Získání seznamu ACL pro objekt zabezpečení

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets get-acl --helppříkaz .

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

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

Výpis tajných klíčů uložených v oboru tajných kódů

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets list --helppříkaz .

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

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

Poznámka:

K tajným hodnotám nemůžete získat přístup pomocí rozhraní příkazového řádku Databricks. Pokud chcete získat přístup k hodnotám tajných kódů, musíte v poznámkovém bloku Databricks použít nástroj tajných kódů Nástrojů Databricks.

Výpis seznamů ACL pro obor tajných kódů

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets list-acls --helppříkaz .

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

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

Výpis všech dostupných oborů tajných kódů v pracovním prostoru

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets list-scopes --helppříkaz .

databricks secrets list-scopes --output JSON

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

Vytvoření nebo aktualizace tajného kódu

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets put --help nebo databricks secrets write --help.

Tajné kódy se dají uložit třemi způsoby. Nejjednodušší způsob je použít --string-value tuto možnost. Tajný kód se uloží ve formátu UTF-8 (MB4). U této možnosti byste měli být opatrní, protože tajný kód může být uložený v historii příkazového řádku ve formátu prostého textu.

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

Nebo:

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

V případě úspěchu se nezobrazí žádný výstup.

Můžete také použít --binary-file možnost zadat tajný kód uložený v souboru. Obsah souboru se bude číst tak, jak je, a uložen jako bajty.

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

Nebo:

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

V případě úspěchu se nezobrazí žádný výstup.

Pokud nezadáte možnost, otevře se editor, abyste mohli zadat tajný kód. Podle pokynů zobrazených v editoru zadejte tajný kód.

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

Nebo:

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.

Udělení nebo změna seznamu ACL na obor tajného kódu pro objekt zabezpečení

Pokud chcete zobrazit dokumentaci k použití, spusťte databricks secrets put-acl --help nebo databricks secrets write-acl --help.

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

Nebo:

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

V případě úspěchu se nezobrazí žádný výstup.