Note
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
credentials 内の コマンド グループを使用すると、クラウド テナント上のサービスにアクセスするための資格情報を管理できます。 各資格情報には、資格情報にアクセスできるユーザーとグループを制御する Unity カタログのアクセス制御ポリシーが適用されます。
Note
Azure Databricks アカウントのクロスアカウント資格情報構成を管理するコマンドについては、account credentials コマンド グループを参照してください。
資格情報は、クラウド テナント上のサービスにアクセスするための認証と承認のメカニズムを表します。 資格情報を作成するには、Databricks アカウント管理者であるか、 CREATE SERVICE CREDENTIAL 特権を持っている必要があります。 資格情報を作成するユーザーは、所有権を別のユーザーまたはグループに委任して、その資格情報に対するアクセス許可を管理できます。
databricks 資格情報の作成-資格情報
新しい資格情報を作成します。 作成する資格情報の種類は、purposeまたはSERVICEする必要があるSTORAGE フィールドによって決まります。
呼び出し元は、メタストア管理者であるか、ストレージ資格情報のメタストア特権 CREATE_STORAGE_CREDENTIAL 、またはサービス資格情報の CREATE_SERVICE_CREDENTIAL を持っている必要があります。
databricks credentials create-credential NAME [flags]
Arguments
NAME
資格情報名。 名前は、メタストア内のストレージ資格情報とサービス資格情報の間で一意である必要があります。
オプション
--comment string
資格情報に関連付けられているコメント
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
--purpose CredentialPurpose
資格情報の目的を示します。 サポートされる値: SERVICE、STORAGE
--read-only
資格情報が読み取り操作にのみ使用できるかどうか
--skip-validation
Optional
Examples
次の例では、 my-service-credという名前のサービス資格情報を作成します。
databricks credentials create-credential my-service-cred --purpose SERVICE
次の例では、読み取り専用ストレージ資格情報を作成します。
databricks credentials create-credential readonly-storage --purpose STORAGE --read-only
databricks 資格情報 削除資格情報
メタストアからサービスまたはストレージの資格情報を削除します。 呼び出し元は資格情報の所有者である必要があります。
databricks credentials delete-credential NAME_ARG [flags]
Arguments
NAME_ARG
資格情報の名前
オプション
--force
依存サービス (目的が SERVICEされている場合) または依存する外部の場所と外部テーブル (目的が STORAGEされている場合) がある場合でも強制的に更新する
Examples
次の例では、 my-service-credという名前の資格情報を削除します。
databricks credentials delete-credential my-service-cred
次の例では、依存関係を持つ資格情報が強制的に削除されます。
databricks credentials delete-credential my-storage-cred --force
databricks 資格情報 一時的なサービス資格情報を生成する
指定したサービス資格情報を使用して、一時サービス資格情報を生成します。 呼び出し元は、メタストア管理者であるか、サービス資格情報に ACCESS メタストア特権を持っている必要があります。
databricks credentials generate-temporary-service-credential CREDENTIAL_NAME [flags]
Arguments
CREDENTIAL_NAME
一時的な資格情報の生成に使用されるサービス資格情報の名前
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
Examples
次の例はサービス資格情報の一時的な資格情報を生成します。
databricks credentials generate-temporary-service-credential my-service-cred
databricks 資格情報 get-credential
メタストアからサービスまたはストレージの資格情報を取得します。 呼び出し元は、メタストア管理者、資格情報の所有者、または資格情報に対する任意のアクセス許可を持っている必要があります。
databricks credentials get-credential NAME_ARG [flags]
Arguments
NAME_ARG
資格情報の名前
オプション
Examples
次の例では、 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
Examples
次の例では、すべての資格情報を一覧表示します。
databricks credentials list-credentials
次の例では、サービス資格情報のみを一覧表示します。
databricks credentials list-credentials --purpose SERVICE
次の例では、最大 10 件の結果を含む資格情報を一覧表示します。
databricks credentials list-credentials --max-results 10
databricks 資格情報 update-credential
メタストアのサービスまたはストレージ資格情報を更新します。
呼び出し元は、資格情報またはメタストア管理者の所有者であるか、 MANAGE アクセス許可を持っている必要があります。 呼び出し元がメタストア管理者の場合は、 owner フィールドのみを変更できます。
databricks credentials update-credential NAME_ARG [flags]
Arguments
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 を指定します
Examples
次の例では、資格情報のコメントを更新します。
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 資格情報 validate-credential
資格情報を検証します。
サービス資格情報の場合 (目的は SERVICE)、 credential_name またはクラウド固有の資格情報を指定する必要があります。
ストレージ資格情報の場合 (目的は STORAGE)、少なくとも 1 つの external_location_name と url を指定する必要があります。 そのうちの 1 つだけが指定されている場合は、検証に使用されます。 また、両方が指定されている場合、 url は検証に使用され、重複する URL をチェックするときに external_location_name は無視されます。
credential_nameまたはクラウド固有の資格情報を指定する必要があります。
呼び出し元は、メタストア管理者または資格情報の所有者であるか、メタストアと資格情報に必要なアクセス許可を持っている必要があります (たとえば、目的がCREATE_EXTERNAL_LOCATIONSTORAGE)。
databricks credentials validate-credential [flags]
オプション
--credential-name string
Required
--external-location-name string
検証する既存の外部の場所の名前
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path
--purpose CredentialPurpose
資格情報の目的。 サポートされる値: SERVICE、STORAGE
--read-only
資格情報が読み取り操作にのみ使用できるかどうか
--url string
検証する外部の場所の URL
Examples
次の例では、サービス資格情報を検証します。
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 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では 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 文字列
該当する場合は、使用するバンドル ターゲット