providers コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のprovidersコマンド グループには、Delta共有プロバイダーを管理するコマンドが含まれています。データ・プロバイダーは、データを共有する現実世界の組織を表します。「Delta Sharingとは」を参照してください。
databricks providers create
名前と認証タイプに基づいて、少なくとも新しい認証プロバイダーを作成します。呼び出し元は、メタストアの管理者である必要があります。
databricks providers create NAME AUTHENTICATION_TYPE [flags]
引数
NAME
プロバイダーの名前。
AUTHENTICATION_TYPE
差分共有認証タイプ。サポートされている値: DATABRICKS、 OAUTH_CLIENT_CREDENTIALS、 OIDC_FEDERATION、 TOKEN
オプション
--comment string
プロバイダーに関する説明。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--recipient-profile-str string
このフィールドは、 authentication_type が TOKEN、 OAUTH_CLIENT_CREDENTIALS 、または指定されていない場合に必須です。
例
次の例では、トークン認証を使用してプロバイダーを作成します。
databricks providers create my_provider TOKEN --comment "My data provider" --recipient-profile-str "my_profile"
次の例では、DATABRICKS 認証を使用してプロバイダーを作成します。
databricks providers create my_provider DATABRICKS --comment "Internal provider"
databricks providers delete
呼び出し元がメタストア管理者であるか、プロバイダーの所有者である場合は、認証プロバイダーを削除します。
databricks providers delete NAME [flags]
引数
NAME
プロバイダーの名前。
オプション
例
次の例では、プロバイダーを削除します。
databricks providers delete my_provider
databricks providers get
特定の認証プロバイダーを取得します。呼び出し元はプロバイダーの名前を指定する必要があり、メタストア管理者またはプロバイダーの所有者である必要があります。
databricks providers get NAME [flags]
引数
NAME
プロバイダーの名前。
オプション
例
次の例では、プロバイダーの詳細を取得します。
databricks providers get my_provider
databricks providers list
使用可能な認証プロバイダーを一覧表示します。呼び出し元は、メタストア管理者またはプロバイダーの所有者である必要があります。呼び出し元が所有していないプロバイダーは、応答に含まれません。配列内の要素の特定の順序を保証するものではありません。
databricks providers list [flags]
オプション
--data-provider-global-metastore-id string
指定しない場合は、すべてのプロバイダーが返されます。
--max-results int
返すプロバイダーの最大数。
--page-token string
前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。
例
次の例は、すべてのプロバイダーを一覧表示します。
databricks providers list
次の例は、ページネーションを含むプロバイダーの一覧です。
databricks providers list --max-results 10
次の例は、特定のメタストアのプロバイダーの一覧です。
databricks providers list --data-provider-global-metastore-id "my-metastore-id"
databricks providers list-provider-share-assets
指定したプロバイダーのシェアに関連付けられたアセットを一覧表示します。呼び出し元は共有の受信者です。
databricks providers list-provider-share-assets PROVIDER_NAME SHARE_NAME [flags]
引数
PROVIDER_NAME
共有を所有するプロバイダーの名前。
SHARE_NAME
共有の名前。
オプション
--function-max-results int
返す関数の最大数。
--notebook-max-results int
返却するノートブックの最大数。
--table-max-results int
返すテーブルの最大数。
--volume-max-results int
返すボリュームの最大数。
例
次の例は、プロバイダーの共有内のすべての資産を一覧表示します。
databricks providers list-provider-share-assets my_provider my_share
次の例は、各タイプに制限がある資産をリストします。
databricks providers list-provider-share-assets my_provider my_share --table-max-results 5 --function-max-results 3
databricks providers list-shares
メタストア内の指定されたプロバイダーの共有を一覧表示します。
- 呼び出し元はメタストア管理者です。
- または、呼び出し元が所有者です。
databricks providers list-shares NAME [flags]
引数
NAME
共有を一覧表示するプロバイダーの名前。
オプション
--max-results int
返す株式の最大数。
--page-token string
前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。
例
次の例は、プロバイダーのすべての共有を一覧表示します。
databricks providers list-shares my_provider
次の例は、ページネーションを含む共有を一覧表示します。
databricks providers list-shares my_provider --max-results 10
databricks providers update
呼び出し元がメタストア管理者であるか、プロバイダーの所有者である場合は、認証プロバイダーの情報を更新します。更新プログラムによってプロバイダー名が変更される場合、呼び出し元はメタストア管理者とプロバイダーの所有者の両方である必要があります。
databricks providers update NAME [flags]
引数
NAME
プロバイダーの名前。
オプション
--comment string
プロバイダーに関する説明。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--new-name string
プロバイダーの新しい名前。
--owner string
プロバイダー所有者のユーザー名。
--recipient-profile-str string
このフィールドは、 authentication_type が TOKEN、 OAUTH_CLIENT_CREDENTIALS 、または指定されていない場合に必須です。
例
次の例では、プロバイダーのコメントを更新します。
databricks providers update my_provider --comment "Updated provider description"
次の例では、プロバイダーの名前と所有者を更新します。
databricks providers update my_provider --new-name "my_new_provider" --owner "new_owner@example.com"
グローバルフラグ
--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
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット