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

recipients コマンド グループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

Databricks CLI内のrecipientsコマンドグループには、Unity Catalogで共有受信者を管理するコマンドが含まれています。「Delta Sharingとは」を参照してください。

databricks recipients create

メタストアでデルタ共有認証の種類を持つ新しい受信者を作成します。呼び出し元は、メタストア管理者であるか、メタストアに対する CREATE_RECIPIENT 特権を持っている必要があります。

databricks recipients create NAME AUTHENTICATION_TYPE [flags]

引数

NAME

受信者の名前。

AUTHENTICATION_TYPE

差分共有認証タイプ。サポートされている値: DATABRICKSOAUTH_CLIENT_CREDENTIALSOIDC_FEDERATIONTOKEN

オプション

--comment string

受信者に関する説明。

--data-recipient-global-metastore-id string

データ受信者によって提供されるグローバル Unity Catalog メタストア ID。

--expiration-time int

トークンの有効期限タイムスタンプ (エポックミリ秒単位)。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--owner string

受信者の所有者のユーザー名。

--sharing-code string

データ受信者から提供された 1 回限りの共有コード。

グローバルフラグ

databricks recipients delete

指定した受信者をメタストアから削除します。発信者は受信者の所有者である必要があります。

databricks recipients delete NAME [flags]

引数

NAME

受信者の名前。

オプション

グローバルフラグ

databricks recipients get

次の場合に、メタストアから共有受信者を取得します。

  • 呼び出し元は、共有受信者の所有者です。
  • またはメタストア管理者です。
databricks recipients get NAME [flags]

引数

NAME

受信者の名前。

オプション

グローバルフラグ

databricks recipients list

現在のメタストア内のすべての共有受信者を一覧表示します。

  • 呼び出し元はメタストア管理者です。
  • または、呼び出し元が所有者です。

配列内の要素の特定の順序を保証するものではありません。

databricks recipients list [flags]

引数

なし

オプション

--data-recipient-global-metastore-id string

指定しない場合は、すべての受信者が返されます。

--max-results int

返す受信者の最大数。

--page-token string

前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。

グローバルフラグ

databricks recipients rotate-token

指定した受信者の差分共有認証トークンを、指定されたトークン情報でローテーションします。発信者は受信者の所有者である必要があります。

databricks recipients rotate-token NAME EXISTING_TOKEN_EXPIRE_IN_SECONDS [flags]

引数

NAME

受信者の名前。

EXISTING_TOKEN_EXPIRE_IN_SECONDS

ISO 8601 形式のベアラートークンの有効期限。これにより、既存のトークンのexpiration_timeはより小さなタイムスタンプにのみ設定され、expiration_timeを拡張することはできません。既存のトークンをすぐに期限切れにするには0を使用し、負の数はエラーを返します。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

databricks recipients update

メタストア内の既存の受信者を更新します。呼び出し元は、メタストア管理者または受信者の所有者である必要があります。受信者名を更新する場合、ユーザーはメタストア管理者と受信者の所有者の両方である必要があります。

databricks recipients update NAME [flags]

引数

NAME

受信者の名前。

オプション

--comment string

受信者に関する説明。

--expiration-time int

トークンの有効期限タイムスタンプ (エポックミリ秒単位)。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--new-name string

受信者の新しい名前。

--owner string

受信者の所有者のユーザー名。

グローバルフラグ

databricks recipients share-permissions

指定した受信者の共有アクセス許可を取得します。呼び出し元は、メタストア管理者または受信者の所有者である必要があります。

databricks recipients share-permissions NAME [flags]

引数

NAME

受信者の名前。

オプション

--max-results int

返すアクセス許可の最大数。

--page-token string

前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。

グローバルフラグ

グローバルフラグ

--debug

デバッグログを有効にするかどうか。

-h または --help

Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。

--log-file string

出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。

--log-format format

ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。

--log-level string

ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。

-o, --output タイプ

コマンド出力タイプ text または json。デフォルト値は textです。

-p, --profile string

コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format format

進行状況ログを表示する形式: defaultappendinplacejson

-t, --target string

該当する場合は、使用するバンドル・ターゲット