credentials コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI 内の credentials コマンド グループを使用すると、クラウド テナント上のサービスにアクセスするための資格情報を管理できます。各資格情報には、資格情報にアクセスできるユーザーとグループを制御する Unity Catalog アクセス制御ポリシーが適用されます。
資格情報は、クラウド テナント上のサービスにアクセスするための認証および承認メカニズムを表します。資格情報を作成するには、Databricks アカウント管理者であるか、 CREATE SERVICE CREDENTIAL 特権を持っている必要があります。資格情報を作成したユーザーは、所有権を別のユーザーまたはグループに委任して、その権限を管理できます。
databricks credentials create-credential
新しい資格情報を作成します。作成する資格情報のタイプは、 purpose フィールド ( SERVICE または STORAGEのいずれか) によって決定されます。
呼び出し元は、メタストア管理者であるか、ストレージ資格情報のメタストア特権 CREATE_STORAGE_CREDENTIAL 、またはサービス資格情報の CREATE_SERVICE_CREDENTIAL を持っている必要があります。
databricks credentials create-credential NAME [flags]
引数
NAME
資格情報名。名前は、メタストア内のストレージおよびサービスの資格情報間で一意である必要があります。
オプション
--comment string
資格情報に関連付けられたコメント
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
--purpose CredentialPurpose
資格情報の目的を示します。サポートされている値: SERVICE、 STORAGE
--read-only
資格情報が読み取り操作にのみ使用できるかどうか
--skip-validation
随意
例
次の例では、 my-service-credという名前のサービス資格情報を作成します。
databricks credentials create-credential my-service-cred --purpose SERVICE
次の例では、読み取り専用のストレージ資格情報を作成します。
databricks credentials create-credential readonly-storage --purpose STORAGE --read-only
databricks credentials delete-credential
メタストアからサービスまたはストレージの資格情報を削除します。呼び出し元は資格情報の所有者である必要があります。
databricks credentials delete-credential NAME_ARG [flags]
引数
NAME_ARG
資格情報の名前
オプション
--force
依存サービス(目的が SERVICEの場合)または依存外部ロケーションと外部テーブル(目的が STORAGEの場合)がある場合でも強制的に更新します。
例
次の例では、 my-service-credという名前の資格情報を削除します。
databricks credentials delete-credential my-service-cred
次の例では、依存関係を持つ資格情報を強制的に削除します。
databricks credentials delete-credential my-storage-cred --force
databricks credentials generate-temporary-service-credential
指定したサービス資格情報を使用して、一時的なサービス資格情報を生成します。呼び出し元は、メタストア管理者であるか、サービス資格情報に対してメタストア特権 ACCESS を持っている必要があります。
databricks credentials generate-temporary-service-credential CREDENTIAL_NAME [flags]
引数
CREDENTIAL_NAME
一時的な資格情報の生成に使用されるサービス資格情報の名前
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
例
次の例では、サービス資格情報の一時的な資格情報を生成します。
databricks credentials generate-temporary-service-credential my-service-cred
databricks credentials get-credential
メタストアからサービスまたはストレージの資格情報を取得します。呼び出し元は、メタストア管理者、資格情報の所有者であるか、資格情報に対するアクセス許可を持っている必要があります。
databricks credentials get-credential NAME_ARG [flags]
引数
NAME_ARG
資格情報の名前
オプション
例
次の例では、 my-service-credという名前の資格情報に関する情報を取得します。
databricks credentials get-credential my-service-cred
databricks credentials list-credentials
資格情報を一覧表示します。このリストは、呼び出し元がアクセス許可を持っている資格情報のみに制限されます。呼び出し元がメタストア管理者の場合、資格情報の取得は制限されません。配列内の要素の特定の順序を保証するものではありません。
databricks credentials list-credentials [flags]
オプション
--max-results int
返す資格情報の最大数
--page-token string
結果の次のページを取得するための不透明なトークン
--purpose CredentialPurpose
指定した目的の資格情報のみを返します。サポートされている値: SERVICE、 STORAGE
例
次の例は、すべての資格情報を一覧表示します。
databricks credentials list-credentials
次の例は、サービス資格情報のみをリストします。
databricks credentials list-credentials --purpose SERVICE
次の例は、最大 10 個の結果を持つ資格情報を一覧表示します。
databricks credentials list-credentials --max-results 10
databricks credentials update-credential
メタストアのサービスまたはストレージ資格情報を更新します。
呼び出し元は、資格情報の所有者またはメタストア管理者であるか、 MANAGE アクセス許可を持っている必要があります。呼び出し元がメタストア管理者の場合、変更できるのは owner フィールドのみです。
databricks credentials update-credential NAME_ARG [flags]
引数
NAME_ARG
資格情報の名前
オプション
--comment string
資格情報に関連付けられたコメント
--force
依存サービス(目的が SERVICEの場合)または依存外部ロケーションと外部テーブル(目的が STORAGEの場合)がある場合でも強制的に更新します。
--isolation-mode IsolationMode
現在のセキュリティ保護可能オブジェクトにすべてのワークスペースからアクセスできるか、特定のワークスペース セットからアクセスできるか。サポートされている値: ISOLATION_MODE_ISOLATED、 ISOLATION_MODE_OPEN
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
--new-name string
資格情報の新しい名前
--owner string
資格情報の現在の所有者のユーザー名
--read-only
資格情報が読み取り操作にのみ使用できるかどうか
--skip-validation
この引数に true を指定すると、更新された資格情報の検証がスキップされます
例
次の例では、資格情報のコメントを更新します。
databricks credentials update-credential my-service-cred --comment "Updated service credential"
次の例では、資格情報の名前を変更します。
databricks credentials update-credential my-service-cred --new-name my-renamed-cred
次の例では、資格情報の所有者を変更します。
databricks credentials update-credential my-service-cred --owner someone@example.com
次の例では、資格情報を読み取り専用にします。
databricks credentials update-credential my-storage-cred --read-only
databricks credentials validate-credential
資格情報を検証します。
サービス資格情報(目的は SERVICE)の場合は、 credential_name またはクラウド固有の資格情報を指定する必要があります。
ストレージ資格情報 (目的は STORAGE) の場合、少なくとも 1 つ external_location_name と url を指定する必要があります。そのうちの 1 つだけが指定されている場合は、検証に使用されます。また、両方が指定されている場合、 url は検証に使用され、重複するURLを確認するときに external_location_name は無視されます。credential_nameまたはクラウド固有の資格情報のいずれかを指定する必要があります。
呼び出し元は、メタストア管理者または資格情報の所有者であるか、メタストアと資格情報に必要なアクセス許可を持っている必要があります (たとえば、目的が STORAGEの場合はCREATE_EXTERNAL_LOCATION)。
databricks credentials validate-credential [flags]
オプション
--credential-name string
必須
--external-location-name string
検証する既存の外部ロケーションの名前
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path
--purpose CredentialPurpose
資格情報の目的。サポートされている値: SERVICE、 STORAGE
--read-only
資格情報が読み取り操作にのみ使用できるかどうか
--url string
検証する外部ロケーションの URL
例
次の例では、サービス資格情報を検証します。
databricks credentials validate-credential --credential-name my-service-cred --purpose SERVICE
次の例では、外部ロケーションを使用してストレージ資格情報を検証します。
databricks credentials validate-credential --credential-name my-storage-cred --purpose STORAGE --external-location-name my-external-location
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット