シークレットSecrets

シークレットは、秘密のマテリアルを格納するキーと値のペアであり、秘密のスコープ内で一意のキー名を持ちます。A secret is a key-value pair that stores secret material, with a key name unique within a secret scope. 各スコープは、1000のシークレットに制限されています。Each scope is limited to 1000 secrets. 許可されるシークレットの最大サイズは 128 KB です。The maximum allowed secret value size is 128 KB.

シークレットの作成Create a secret

シークレット名では大文字と小文字が区別されません。Secret names are case insensitive.

シークレットを作成する方法は、Azure Key Vault によってサポートされるスコープと Databricks によってサポートされるスコープのどちらを使用しているかによって異なります。The method for creating a secret depends on whether you are using an Azure Key Vault-backed scope or a Databricks-backed scope.

Azure Key Vault に基づくスコープでシークレットを作成するCreate a secret in an Azure Key Vault-backed scope

でシークレットを作成するには Azure Key Vault Azure Setsecret REST API または Azure portal UI を使用します。To create a secret in Azure Key Vault you use the Azure SetSecret REST API or Azure portal UI.

代替テキスト](../../_static/images/secrets/azure-kv-secrets.png) を ![no-alternative-text

Databricks ベースのスコープでシークレットを作成するCreate a secret in a Databricks-backed scope

DATABRICKS CLI (バージョン0.7.1 以降) を使用して、Databricks でサポートされているスコープにシークレットを作成するには、次の手順を実行します。To create a secret in a Databricks-backed scope using the Databricks CLI (version 0.7.1 and above):

databricks secrets put --scope <scope-name> --key <key-name>

エディターが開き、次のような内容が表示されます。An editor opens and displays content like this:

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

行の上にシークレット値を貼り付け、エディターを保存して終了します。Paste your secret value above the line and save and exit the editor. 入力内容が削除され、スコープ内のキーに関連付けられているコメントが削除されます。Your input is stripped of the comments and stored associated with the key in the scope.

既に存在するキーを持つ書き込み要求を発行すると、新しい値によって既存の値が上書きされます。If you issue a write request with a key that already exists, the new value overwrites the existing value.

また、ファイルまたはコマンドラインからシークレットを指定することもできます。You can also provide a secret from a file or from the command line. シークレットの作成の詳細については、「シークレット CLI」を参照してください。For more information about writing secrets, see Secrets CLI.

シークレットのリストList secrets

特定のスコープのシークレットを一覧表示するには、次のようにします。To list secrets in a given scope:

databricks secrets list --scope <scope-name>

応答には、秘密キー名や、タイムスタンプでの最終更新日 (エポック以降のミリ秒単位) など、シークレットに関するメタデータ情報が表示されます。The response displays metadata information about the secret, such as the secret key name and last updated at timestamp (in milliseconds since epoch). シークレットを読み取るには、ノートブックまたはジョブでシークレットユーティリティを使用します。You use the Secrets utilities in a notebook or job to read a secret. 例えば次が挙げられます。For example:

databricks secrets list --scope jdbc
Key name    Last updated
----------  --------------
password    1531968449039
username    1531968408097

シークレットを読み取りますRead a secret

注意

DBUtils secret ユーティリティは Databricks Runtime 4.0 以降を実行しているクラスターでのみ使用できます。DBUtils secret utilities are available only on clusters running Databricks Runtime 4.0 and above.

REST API または CLI を使用してシークレットを作成しますが、シークレットを読み取るには、ノートブックまたはジョブでシークレットユーティリティを使用する必要があります。You create secrets using the REST API or CLI, but you must use the Secrets utilities in a notebook or job to read a secret.

シークレットを削除しますDelete a secret

Azure Key Vault によってサポートされるスコープからシークレットを削除するには、Azure Setsecret REST API または Azure portal UI を使用します。To delete a secret from a scope backed by Azure Key Vault, use the Azure SetSecret REST API or Azure portal UI.