storage-credentials コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のstorage-credentialsコマンドグループには、 Unity Catalogのストレージ資格情報を管理するためのコマンドが含まれています。ストレージ資格情報は、クラウド テナントに保存されているデータにアクセスするための認証および承認メカニズムを表します。各ストレージ資格情報には、資格情報にアクセスできるユーザーとグループを制御する Unity Catalog アクセス制御ポリシーが適用されます。ユーザーが Unity Catalog のストレージ資格情報にアクセスできない場合、要求は失敗し、Unity Catalog はユーザーに代わってクラウド テナントへの認証を試みません。ストレージ 資格情報の管理を参照してください。
databricks storage-credentials create
新しいストレージ資格情報を作成します。
呼び出し元は、メタストア管理者であるか、メタストアに対する CREATE_STORAGE_CREDENTIAL 特権を持っている必要があります。
databricks storage-credentials create NAME [flags]
引数
NAME
資格情報名。名前は、メタストア内のストレージおよびサービスの資格情報間で一意である必要があります。
オプション
--comment string
資格情報に関連付けられたコメント。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--read-only
資格情報が読み取り操作にのみ使用できるかどうか。
--skip-validation
この引数に true を指定すると、作成された資格情報の検証がスキップされます。
例
次の例では、新しいストレージ資格情報を作成します。
databricks storage-credentials create my-storage-credential
次の例では、コメントを含むストレージ資格情報を作成します。
databricks storage-credentials create my-storage-credential --comment "S3 credential for analytics data"
次の例では、読み取り専用のストレージ資格情報を作成します。
databricks storage-credentials create my-storage-credential --read-only
databricks storage-credentials delete
メタストアからストレージ資格情報を削除します。呼び出し元は、ストレージ資格情報の所有者である必要があります。
databricks storage-credentials delete NAME [flags]
引数
NAME
ストレージ資格情報の名前。
オプション
--force
依存外部ロケーションまたは外部テーブル (目的が STORAGEの場合) または依存サービス (目的が SERVICEの場合) がある場合でも、強制的に更新します。
例
次の例では、ストレージ資格情報を削除します。
databricks storage-credentials delete my-storage-credential
次の例では、ストレージ資格情報を強制的に削除します。
databricks storage-credentials delete my-storage-credential --force
databricks storage-credentials get
メタストアからストレージ資格情報を取得します。呼び出し元は、メタストア管理者、ストレージ資格情報の所有者であるか、ストレージ資格情報に対する何らかのアクセス許可を持っている必要があります。
databricks storage-credentials get NAME [flags]
引数
NAME
ストレージ資格情報の名前。
オプション
例
次の例では、ストレージ資格情報に関する情報を取得します。
databricks storage-credentials get my-storage-credential
databricks storage-credentials list
ストレージ資格情報を一覧表示します。このリストは、呼び出し元がアクセスする権限を持つストレージ資格情報のみに制限されます。呼び出し元がメタストア管理者の場合、資格情報の取得は制限されません。配列内の要素の特定の順序を保証するものではありません。
databricks storage-credentials list [flags]
オプション
--max-results int
返すストレージ資格情報の最大数。
--page-token string
前のクエリに基づいて次のページに移動するための不透明なページネーショントークン。
例
次の例は、すべてのストレージ資格情報を一覧表示します。
databricks storage-credentials list
databricks storage-credentials update
メタストアのストレージ資格情報を更新します。
呼び出し元は、ストレージ資格情報の所有者またはメタストア管理者である必要があります。呼び出し元がメタストア管理者の場合、変更できるのは owner フィールドのみです。
databricks storage-credentials update NAME [flags]
引数
NAME
ストレージ資格情報の名前。
オプション
--comment string
資格情報に関連付けられたコメント。
--force
依存する外部ロケーションまたは外部テーブルがある場合でも強制的に更新します。
--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 storage-credentials update my-storage-credential --comment "Updated S3 credential"
次の例では、ストレージ資格情報の所有者を変更します。
databricks storage-credentials update my-storage-credential --owner someone@example.com
次の例では、ストレージ資格情報の名前を変更します。
databricks storage-credentials update my-storage-credential --new-name updated-credential
databricks storage-credentials validate
ストレージ資格情報を検証します。少なくとも 1 つは external_location_name と url を提供する必要があります。そのうちの 1 つだけが指定されている場合は、検証に使用されます。また、両方が指定されている場合、 url は検証に使用され、重複するURLを確認するときに external_location_name は無視されます。
storage_credential_nameまたはクラウド固有の資格情報のいずれかを指定する必要があります。
呼び出し元は、メタストア管理者またはストレージ資格情報の所有者であるか、メタストアとストレージ資格情報に対する CREATE_EXTERNAL_LOCATION 特権を持っている必要があります。
databricks storage-credentials validate [flags]
オプション
--external-location-name string
検証する既存の外部ロケーションの名前。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--read-only
ストレージ資格情報が読み取り操作にのみ使用できるかどうか。
--storage-credential-name string
必須。
--url string
検証する外部ロケーションの URL。
例
次の例では、外部ロケーションに対してストレージ資格情報を検証します。
databricks storage-credentials validate --storage-credential-name my-storage-credential --external-location-name my-external-location
次の例では、ストレージ資格情報を URL に対して検証します。
databricks storage-credentials validate --storage-credential-name my-storage-credential --url s3://my-bucket/path
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット