Note
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Important
この機能は パブリック プレビュー段階です。
Databricks CLI内のsecrets-ucコマンドグループはUnity Catalogの秘密を管理します。 シークレットとは、3レベル名付け空間(catalog_name.schema_name.secret_name)内に機密性の高い認証情報データ(パスワード、トークン、鍵など)を保存するUnity Catalogのセキュア可能なオブジェクトです。 シークレットは標準的なUnity Catalog権限で管理でき、カタログ内のスキーマにスコープが割り当てられます。
Databricks Secrets-UC create-secret
Unity Catalogで新しいシークレットを作成します。 親スキーマの所有者であるか、親スキーマの CREATE_SECRET および USE SCHEMA 権限、親カタログの USE CATALOG を持っている必要があります。 シークレットは指定されたカタログとスキーマに保存され、 値 フィールドには安全に保存すべき機密データが含まれます。
databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Arguments
NAME
シークレットの名前は、その親スキーマに対して相対的に示されます。
CATALOG_NAME
スキーマと秘密が入っているカタログの名前。
SCHEMA_NAME
秘密があるスキーマの名前。
VALUE
保存する秘密の価値。 このフィールドは入力のみで、応答では返されません。 effective_value フィールド( include_value をtrueに設定したGetSecret経由)を使って秘密値を読み取ってください。 最大サイズは60 KiB(暗号化前)です。 承認されるコンテンツには、パスワード、トークン、鍵、その他の機密性の高い認証情報が含まれます。
オプション
--comment string
ユーザーが提供した自由形式の秘密のテキスト説明。
--expire-time string
ユーザーが提供したシークレットの有効期限。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--owner string
秘密の持ち主。
DataBricks Secrets-UC Delete-Secret
3レベル(完全限定)名前の秘密を削除します。 シークレットの所有者かメタストア管理者でなければなりません。
databricks secrets-uc delete-secret FULL_NAME [flags]
Arguments
FULL_NAME
秘密の3レベル(完全限定)名(例: catalog_name.schema_name.secret_name)です。
オプション
Databricks Secrets-UC Get-Secret
3段階(完全適格)な名前で秘密がつきます。 あなたはメタストア管理者であり、シークレットの所有者であるか、シークレットに対して MANAGE 権限を持っている必要があります。 秘密値はデフォルトで返されません。 取得するには、 READ_SECRET 権限を持ち、リクエストで include_value をtrueに設定する必要があります。
databricks secrets-uc get-secret FULL_NAME [flags]
Arguments
FULL_NAME
秘密の3レベル(完全限定)名(例: catalog_name.schema_name.secret_name)です。
オプション
Databricks Secrets-UC List-Secrets
Unity Catalogの秘密情報一覧。 あなたはメタストア管理者であり、シークレットの所有者であるか、シークレットに対して MANAGE 権限を持っている必要があります。 catalog_nameとschema_nameの両方を同時に指定し、特定のスキーマ内で秘密をフィルタリングする必要があります。 結果はページ付けされています。レスポンスの page_token フィールドを使って、その後のページを取得してください。
databricks secrets-uc list-secrets [flags]
オプション
--catalog-name string
秘密をリストアップするためのカタログの名前。
--limit int
返される結果の最大数。
--page-size int
返すべき秘密の最大数。
--schema-name string
秘密をリストアップするためのスキーマの名前。
Databricks Secrets-UC Update-Secret
Unity Catalog内の既存の秘密を更新します。 シークレットの所有者かメタストア管理者でなければなりません。メタストア管理者の場合は、 所有者 フィールドのみを変更できます。 update_maskフィールドを使ってどのフィールドを更新するかを指定します。 対応可能な更新可能なフィールドには 、値、 コメント、 所有者、 expire_timeがあります。
databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
Arguments
FULL_NAME
秘密の3レベル(完全限定)名(例: catalog_name.schema_name.secret_name)です。
UPDATE_MASK
シークレットのどのフィールドを更新するかを指定するフィールドマスク。 update_maskが「*」の場合、シークレットで指定されたすべてのフィールドが更新されます。 update_maskが1つ以上のフィールドを指定した場合、そのフィールドのみが更新されます。 指定された各フィールドは 秘密設定でなければなりません。 対応フィールド: 値、 コメント、 所有者、 expire_time。 シークレット名を変更するには、シークレットを削除して再作成してください。
NAME
シークレットの名前は、その親スキーマに対して相対的に示されます。
CATALOG_NAME
スキーマと秘密が入っているカタログの名前。
SCHEMA_NAME
秘密があるスキーマの名前。
VALUE
保存する秘密の価値。 このフィールドは入力のみで、応答では返されません。 effective_value フィールド( include_value をtrueに設定したGetSecret経由)を使って秘密値を読み取ってください。 最大サイズは60 KiB(暗号化前)です。 承認されるコンテンツには、パスワード、トークン、鍵、その他の機密性の高い認証情報が含まれます。
オプション
--comment string
ユーザーが提供した自由形式の秘密のテキスト説明。
--expire-time string
ユーザーが提供したシークレットの有効期限。
--json JSON
要求本文を含む JSON ファイルへのインライン JSON 文字列または @path 。
--owner string
秘密の持ち主。
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット