Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
secrets 内の コマンド グループを使用すると、シークレット、シークレット スコープ、アクセス許可を管理できます。 データにアクセスするために、JDBC 経由で外部データ ソースに対する認証が必要になる場合があります。 資格情報をノートブックに直接入力する代わりに、Databricks シークレットを使用して資格情報を格納し、ノートブックとジョブで参照します。 シークレット管理 を参照してください。
databricks シークレットの create-scope
新しいシークレット スコープを作成します。
スコープ名は、英数字、ダッシュ、アンダースコア、およびピリオドで構成する必要があり、128 文字を超えることはできません。
databricks secrets create-scope SCOPE [flags]
Arguments
SCOPE
ユーザーによって要求されたスコープ名。 スコープ名は一意です。
オプション
--initial-manage-principal string
作成されたスコープに対する MANAGE アクセス許可が最初に付与されたプリンシパル。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--scope-backend-type ScopeBackendType
スコープが作成されるバックエンドの種類。 サポートされる値: AZURE_KEYVAULT、DATABRICKS
databricks シークレット delete-acl
指定されたスコープの特定の ACL を削除します。
このコマンドを呼び出すには、ユーザーに MANAGE アクセス許可が必要です。 そのようなシークレット スコープ、プリンシパル、または ACL が存在しない場合は RESOURCE_DOES_NOT_EXIST を送出します。 ユーザーがこの API 呼び出しを行うための権限をもっていない場合は PERMISSION_DENIED をスローします。
databricks secrets delete-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
権限を削除するスコープの名前。
PRINCIPAL
既存の ACL を削除するプリンシパル。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricks シークレット delete-scopeを削除
シークレット スコープを削除します。
スコープが存在しない場合は RESOURCE_DOES_NOT_EXIST をスローします。 ユーザーがこの呼び出しを行うための権限をもっていない場合は、PERMISSION_DENIED をスローします。
databricks secrets delete-scope SCOPE [flags]
Arguments
SCOPE
削除するスコープの名前。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricks シークレットを削除するコマンド (delete-secret)
このシークレット スコープに格納されているシークレットを削除します。 シークレット スコープに対する WRITE または MANAGE アクセス許可が必要です。
該当するシークレット スコープまたはシークレットが存在しない場合は RESOURCE_DOES_NOT_EXIST をスローします。 ユーザーがこの呼び出しを行うための権限をもっていない場合は、PERMISSION_DENIED をスローします。
databricks secrets delete-secret SCOPE KEY [flags]
Arguments
SCOPE
削除するシークレットを含むスコープの名前。
KEY
削除するシークレットの名前。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricks シークレット情報 get-acl
グループやアクセス許可など、特定の ACL に関する詳細を取得します。 この API を呼び出すには、ユーザーに MANAGE アクセス許可が必要です。
該当するシークレット スコープが存在しない場合は RESOURCE_DOES_NOT_EXIST をスローします。 ユーザーがこの呼び出しを行うための権限をもっていない場合は、PERMISSION_DENIED をスローします。
databricks secrets get-acl SCOPE PRINCIPAL [flags]
Arguments
SCOPE
ACL情報を取得するスコープの名前。
PRINCIPAL
ACL 情報をフェッチする対象のプリンシパル。
オプション
databricks シークレット get-secret
指定したスコープとキーのシークレット値のバイト表現を取得します。
この呼び出しを行うには、 READ アクセス許可が必要です。
返されるシークレット値はバイト単位であることに注意してください。 バイトの解釈は、DBUtils の呼び出し元によって決定され、データがデコードされる型によって異なります。
ユーザーがこの API 呼び出しを行うための権限をもっていない場合は PERMISSION_DENIED をスローします。 該当するシークレットまたはシークレット スコープが存在しない場合は、RESOURCE_DOES_NOT_EXIST をスローします。
databricks secrets get-secret SCOPE KEY [flags]
Arguments
SCOPE
秘密情報を取得するスコープの名前。
KEY
シークレットを取得するためのキー。
オプション
databricks secrets list-acls
特定のシークレット スコープの ACL を一覧表示します。 この API を呼び出すには、ユーザーに MANAGE アクセス許可が必要です。
該当するシークレット スコープが存在しない場合は RESOURCE_DOES_NOT_EXIST をスローします。 ユーザーがこの呼び出しを行うための権限をもっていない場合は、PERMISSION_DENIED をスローします。
databricks secrets list-acls SCOPE [flags]
Arguments
SCOPE
ACL情報を取得するスコープの名前。
オプション
databricks secrets list-scopes (Databricksのシークレットのスコープ一覧を表示するコマンド)
ワークスペースで使用可能なすべてのシークレット スコープを一覧表示します。
ユーザーがこの呼び出しを行うための権限をもっていない場合は、PERMISSION_DENIED をスローします。
databricks secrets list-scopes [flags]
オプション
databricks secrets list-secrets
このスコープに格納されているシークレット キーを一覧表示します。 これはメタデータのみの操作です。このコマンドを使用してシークレット データを取得することはできません。 この呼び出しを行うには、 READ アクセス許可が必要です。
返される lastUpdatedTimestamp は、エポック以降のミリ秒単位です。 該当するシークレット スコープが存在しない場合は RESOURCE_DOES_NOT_EXIST をスローします。 ユーザーがこの呼び出しを行うための権限をもっていない場合は、PERMISSION_DENIED をスローします。
databricks secrets list-secrets SCOPE [flags]
Arguments
SCOPE
シークレットを一覧表示する対象のスコープの名前。
オプション
Databricks シークレット put-acl
指定したスコープ ポイントの特定のプリンシパル (ユーザーまたはグループ) に関連付けられているアクセス制御リスト (ACL) を作成または上書きします。
一般に、ユーザーまたはグループは、ユーザーが使用できる最も強力なアクセス許可を使用し、アクセス許可は次のように並べ替えられます。
-
MANAGEACL を変更し、このシークレット スコープの読み取りと書き込みを行うことが許可されます。 -
WRITEこのシークレット スコープの読み取りと書き込みが許可されます。 -
READこのシークレット スコープを読み取り、使用可能なシークレットを一覧表示できます。
一般に、シークレット値はクラスター上のコマンド内 (ノートブックなど) からのみ読み取ることができることに注意してください。 クラスターの外部で実際のシークレット値のマテリアルを読み取る API はありません。 ただし、ユーザーのアクセス許可は、コマンドを実行しているユーザーに基づいて適用され、少なくとも READ アクセス許可が必要です。
このコマンドを呼び出すには、ユーザーに MANAGE アクセス許可が必要です。
プリンシパルは、アクセスを許可または取り消す既存の Databricks プリンシパルに対応するユーザーまたはグループ名です。
該当するシークレット スコープが存在しない場合は RESOURCE_DOES_NOT_EXIST をスローします。 プリンシパルの権限が既に存在する場合は RESOURCE_ALREADY_EXISTS をスローします。 アクセス許可またはプリンシパルが無効な場合に、INVALID_PARAMETER_VALUE をスローします。 ユーザーがこの呼び出しを行うための権限をもっていない場合は、PERMISSION_DENIED をスローします。
databricks secrets put-acl SCOPE PRINCIPAL PERMISSION [flags]
Arguments
SCOPE
アクセス許可を適用するスコープの名前。
PRINCIPAL
アクセス許可が適用されるプリンシパル。
PERMISSION
プリンシパルに適用されるアクセス許可レベル。 サポートされる値: MANAGE、READ、WRITE
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricks のシークレット put-secretコマンドを実行する
指定されたスコープの下に、指定された名前でシークレットを挿入します。 同じ名前のシークレットが既に存在する場合、このコマンドは既存のシークレットの値を上書きします。 サーバーは、シークレット を格納する前に、シークレット スコープの暗号化設定を使用してシークレットを暗号化します。
シークレット スコープに対する WRITE または MANAGE アクセス許可が必要です。 秘密鍵は、英数字、ダッシュ、アンダースコア、およびピリオドで構成する必要があり、128 文字を超えることはできません。 許可されるシークレット値の最大サイズは 128 KB です。 特定のスコープ内のシークレットの最大数は 1000 です。
引数 string-value または bytes-value シークレットの型を指定します。シークレット値が要求されたときに返される値を決定します。
シークレット値は、次の 3 つの方法のいずれかで指定できます。
-
--string-valueフラグを使用して、値を文字列として指定します。 - 対話形式でプロンプトが表示されたら、シークレットを入力します (1 行のシークレット)。
- 標準入力 (複数行のシークレット) を使用してシークレットを渡します。
databricks secrets put-secret SCOPE KEY [flags]
Arguments
SCOPE
シークレットを格納するスコープの名前。
KEY
シークレットのキー名。
オプション
--bytes-value string
指定した場合、値はバイトとして格納されます。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--string-value string
指定した場合、値は UTF-8 (MB4) 形式で格納されることに注意してください。
グローバル フラグ
--debug
デバッグ ログを有効にするかどうかを指定します。
-h または --help
Databricks CLI、または関連コマンド グループ、または関連コマンドのヘルプの表示。
--log-file 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット