メインコンテンツまでスキップ

Secrets CLI (レガシー)

important

このドキュメントは廃止されており、更新されない可能性があります。

この情報は、従来の Databricks CLI バージョン 0.18 以下に適用されます。 Databricks では、代わりに新しい Databricks CLI バージョン 0.205 以降を使用することをお勧めします。 「Databricks CLI とは」を参照してください。Databricks CLI のバージョンを確認するには、 databricks -vを実行します。

Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行するには、「 Databricks CLI の移行」を参照してください。

Databricks secrets CLI サブコマンドを実行するには、それらを databricks secrets. これらのサブコマンドは 、Secrets API を呼び出します。

シークレットの詳細については、「 シークレットの管理」を参照してください。

注記

シークレット CLI には、Databricks CLI 0.7.1 以降が必要です。

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.

シークレットスコープを作成する​

使用方法のドキュメントを表示するには、 databricks secrets create-scope --helpを実行します。

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

成功した場合、出力は表示されません。

シークレットを削除する​

使用方法のドキュメントを表示するには、 databricks secrets delete --helpを実行します。

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

成功した場合、出力は表示されません。

プリンシパルの ACL を取り消す​

使用方法のドキュメントを表示するには、 databricks secrets delete-acl --helpを実行します。

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

成功した場合、出力は表示されません。

シークレットスコープを削除する​

使用方法のドキュメントを表示するには、 databricks secrets delete-scope --helpを実行します。

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

成功した場合、出力は表示されません。

プリンシパルの ACL を取得する​

使用方法のドキュメントを表示するには、 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"
}

シークレットスコープ内に格納されているシークレットキーを一覧表示する​

使用方法のドキュメントを表示するには、 databricks secrets list --helpを実行します。

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

Databricks CLI を使用してシークレット値にアクセスすることはできません。 シークレット値にアクセスするには、Databricks Databricksノートブック内で ユーティリティ secrets ユーティリティ を使用する必要があります。

シークレットスコープの ACL を一覧表示する​

使用方法のドキュメントを表示するには、 databricks secrets list-acls --helpを実行します。

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

ワークスペースで使用可能なすべてのシークレットスコープを一覧表示する​

使用方法のドキュメントを表示するには、 databricks secrets list-scopes --helpを実行します。

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

シークレットを作成または更新する​

使用方法のドキュメントを表示するには、 databricks secrets put --help または databricks secrets write --helpを実行します。

シークレットを保存するには、3つの方法があります。 最も簡単な方法は、 --string-value オプションを使用することです。 シークレットは UTF-8 (MB4) 形式で格納されます。 このオプションには注意が必要です。 シークレットは、コマンドライン履歴にプレーンテキストで保存される場合があります。

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

又は：

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

成功した場合、出力は表示されません。

--binary-fileオプションを使用して、ファイルに保存されているシークレットを指定することもできます。ファイルの内容は次のようになります そのまま読み取り、バイトとして格納します。

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

又は：

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

成功した場合、出力は表示されません。

オプションを指定しない場合は、シークレットを入力するためのエディターが開きます。 表示される指示に従ってください エディターでシークレットを入力します。

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

又は：

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.

ACL をプリンシパルのシークレットスコープに付与または変更する​

使用方法のドキュメントを表示するには、 databricks secrets put-acl --help または databricks secrets write-acl --helpを実行します。

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

又は：

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

成功した場合、出力は表示されません。

に最終更新