secrets-ucコマンド・グループ
Databricks CLIの使用には、DatabricksのDBライセンスおよびDatabricksプライバシー通知（使用データ条項を含む）が適用されます。
プレビュー
この機能は パブリック プレビュー段階です。
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 権限が必要です。シークレットは指定されたカタログとスキーマに保存され、 value フィールドには安全に保存される機密データが含まれます。
databricks secrets-uc create-secret NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
引数
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]
引数
FULL_NAME
シークレットの3レベル（完全修飾）名（例： catalog_name.schema_name.secret_name ）。
オプション
databricks secrets-uc get-secret
3レベル（完全修飾）名でシークレットを取得します。メタストアの管理者であるか、シークレットの所有者であるか、またはシークレットに対する MANAGE 権限を持っている必要があります。シークレット値はdefaultでは返されません。これを取得するには、 READ_SECRET 特権も必要であり、リクエストで include_value を true に設定する必要があります。
databricks secrets-uc get-secret FULL_NAME [flags]
引数
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内の既存のシークレットを更新します。シークレットの所有者またはメタストア管理者である必要があります。メタストア管理者の場合、 owner フィールドのみを変更できます。 update_mask フィールドを使用して、更新するフィールドを指定します。サポートされている更新可能なフィールドには、 value 、 comment 、 owner 、 expire_time が含まれます。
databricks secrets-uc update-secret FULL_NAME UPDATE_MASK NAME CATALOG_NAME SCHEMA_NAME VALUE [flags]
引数
FULL_NAME
シークレットの3レベル（完全修飾）名（例： catalog_name.schema_name.secret_name ）。
UPDATE_MASK
シークレットのどのフィールドを更新するかを指定するフィールドマスク。 update_mask が 「*」 の場合、 secret で指定されたすべてのフィールドが更新されます。 update_mask で1つ以上のフィールドが指定されている場合、それらのフィールドのみが更新されます。指定された各フィールドは、 secret 内に設定されている必要があります。サポートされているフィールド： value 、 comment 、 owner 、 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 string
出力Logsの書き込み先ファイルを表す文字列。このフラグが指定されていない場合、defaultでは出力Logsが stderr に書き込まれます。
--log-format format
ログ形式タイプ（text または json）。default値は text です。
--log-level string
Log形式レベルを表す文字列。指定されていない場合、ログ形式レベルは無効になります。
-o, --output タイプ
コマンド出力タイプ、text または json。default値は text です。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイル名。このフラグが指定されていない場合、DEFAULT という名前のプロファイルが存在すれば、それが使用されます。
--progress-format format
進行状況Logsを表示する形式: default、append、inplace、または json
-t, --target string
該当する場合、使用するバンドルターゲット