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

Databricks CLI コマンド

注記

Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。

この記事では、利用可能なDatabricks CLIコマンドに関する情報を提供します。 この情報はコマンドラインヘルプを補足するものです。Databricks CLIインストールと使用に関する詳細については、 「 Databricks CLIインストールまたは更新」およびDatabricks CLIを参照してください。

Databricks CLI には、次の表に示すコマンド グループが含まれています。 コマンド グループには、関連するコマンドのセットが含まれており、サブコマンドを含めることもできます。 コマンド・グループ、個々のコマンド、またはサブコマンドの使用法と構文情報を出力するには、次のようにします。

  • databricks <command-group> -h
  • databricks <command-group> <command-name> -h
  • databricks <command-group> <command-name> <subcommand-name> -h

多くの CLI コマンドは、 Databricks REST API リファレンスに記載されている操作にマップされます。

ワークスペース コマンド​

グループ

説明とコマンド

fs

ファイルおよびファイル・システムを管理するためのコマンド:

cat、cp、ls、mkdir、 rm

git-credentials

Databricks がユーザーに代わって操作を行うための個人用アクセス トークンを登録するためのコマンド:

create、delete、get、list、 update

repos

ユーザーが自分の git リポジトリを管理できるようにするためのコマンド:

create、delete、get、list、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

secrets

シークレット、シークレットスコープ、およびアクセス権限を管理するためのコマンド:

create-scope、delete-acl、delete-scope、delete-secret、get-acl、get-secret、list-acls、list-scopes、list-secrets、put-acl、 put-secret

workspace

ワークスペース内のノートブックとフォルダーを一覧表示、インポート、エクスポート、および削除するコマンド:

delete、export、export-dir、get-status、import、import-dir、list、 mkdirs

get-permission-levels、get-permissions、set-permissions、 update-permissions

グループ

説明とコマンド

fs

ファイルおよびファイル・システムを管理するためのコマンド:

cat、cp、ls、mkdir、 rm

git-credentials

Databricks がユーザーに代わって操作を行うための個人用アクセス トークンを登録するためのコマンド:

create、delete、get、list、 update

repos

ユーザーが自分の git リポジトリを管理できるようにするためのコマンド:

create、delete、get、list、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

secrets

シークレット、シークレットスコープ、およびアクセス権限を管理するためのコマンド:

create-scope、delete-acl、delete-scope、delete-secret、get-acl、get-secret、list-acls、list-scopes、list-secrets、put-acl、 put-secret

workspace

ワークスペース内のノートブックとフォルダーを一覧表示、インポート、エクスポート、および削除するコマンド:

delete、export、export-dir、get-status、import、import-dir、list、 mkdirs

get-permission-levels、get-permissions、set-permissions、 update-permissions

コンピュート コマンド​

グループ

説明とコマンド

cluster-policies

一連のルールに基づいてクラスターを構成するユーザーの機能を制御するコマンド:

create、delete、edit、get、 list

get-permission-levels、get-permissions、set-permissions、 update-permissions

clusters

クラスターを作成、開始、編集、一覧表示、終了、および削除できるコマンド:

change-owner、create, delete, edit, events, get, list, list-node-types, list-zones, permanent-delete, pin, resize, restart, spark-versions, start, unpin

get-permission-levels、get-permissions、set-permissions、 update-permissions

環境

環境のバージョンとサーバーレス ノートブックとジョブの依存関係を定義するワークスペース レベルの基本環境を含む、環境リソースを管理するコマンド:

create-workspace-base-environment, delete-workspace-base-environment, get-default-workspace-base-environment, get-operation, get-workspace-base-environment, list-workspace-base-environments, refresh-workspace-base-environment, update-default-workspace-base-environment, update-workspace-base-environment

global-init-scripts

ワークスペース管理者がワークスペースのグローバル初期化スクリプトを構成できるようにするコマンド:

create、delete、get、list、 update

instance-pools

すぐに使用できるクラウドインスタンスを使用してインスタンスプールを作成、編集、削除、一覧表示するコマンドにより、クラスターの開始時間と自動スケーリング時間が短縮されます。

create、delete、edit、get、 list

get-permission-levels、get-permissions、set-permissions、 update-permissions

instance-profiles

管理者が、ユーザーがクラスターを起動できるインスタンスプロファイルを追加、一覧表示、削除できるようにするコマンド:

add、edit、list、 remove

libraries

クラスター上のライブラリをインストール、アンインストール、およびステータスを取得するコマンド:

all-cluster-statuses、cluster-status、install、 uninstall

クラスターのポリシーコンプライアンス

ワークスペース内のクラスターのポリシーコンプライアンスステータスを表示および管理するためのコマンド:

cancel-pending-cluster-enforcement、enforce-compliance、get-compliance、 list-compliance

policy-families

使用可能なポリシーファミリを表示するコマンド:

get, list

グループ

説明とコマンド

cluster-policies

一連のルールに基づいてクラスターを構成するユーザーの機能を制御するコマンド:

create、delete、edit、get、 list

get-permission-levels、get-permissions、set-permissions、 update-permissions

clusters

クラスターを作成、開始、編集、一覧表示、終了、および削除できるコマンド:

change-owner、create, delete, edit, events, get, list, list-node-types, list-zones, permanent-delete, pin, resize, restart, spark-versions, start, unpin

get-permission-levels、get-permissions、set-permissions、 update-permissions

環境

環境のバージョンとサーバーレス ノートブックとジョブの依存関係を定義するワークスペース レベルの基本環境を含む、環境リソースを管理するコマンド:

create-workspace-base-environment, delete-workspace-base-environment, get-default-workspace-base-environment, get-operation, get-workspace-base-environment, list-workspace-base-environments, refresh-workspace-base-environment, update-default-workspace-base-environment, update-workspace-base-environment

global-init-scripts

ワークスペース管理者がワークスペースのグローバル初期化スクリプトを構成できるようにするコマンド:

create、delete、get、list、 update

instance-pools

すぐに使用できるクラウドインスタンスを使用してインスタンスプールを作成、編集、削除、一覧表示するコマンドにより、クラスターの開始時間と自動スケーリング時間が短縮されます。

create、delete、edit、get、 list

get-permission-levels、get-permissions、set-permissions、 update-permissions

instance-profiles

管理者が、ユーザーがクラスターを起動できるインスタンスプロファイルを追加、一覧表示、削除できるようにするコマンド:

add、edit、list、 remove

libraries

クラスター上のライブラリをインストール、アンインストール、およびステータスを取得するコマンド:

all-cluster-statuses、cluster-status、install、 uninstall

クラスターのポリシーコンプライアンス

ワークスペース内のクラスターのポリシーコンプライアンスステータスを表示および管理するためのコマンド:

cancel-pending-cluster-enforcement、enforce-compliance、get-compliance、 list-compliance

policy-families

使用可能なポリシーファミリを表示するコマンド:

get, list

ジョブ・コマンド​

グループ

説明とコマンド

jobs

ジョブを管理するためのコマンド:

cancel-all-runs, cancel-run, create, delete, delete-run, export-run, get, get-run, get-run-output, list, list-runs, repair-run, reset, run-now, submit, update

get-permission-levels、get-permissions、set-permissions、 update-permissions

仕事のためのポリシー・コンプライアンス

ワークスペース内のジョブのポリシーコンプライアンスステータスを表示および管理するためのコマンド:

enforce-compliance、get-compliance、 list-compliance

グループ

説明とコマンド

jobs

ジョブを管理するためのコマンド:

cancel-all-runs, cancel-run, create, delete, delete-run, export-run, get, get-run, get-run-output, list, list-runs, repair-run, reset, run-now, submit, update

get-permission-levels、get-permissions、set-permissions、 update-permissions

仕事のためのポリシー・コンプライアンス

ワークスペース内のジョブのポリシーコンプライアンスステータスを表示および管理するためのコマンド:

enforce-compliance、get-compliance、 list-compliance

パイプラインコマンド​

グループ

説明とコマンド

pipelines

LakeFlow Pipelines を変更および管理するコマンド:

clone、create、delete、get、get-update、list-pipeline-events、list-pipelines、list-updates、start-update、stop、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

apply-environment、deploy、destroy、dry-run、generate、history、init、logs、open、run、 stop

グループ

説明とコマンド

pipelines

LakeFlow Pipelines を変更および管理するコマンド:

clone、create、delete、get、get-update、list-pipeline-events、list-pipelines、list-updates、start-update、stop、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

apply-environment、deploy、destroy、dry-run、generate、history、init、logs、open、run、 stop

機械学習コマンド​

グループ

説明とコマンド

空気

AI ランタイム GPUワークロードを送信および管理するためのコマンド:

cancel, convert-to-dabs, get, images push, list, logs, pools get, pools list, run

experiments

MLflowの組織の主要な単位であるエクスペリメントと対話するためのコマンド ;すべてのMLflow実行はエクスペリメントに属します。

create-experiment、 create-logged-model 、 create-run 、 delete-experiment 、 delete-logged-model 、 delete-logged-model-tag 、 delete-run 、 delete-runs 、 delete-tag 、 finalize-logged-model 、 get-by-name 、 get-experiment 、 get-history 、 get-logged-model 、 get-run 、 list-artifacts 、 list-experiments 、 log-batch 、 log-inputs 、 log-logged-model-params 、 log-metric 、 log-model 、 log-outputs 、 log-param 、 restore-experiment 、 restore-run 、 restore-runs 、 search-experiments 、 search-logged-models 、 search-runs 、 set-experiment-tag 、 set-logged-model-tags 、 set-tag 、 update-experiment 、 update-run

get-permission-levels、get-permissions、set-permissions、 update-permissions

特徴エンジニアリング

AI および ML モデルで使用される機能の中央レジストリを提供するDatabricks Feature Store内の機能を操作するためのコマンド。

create-feature、create-kafka-config、create-materialized-feature、create-stream、delete-feature、delete-kafka-config、delete-materialized-feature、delete-stream、get-feature、get-kafka-config、get-materialized-feature、get-stream、list-features、list-kafka-configs、list-materialized-features、list-streams、update-feature、update-kafka-config、update-materialized-feature、 update-stream

model-registry

Workspace Model Registryのコマンド :

approve-transition-request、 create-comment、 create-model、 create-model-version、 create-transition-request、 create-webhook、 delete-comment、 delete-model、 delete-model-tag、 delete-model-version、 delete-model-version-tag、 delete-transition-request、 delete-webhook、 get-latest-versions、 get-model、 get-model-version、get-model-version-download-uri、 list-models、 list-transition-requests、 list-webhooks、 reject-transition-request, rename-model, search-model-versions, search-models, set-model-tag, set-model-version-tag, test-registry-webhook, transition-stage, update-comment, update-model, update-model-version, update-webhook

get-permission-levels、get-permissions、set-permissions、 update-permissions

グループ

説明とコマンド

空気

AI ランタイム GPUワークロードを送信および管理するためのコマンド:

cancel, convert-to-dabs, get, images push, list, logs, pools get, pools list, run

experiments

MLflowの組織の主要な単位であるエクスペリメントと対話するためのコマンド ;すべてのMLflow実行はエクスペリメントに属します。

create-experiment、 create-logged-model 、 create-run 、 delete-experiment 、 delete-logged-model 、 delete-logged-model-tag 、 delete-run 、 delete-runs 、 delete-tag 、 finalize-logged-model 、 get-by-name 、 get-experiment 、 get-history 、 get-logged-model 、 get-run 、 list-artifacts 、 list-experiments 、 log-batch 、 log-inputs 、 log-logged-model-params 、 log-metric 、 log-model 、 log-outputs 、 log-param 、 restore-experiment 、 restore-run 、 restore-runs 、 search-experiments 、 search-logged-models 、 search-runs 、 set-experiment-tag 、 set-logged-model-tags 、 set-tag 、 update-experiment 、 update-run

get-permission-levels、get-permissions、set-permissions、 update-permissions

特徴エンジニアリング

AI および ML モデルで使用される機能の中央レジストリを提供するDatabricks Feature Store内の機能を操作するためのコマンド。

create-feature、create-kafka-config、create-materialized-feature、create-stream、delete-feature、delete-kafka-config、delete-materialized-feature、delete-stream、get-feature、get-kafka-config、get-materialized-feature、get-stream、list-features、list-kafka-configs、list-materialized-features、list-streams、update-feature、update-kafka-config、update-materialized-feature、 update-stream

model-registry

Workspace Model Registryのコマンド :

approve-transition-request、 create-comment、 create-model、 create-model-version、 create-transition-request、 create-webhook、 delete-comment、 delete-model、 delete-model-tag、 delete-model-version、 delete-model-version-tag、 delete-transition-request、 delete-webhook、 get-latest-versions、 get-model、 get-model-version、get-model-version-download-uri、 list-models、 list-transition-requests、 list-webhooks、 reject-transition-request, rename-model, search-model-versions, search-models, set-model-tag, set-model-version-tag, test-registry-webhook, transition-stage, update-comment, update-model, update-model-version, update-webhook

get-permission-levels、get-permissions、set-permissions、 update-permissions

リアルタイムサービングコマンド​

グループ

説明とコマンド

serving-endpoints

モデルサービングエンドポイントを作成、更新、削除するコマンド:

build-logs, create, create-provisioned-throughput-endpoint, delete, export-metrics, get, get-open-api, list, logs, patch, put, put-ai-gateway, query, update-config, update-notifications, update-provisioned-throughput-endpoint-config

get-permission-levels、get-permissions、set-permissions、 update-permissions

グループ

説明とコマンド

serving-endpoints

モデルサービングエンドポイントを作成、更新、削除するコマンド:

build-logs, create, create-provisioned-throughput-endpoint, delete, export-metrics, get, get-open-api, list, logs, patch, put, put-ai-gateway, query, update-config, update-notifications, update-provisioned-throughput-endpoint-config

get-permission-levels、get-permissions、set-permissions、 update-permissions

アイデンティティとアクセスコマンド​

グループ

説明とコマンド

account

Databricks アカウントを管理するためのコマンド:

  • IDとアクセス権:access-control、groups、groups-v2、iam-v2、service-principals、service-principals-v2、users、users-v2、 workspace-assignment
  • Unity Catalog:metastore-assignments、metastores、 storage-credentials
  • 設定:endpoints、ip-access-lists、network-connectivity、network-policies、settings、settings-v2、 workspace-network-configuration
  • プロビジョニング: credentials、 encryption-keys、 networks、 private-access、 storage、 vpc-endpoints、 workspaces
  • 請求先: billable-usage 、 budget-policy 、 budgets 、 log-delivery 、 usage-dashboards
  • OAuth: custom-app-integration 、 federation-policy 、 o-auth-published-apps 、 published-app-integration 、 service-principal-federation-policy 、 service-principal-secrets
  • ディザスタリカバリ: disaster-recovery

認証

認証用のコマンド:

describe、login、logout、profiles、switch、 token

current-user

現在認証されているユーザーまたはサービスプリンシパルに関する情報を取得するコマンド:

me

groups

ID 管理を簡素化し、Databricks ワークスペース、データ、その他のセキュリティ保護可能なオブジェクトへのアクセスを簡単に割り当てるグループ用のコマンド:

create、delete、get、list、patch、 update

グループ-v2

更新されたAPIを使用してDatabricksワークスペースのグループを管理するためのコマンド。 グループは ID 管理を簡素化し、 Databricksワークスペース、データ、その他のセキュリティ保護可能なオブジェクトへのアクセスを簡単に割り当てられるようにします。

create、delete、get、list、patch、 update

permissions

さまざまなオブジェクトやエンドポイントで、さまざまなユーザーのアクセスを読み取り、書き込み、編集、更新、管理するためのコマンド:

get、set、 update

get-permission-levels

サービスプリンシパルシークレットプロキシ

ワークスペースレベルでサービスプリンシパルのシークレットを管理するためのコマンド。生成されたシークレットを使用して、サービスプリンシパルのOAuthアクセストークンを取得します。

create、delete、 list

service-principals

ジョブ、自動化ツール、およびシステム (スクリプト、アプリ、CI/CD プラットフォームなど) で使用する ID のコマンド:

create、delete、get、list、patch、 update

サービスシプリンパル-v2

更新されたAPIを使用してサービス プリンシパル ID を管理するためのコマンド。ジョブ、自動化ツール、およびスクリプト、アプリ、 CI/CDプラットフォームなどのシステムで使用します。

create、delete、get、list、patch、 update

users

Databricksによって認識され、Eメール アドレスで表されるユーザー ID のコマンド:

create、delete、get、list、patch、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

ユーザー-v2

更新されたAPIを使用してDatabricksワークスペースでユーザー ID を管理するためのコマンド:

create、delete、get、list、patch、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

ワークスペース-iam-v2

IDとワークスペースへのアクセスを管理するためのコマンド:

get-workspace-access-detail-local、resolve-group-proxy、resolve-service-principal-proxy、 resolve-user-proxy

グループ

説明とコマンド

account

Databricks アカウントを管理するためのコマンド:

  • IDとアクセス権:access-control、groups、groups-v2、iam-v2、service-principals、service-principals-v2、users、users-v2、 workspace-assignment
  • Unity Catalog:metastore-assignments、metastores、 storage-credentials
  • 設定:endpoints、ip-access-lists、network-connectivity、network-policies、settings、settings-v2、 workspace-network-configuration
  • プロビジョニング: credentials、 encryption-keys、 networks、 private-access、 storage、 vpc-endpoints、 workspaces
  • 請求先: billable-usage 、 budget-policy 、 budgets 、 log-delivery 、 usage-dashboards
  • OAuth: custom-app-integration 、 federation-policy 、 o-auth-published-apps 、 published-app-integration 、 service-principal-federation-policy 、 service-principal-secrets
  • ディザスタリカバリ: disaster-recovery

認証

認証用のコマンド:

describe、login、logout、profiles、switch、 token

current-user

現在認証されているユーザーまたはサービスプリンシパルに関する情報を取得するコマンド:

me

groups

ID 管理を簡素化し、Databricks ワークスペース、データ、その他のセキュリティ保護可能なオブジェクトへのアクセスを簡単に割り当てるグループ用のコマンド:

create、delete、get、list、patch、 update

グループ-v2

更新されたAPIを使用してDatabricksワークスペースのグループを管理するためのコマンド。 グループは ID 管理を簡素化し、 Databricksワークスペース、データ、その他のセキュリティ保護可能なオブジェクトへのアクセスを簡単に割り当てられるようにします。

create、delete、get、list、patch、 update

permissions

さまざまなオブジェクトやエンドポイントで、さまざまなユーザーのアクセスを読み取り、書き込み、編集、更新、管理するためのコマンド:

get、set、 update

get-permission-levels

サービスプリンシパルシークレットプロキシ

ワークスペースレベルでサービスプリンシパルのシークレットを管理するためのコマンド。生成されたシークレットを使用して、サービスプリンシパルのOAuthアクセストークンを取得します。

create、delete、 list

service-principals

ジョブ、自動化ツール、およびシステム (スクリプト、アプリ、CI/CD プラットフォームなど) で使用する ID のコマンド:

create、delete、get、list、patch、 update

サービスシプリンパル-v2

更新されたAPIを使用してサービス プリンシパル ID を管理するためのコマンド。ジョブ、自動化ツール、およびスクリプト、アプリ、 CI/CDプラットフォームなどのシステムで使用します。

create、delete、get、list、patch、 update

users

Databricksによって認識され、Eメール アドレスで表されるユーザー ID のコマンド:

create、delete、get、list、patch、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

ユーザー-v2

更新されたAPIを使用してDatabricksワークスペースでユーザー ID を管理するためのコマンド:

create、delete、get、list、patch、 update

get-permission-levels、get-permissions、set-permissions、 update-permissions

ワークスペース-iam-v2

IDとワークスペースへのアクセスを管理するためのコマンド:

get-workspace-access-detail-local、resolve-group-proxy、resolve-service-principal-proxy、 resolve-user-proxy

SQL 関連のコマンド​

グループ

説明とコマンド

alerts

アラートに対して操作を実行するコマンド:

create、delete、get、list、 update

alerts-legacy

非推奨。レガシーアラートに対する操作を実行するコマンド:

create、delete、get、list、 update

アラート-v2

更新されたAPIを使用してSQLアラートを管理するコマンド。 アラートは定期的にクエリを実行し、その結果の条件を評価し、条件が満たされた場合にユーザーや通知先に通知します。

create-alert、get-alert、list-alerts、trash-alert、 update-alert

data-sources

非推奨。新しいクエリ オブジェクトを作成するためのコマンド:

list

queries

クエリ定義に対して操作を実行するコマンド:

create、delete、get、list、restore、 update

queries-legacy

非推奨。レガシー クエリ定義に対して操作を実行するコマンド:

create、delete、get、list、restore、 update

query-history

ウェアハウスを通じてクエリの履歴にアクセスするためのコマンド SQL:

list

warehouses

SQLウェアハウスを管理するためのコマンド (これは、 内のデータ オブジェクトに対して コマンドを実行できるコンピュート リソースです。SQLDatabricks SQL

create、 create-default-warehouse-override 、 delete 、 delete-default-warehouse-override 、 edit 、 get 、 get-default-warehouse-override 、 get-workspace-warehouse-config 、 list 、 list-default-warehouse-overrides 、 set-workspace-warehouse-config 、 start 、 stop 、 update-default-warehouse-override

get-permission-levels、get-permissions、set-permissions、 update-permissions

グループ

説明とコマンド

alerts

アラートに対して操作を実行するコマンド:

create、delete、get、list、 update

alerts-legacy

非推奨。レガシーアラートに対する操作を実行するコマンド:

create、delete、get、list、 update

アラート-v2

更新されたAPIを使用してSQLアラートを管理するコマンド。 アラートは定期的にクエリを実行し、その結果の条件を評価し、条件が満たされた場合にユーザーや通知先に通知します。

create-alert、get-alert、list-alerts、trash-alert、 update-alert

data-sources

非推奨。新しいクエリ オブジェクトを作成するためのコマンド:

list

queries

クエリ定義に対して操作を実行するコマンド:

create、delete、get、list、restore、 update

queries-legacy

非推奨。レガシー クエリ定義に対して操作を実行するコマンド:

create、delete、get、list、restore、 update

query-history

ウェアハウスを通じてクエリの履歴にアクセスするためのコマンド SQL:

list

warehouses

SQLウェアハウスを管理するためのコマンド (これは、 内のデータ オブジェクトに対して コマンドを実行できるコンピュート リソースです。SQLDatabricks SQL

create、 create-default-warehouse-override 、 delete 、 delete-default-warehouse-override 、 edit 、 get 、 get-default-warehouse-override 、 get-workspace-warehouse-config 、 list 、 list-default-warehouse-overrides 、 set-workspace-warehouse-config 、 start 、 stop 、 update-default-warehouse-override

get-permission-levels、get-permissions、set-permissions、 update-permissions

Unity Catalog コマンド​

グループ

説明とコマンド

artifact-allowlists

アーティファクトの許可リストを管理するコマンド。 Databricks Runtime 13.3以降では、ライブラリとinitスクリプトをUCの許可リストに追加して、ユーザーが標準アクセスモードで設定されたコンピュートでこれらのアーティファクトを活用できるようにすることができます。

get, update

catalogs

カタログ (Unity Catalog の 3 レベル名前空間の最初のレイヤー) を管理するコマンド:

create、delete、get、list、 update

connections

外部データソースへの接続を作成するコマンド:

create、delete、get、list、 update

credentials

資格情報を管理するためのコマンド (クラウド テナント上のサービスにアクセスするための認証および承認メカニズム)。各資格情報は、資格情報にアクセスできるユーザーとグループを制御する Unity Catalog アクセス制御ポリシーの対象となります。

create-credential、delete-credential、generate-temporary-service-credential、get-credential、list-credentials、update-credential、 validate-credential

データ分類

Unity Catalogカタログのデータ分類構成を管理するためのコマンド。 データ分類はUnity Catalogテーブル内の機密データを自動的に識別し、タグ付けします。

create-catalog-config、delete-catalog-config、get-catalog-config、 update-catalog-config

データ品質

Unity Catalog オブジェクトのデータ品質を管理するためのコマンド (現在はスキーマとテーブルをサポートしています):

cancel-refresh、create-monitor、create-refresh、delete-monitor、get-monitor、get-refresh、list-refresh、 update-monitor

エンティティタグの割り当て

Unity Catalogエンティティ全体のタグ割り当てを作成、更新、削除、および一覧表示するコマンド:

create、delete、get、list、 update

外部リネージ

Databricksオブジェクトと外部システム間のリネージ関係を定義および管理するコマンド:

create-external-lineage-relationship、delete-external-lineage-relationship、list-external-lineage-relationships、 update-external-lineage-relationship

external-locations

クラウドストレージパスと、クラウドストレージパスへのアクセスを許可するストレージ認証情報を組み合わせた外部ロケーションを管理するためのコマンド:

create、delete、get、list、 update

外部メタデータ

Unity Catalog内の外部システムに関するメタデータを登録および管理するコマンド:

create-external-metadata、delete-external-metadata、get-external-metadata、list-external-metadata、 update-external-metadata

functions

Unity Catalog で ユーザー定義関数 (UDF) を管理するためのコマンド:

create、delete、get、list、 update

grants

Unity Catalog 内のデータへのアクセスを許可するコマンド:

get、get-effective、 update

metastores

メタストア (Unity Catalog 内のオブジェクトの最上位コンテナー) を管理するためのコマンド:

assign、create、current、delete、get、list、summary、unassign、update、 update-assignment

model-versions

モデルのバージョンを管理するためのコマンド。 Databricksでは、Unity CatalogでホストされたバージョンのMLflow Model Registryを提供します。

delete、get、get-by-alias、list、 update

online-tables

オンライン テーブルを管理するコマンド (Delta テーブルのデータへの待機時間を短縮し、QPS アクセスを高速化する):

create、delete、 get

ポリシー

Unity Catalogで属性ベースのアクセス制御 (ABAC) ポリシーを管理するコマンド。 ABAC ポリシーを使用すると、特定のリソースではなくデータ属性に基づいてアクセスが制御されます。

create-policy、delete-policy、get-policy、list-policies、 update-policy

quality-monitors

モニターを管理するコマンドは、時間の経過と共にテーブルのデータまたはモデル品質メトリクスを監視するモニターです。

create、delete、get、get-refresh、list-refreshes、run-refresh、 update

品質モニターv2

非推奨です。Unity Catalogオブジェクトのデータ品質モニターを管理するコマンド。 代わりにデータ品質を使用してください。

create-quality-monitor、delete-quality-monitor、get-quality-monitor、list-quality-monitor、 update-quality-monitor

registered-models

登録されたモデルを管理するためのコマンド。 Databricksは、Unity CatalogでホストされたバージョンのMLflow Model Registry を提供します。

create、delete、delete-alias、get、list、set-alias、 update

resource-quotas

Unity Catalog によってすべてのセキュリティ保護可能なオブジェクトに適用されるリソース クォータを管理するコマンド (作成できるリソースの数を制限します)。

get-quota, list-quotas

RFA

ユーザーが Unity Catalog のセキュリティ保護可能なリソースへのアクセスを要求できるようにするコマンド。

batch-create-access-requests、get-access-request-destinations、 update-access-request-destinations

schemas

Unity Catalog の 3 レベル名前空間の 2 番目のレイヤーであるスキーマを管理するためのコマンド。

create、delete、get、list、 update

secrets-uc

パスワード、トークン、キーなどの機密性の高い認証情報を3層から成る名前空間内に格納する、Unity Catalogのシークレットを管理するためのコマンド。パブリックプレビュー:

create-secret、delete-secret、get-secret、list-secrets、 update-secret

storage-credentials

ストレージ資格情報を管理するコマンド (クラウド テナントに格納されているデータにアクセスするための認証および承認メカニズム):

create、delete、get、list、update、 validate

system-schemas

システム・スキーマ (システム・カタログ内に存在するスキーマ) を管理するコマンド:

disable、enable、 list

table-constraints

テーブル内のフィールド間の関係をエンコードする主キー制約と外部キー制約を管理するコマンド:

create, delete

tables

コマンドは、 Unity Catalogの 3 レベル名前空間の 3 番目のレイヤーに存在するマネージドテーブルに対して行われます。

create、delete、exists、get、list、 list-summaries

一時パス資格情報

一時パス資格情報を管理するためのコマンド。一時パス資格情報は、Databricks に登録された外部クラウド ストレージの場所にアクセスするために使用される、有効期間が短く、スコープが縮小された資格情報です。

generate-temporary-path-credentials

temporary-table-credentials

一時テーブルの資格情報 (Databricks にテーブル データが格納されているクラウド ストレージの場所にアクセスするために使用される、有効期間が短く、スコープが縮小された資格情報) を管理するコマンド。

generate-temporary-table-credentials

temporary-volume-credentials

一時的なボリューム認証情報を管理するためのコマンド。これは、Databricks 内のボリュームデータが保存されているクラウドストレージの場所へのアクセスに使用される、短期間でスコープが制限された認証情報です。パブリックプレビュー:

generate-temporary-volume-credentials

volumes

ボリュームを管理するためのコマンド (ファイルへのアクセス、保存、管理、整理、処理のための Unity Catalog (UC) 機能) です。

create、delete、list、read、 update

workspace-bindings

セキュリティ保護可能なワークスペース バインドを管理するためのコマンド。 Databricks のセキュリティ保護可能なリソースは、 OPEN または ISOLATEDとして構成できます。

get、get-bindings、update、 update-bindings

グループ

説明とコマンド

artifact-allowlists

アーティファクトの許可リストを管理するコマンド。 Databricks Runtime 13.3以降では、ライブラリとinitスクリプトをUCの許可リストに追加して、ユーザーが標準アクセスモードで設定されたコンピュートでこれらのアーティファクトを活用できるようにすることができます。

get, update

catalogs

カタログ (Unity Catalog の 3 レベル名前空間の最初のレイヤー) を管理するコマンド:

create、delete、get、list、 update

connections

外部データソースへの接続を作成するコマンド:

create、delete、get、list、 update

credentials

資格情報を管理するためのコマンド (クラウド テナント上のサービスにアクセスするための認証および承認メカニズム)。各資格情報は、資格情報にアクセスできるユーザーとグループを制御する Unity Catalog アクセス制御ポリシーの対象となります。

create-credential、delete-credential、generate-temporary-service-credential、get-credential、list-credentials、update-credential、 validate-credential

データ分類

Unity Catalogカタログのデータ分類構成を管理するためのコマンド。 データ分類はUnity Catalogテーブル内の機密データを自動的に識別し、タグ付けします。

create-catalog-config、delete-catalog-config、get-catalog-config、 update-catalog-config

データ品質

Unity Catalog オブジェクトのデータ品質を管理するためのコマンド (現在はスキーマとテーブルをサポートしています):

cancel-refresh、create-monitor、create-refresh、delete-monitor、get-monitor、get-refresh、list-refresh、 update-monitor

エンティティタグの割り当て

Unity Catalogエンティティ全体のタグ割り当てを作成、更新、削除、および一覧表示するコマンド:

create、delete、get、list、 update

外部リネージ

Databricksオブジェクトと外部システム間のリネージ関係を定義および管理するコマンド:

create-external-lineage-relationship、delete-external-lineage-relationship、list-external-lineage-relationships、 update-external-lineage-relationship

external-locations

クラウドストレージパスと、クラウドストレージパスへのアクセスを許可するストレージ認証情報を組み合わせた外部ロケーションを管理するためのコマンド:

create、delete、get、list、 update

外部メタデータ

Unity Catalog内の外部システムに関するメタデータを登録および管理するコマンド:

create-external-metadata、delete-external-metadata、get-external-metadata、list-external-metadata、 update-external-metadata

functions

Unity Catalog で ユーザー定義関数 (UDF) を管理するためのコマンド:

create、delete、get、list、 update

grants

Unity Catalog 内のデータへのアクセスを許可するコマンド:

get、get-effective、 update

metastores

メタストア (Unity Catalog 内のオブジェクトの最上位コンテナー) を管理するためのコマンド:

assign、create、current、delete、get、list、summary、unassign、update、 update-assignment

model-versions

モデルのバージョンを管理するためのコマンド。 Databricksでは、Unity CatalogでホストされたバージョンのMLflow Model Registryを提供します。

delete、get、get-by-alias、list、 update

online-tables

オンライン テーブルを管理するコマンド (Delta テーブルのデータへの待機時間を短縮し、QPS アクセスを高速化する):

create、delete、 get

ポリシー

Unity Catalogで属性ベースのアクセス制御 (ABAC) ポリシーを管理するコマンド。 ABAC ポリシーを使用すると、特定のリソースではなくデータ属性に基づいてアクセスが制御されます。

create-policy、delete-policy、get-policy、list-policies、 update-policy

quality-monitors

モニターを管理するコマンドは、時間の経過と共にテーブルのデータまたはモデル品質メトリクスを監視するモニターです。

create、delete、get、get-refresh、list-refreshes、run-refresh、 update

品質モニターv2

非推奨です。Unity Catalogオブジェクトのデータ品質モニターを管理するコマンド。 代わりにデータ品質を使用してください。

create-quality-monitor、delete-quality-monitor、get-quality-monitor、list-quality-monitor、 update-quality-monitor

registered-models

登録されたモデルを管理するためのコマンド。 Databricksは、Unity CatalogでホストされたバージョンのMLflow Model Registry を提供します。

create、delete、delete-alias、get、list、set-alias、 update

resource-quotas

Unity Catalog によってすべてのセキュリティ保護可能なオブジェクトに適用されるリソース クォータを管理するコマンド (作成できるリソースの数を制限します)。

get-quota, list-quotas

RFA

ユーザーが Unity Catalog のセキュリティ保護可能なリソースへのアクセスを要求できるようにするコマンド。

batch-create-access-requests、get-access-request-destinations、 update-access-request-destinations

schemas

Unity Catalog の 3 レベル名前空間の 2 番目のレイヤーであるスキーマを管理するためのコマンド。

create、delete、get、list、 update

secrets-uc

パスワード、トークン、キーなどの機密性の高い認証情報を3層から成る名前空間内に格納する、Unity Catalogのシークレットを管理するためのコマンド。パブリックプレビュー:

create-secret、delete-secret、get-secret、list-secrets、 update-secret

storage-credentials

ストレージ資格情報を管理するコマンド (クラウド テナントに格納されているデータにアクセスするための認証および承認メカニズム):

create、delete、get、list、update、 validate

system-schemas

システム・スキーマ (システム・カタログ内に存在するスキーマ) を管理するコマンド:

disable、enable、 list

table-constraints

テーブル内のフィールド間の関係をエンコードする主キー制約と外部キー制約を管理するコマンド:

create, delete

tables

コマンドは、 Unity Catalogの 3 レベル名前空間の 3 番目のレイヤーに存在するマネージドテーブルに対して行われます。

create、delete、exists、get、list、 list-summaries

一時パス資格情報

一時パス資格情報を管理するためのコマンド。一時パス資格情報は、Databricks に登録された外部クラウド ストレージの場所にアクセスするために使用される、有効期間が短く、スコープが縮小された資格情報です。

generate-temporary-path-credentials

temporary-table-credentials

一時テーブルの資格情報 (Databricks にテーブル データが格納されているクラウド ストレージの場所にアクセスするために使用される、有効期間が短く、スコープが縮小された資格情報) を管理するコマンド。

generate-temporary-table-credentials

temporary-volume-credentials

一時的なボリューム認証情報を管理するためのコマンド。これは、Databricks 内のボリュームデータが保存されているクラウドストレージの場所へのアクセスに使用される、短期間でスコープが制限された認証情報です。パブリックプレビュー:

generate-temporary-volume-credentials

volumes

ボリュームを管理するためのコマンド (ファイルへのアクセス、保存、管理、整理、処理のための Unity Catalog (UC) 機能) です。

create、delete、list、read、 update

workspace-bindings

セキュリティ保護可能なワークスペース バインドを管理するためのコマンド。 Databricks のセキュリティ保護可能なリソースは、 OPEN または ISOLATEDとして構成できます。

get、get-bindings、update、 update-bindings

タグコマンド​

グループ

説明とコマンド

タグポリシー

Databricksで管理タグのポリシーを管理するコマンド:

create-tag-policy、delete-tag-policy、get-tag-policy、 update-tag-policy

ワークスペースエンティティタグの割り当て

ワークスペース スコープのオブジェクトに対するタグの割り当てを管理するためのコマンド:

create-tag-assignment、delete-tag-assignment、get-tag-assignment、list-tag-assignment、 update-tag-assignment

グループ

説明とコマンド

タグポリシー

Databricksで管理タグのポリシーを管理するコマンド:

create-tag-policy、delete-tag-policy、get-tag-policy、 update-tag-policy

ワークスペースエンティティタグの割り当て

ワークスペース スコープのオブジェクトに対するタグの割り当てを管理するためのコマンド:

create-tag-assignment、delete-tag-assignment、get-tag-assignment、list-tag-assignment、 update-tag-assignment

オープン共有コマンド​

グループ

説明とコマンド

providers

データを共有する組織を表すデータ プロバイダーを管理するためのコマンド:

create、delete、get、list、list-shares、 update

recipient-activation

受信者のアクティベーションを管理するコマンド(受信者オブジェクトの認証の種類がトークンであるDatabricks-to-Open共有モデルでのみ適用):

get-activation-url-info, retrieve-token

recipients

受信者を管理するコマンド (共有へのアクセスを許可する組織を表すために :method:recipients/create を使用して作成します)。

create、delete、get、list、rotate-token、 update

share-permissions

受信者フェデレーションポリシー

Databricks からオープン共有モデルにおける OIDC 受信者向けフェデレーションポリシーを管理するコマンド:

create、delete、get-federation-policy、 list

shares

共有を管理するコマンド ( :method:shares/createでインスタンス化されたコンテナ):

create、delete、get、list、list-shares、 update

share-permissions, update-permissions

グループ

説明とコマンド

providers

データを共有する組織を表すデータ プロバイダーを管理するためのコマンド:

create、delete、get、list、list-shares、 update

recipient-activation

受信者のアクティベーションを管理するコマンド(受信者オブジェクトの認証の種類がトークンであるDatabricks-to-Open共有モデルでのみ適用):

get-activation-url-info, retrieve-token

recipients

受信者を管理するコマンド (共有へのアクセスを許可する組織を表すために :method:recipients/create を使用して作成します)。

create、delete、get、list、rotate-token、 update

share-permissions

受信者フェデレーションポリシー

Databricks からオープン共有モデルにおける OIDC 受信者向けフェデレーションポリシーを管理するコマンド:

create、delete、get-federation-policy、 list

shares

共有を管理するコマンド ( :method:shares/createでインスタンス化されたコンテナ):

create、delete、get、list、list-shares、 update

share-permissions, update-permissions

設定コマンド​

グループ

説明とコマンド

ip-access-lists

管理者がIPアクセスリストを設定できるようにするコマンド:

create、delete、get、list、replace、 update

notification-destinations

ワークスペースの通知先を管理するコマンド:

create、delete、get、list、 update

settings

ユーザーがワークスペース レベルで設定を管理できるようにするコマンド:

aibi-dashboard-embedding-access-policy、 aibi-dashboard-embedding-approved-domains 、 automatic-cluster-update 、 compliance-security-profile 、 dashboard-email-subscriptions 、 default-namespace 、 disable-legacy-access 、 disable-legacy-dbfs 、 enable-export-notebook 、 enable-notebook-table-clipboard 、 enable-results-downloading 、 enhanced-security-monitoring 、 restrict-workspace-admins 、 sql-results-download

token-management

管理者が他のユーザーのすべてのトークンを取得し、トークンを削除できるようにするコマンド:

create-obo-token、delete、get、list、 update-token-management

get-permission-levels、get-permissions、set-permissions、 update-permissions

トークン

認証とアクセスに使用できるトークンを作成、一覧表示、および取り消すコマンド Databricks REST API:

create、delete、list、 update

ワークスペース構成

ワークスペース設定を更新するコマンド:

get-status, set-status

ワークスペース設定-v2

更新されたAPIを使用してワークスペースレベルの設定を管理するためのコマンド:

get-public-workspace-setting、list-workspace-settings-metadata、 patch-public-workspace-setting

グループ

説明とコマンド

ip-access-lists

管理者がIPアクセスリストを設定できるようにするコマンド:

create、delete、get、list、replace、 update

notification-destinations

ワークスペースの通知先を管理するコマンド:

create、delete、get、list、 update

settings

ユーザーがワークスペース レベルで設定を管理できるようにするコマンド:

aibi-dashboard-embedding-access-policy、 aibi-dashboard-embedding-approved-domains 、 automatic-cluster-update 、 compliance-security-profile 、 dashboard-email-subscriptions 、 default-namespace 、 disable-legacy-access 、 disable-legacy-dbfs 、 enable-export-notebook 、 enable-notebook-table-clipboard 、 enable-results-downloading 、 enhanced-security-monitoring 、 restrict-workspace-admins 、 sql-results-download

token-management

管理者が他のユーザーのすべてのトークンを取得し、トークンを削除できるようにするコマンド:

create-obo-token、delete、get、list、 update-token-management

get-permission-levels、get-permissions、set-permissions、 update-permissions

トークン

認証とアクセスに使用できるトークンを作成、一覧表示、および取り消すコマンド Databricks REST API:

create、delete、list、 update

ワークスペース構成

ワークスペース設定を更新するコマンド:

get-status, set-status

ワークスペース設定-v2

更新されたAPIを使用してワークスペースレベルの設定を管理するためのコマンド:

get-public-workspace-setting、list-workspace-settings-metadata、 patch-public-workspace-setting

開発者ツールのコマンド​

グループ

説明とコマンド

AIツール

コーディング エージェント向け Databricks AI スキルのインストール、管理、更新コマンド:

install、list、uninstall、update、 version

bundle

Databricksプロジェクトをコードとして表現できる宣言型自動化バンドルを管理するためのコマンド:

deploy、deployment、destroy、generate、init、open、plan、run、schema、summary、sync、 validate

sync

ローカルディレクトリをワークスペースディレクトリに同期します。

ssh

DatabricksコンピュートとワークスペースへのSSH接続を設定および確立するためのコマンド。

connect, setup

グループ

説明とコマンド

AIツール

コーディング エージェント向け Databricks AI スキルのインストール、管理、更新コマンド:

install、list、uninstall、update、 version

bundle

Databricksプロジェクトをコードとして表現できる宣言型自動化バンドルを管理するためのコマンド:

deploy、deployment、destroy、generate、init、open、plan、run、schema、summary、sync、 validate

sync

ローカルディレクトリをワークスペースディレクトリに同期します。

ssh

DatabricksコンピュートとワークスペースへのSSH接続を設定および確立するためのコマンド。

connect, setup

AI Searchコマンド​

グループ

説明とコマンド

ai-search

AI Search Endpointおよびインデックスを管理するためのコマンド。AI Search Endpointは、AI Searchインデックスをホストするためのコンピュートリソースを表します:

create-endpoint、 create-index 、 delete-endpoint 、 delete-index 、 get-endpoint 、 get-index 、 list-endpoints 、 list-indexes 、 query-index 、 remove-data 、 scan-index 、 sync-index 、 update-endpoint 、 upsert-data

ベクトル検索エンドポイント

AI Searchインデックスをホストするコンピュートリソースを表すAI Searchエンドポイントを管理するコマンド:

create-endpoint、delete-endpoint、get-endpoint、list-endpoints、patch-endpoint、retrieve-user-visible-metrics、 update-endpoint-budget-policy

get-permission-levels、get-permissions、set-permissions、 update-permissions

ベクトル検索インデックス

AI Search インデックスを管理するコマンドは、リアルタイムかつ効率的な近似最近傍 (ANN) 検索クエリをサポートする、埋め込みベクトルの効率的な表現です。

create-index、delete-data-vector-index、delete-index、get-index、list-indexes、query-index、sync-index、 upsert-data-vector-index

グループ

説明とコマンド

ai-search

AI Search Endpointおよびインデックスを管理するためのコマンド。AI Search Endpointは、AI Searchインデックスをホストするためのコンピュートリソースを表します:

create-endpoint、 create-index 、 delete-endpoint 、 delete-index 、 get-endpoint 、 get-index 、 list-endpoints 、 list-indexes 、 query-index 、 remove-data 、 scan-index 、 sync-index 、 update-endpoint 、 upsert-data

ベクトル検索エンドポイント

AI Searchインデックスをホストするコンピュートリソースを表すAI Searchエンドポイントを管理するコマンド:

create-endpoint、delete-endpoint、get-endpoint、list-endpoints、patch-endpoint、retrieve-user-visible-metrics、 update-endpoint-budget-policy

get-permission-levels、get-permissions、set-permissions、 update-permissions

ベクトル検索インデックス

AI Search インデックスを管理するコマンドは、リアルタイムかつ効率的な近似最近傍 (ANN) 検索クエリをサポートする、埋め込みベクトルの効率的な表現です。

create-index、delete-data-vector-index、delete-index、get-index、list-indexes、query-index、sync-index、 upsert-data-vector-index

ダッシュボードのコマンド​

グループ

説明とコマンド

Lakeview

AI/BI ダッシュボードの特定の管理操作を提供するコマンド:

create、create-schedule、create-subscription、delete-schedule、delete-subscription、get、get-published、get-schedule、get-subscription、list、list-schedules、list-subscriptions、migrate、publish、revert、trash、unpublish、update、 update-schedule

Lakeview -埋め込み

外部アプリケーションにAI/BIダッシュボードを埋め込むための、トークンベースのLakeview APIsコマンド:

get-published-dashboard-token-info

グループ

説明とコマンド

Lakeview

AI/BI ダッシュボードの特定の管理操作を提供するコマンド:

create、create-schedule、create-subscription、delete-schedule、delete-subscription、get、get-published、get-schedule、get-subscription、list、list-schedules、list-subscriptions、migrate、publish、revert、trash、unpublish、update、 update-schedule

Lakeview -埋め込み

外部アプリケーションにAI/BIダッシュボードを埋め込むための、トークンベースのLakeview APIsコマンド:

get-published-dashboard-token-info

AIコマンド​

グループ

説明とコマンド

genie

AI/BIを搭載した、ビジネスユーザーにノーコード体験を提供するGenieを変更するためのコマンド:

ask、create-message、create-message-comment、create-space、delete-conversation、delete-conversation-message、download-message-attachment-visualization、execute-message-attachment-query、generate-download-full-query-result、genie-create-eval-run、genie-get-eval-result-details、genie-get-eval-run、genie-list-eval-results、genie-list-eval-runs、get-download-full-query-result、get-message、get-message-attachment-query-result、get-space、list-conversation-comments、list-conversation-messages、list-conversations、list-message-comments、list-spaces、send-message-feedback、start-conversation、trash-space、 update-space

知識アシスタント

ナレッジアシスタントおよび関連リソースを管理するためのコマンド:

create-knowledge-assistant、create-knowledge-source、delete-knowledge-assistant、delete-knowledge-source、get-knowledge-assistant、get-knowledge-source、list-knowledge-assistants、list-knowledge-sources、sync-knowledge-sources、update-knowledge-assistant、 update-knowledge-source

スーパーバイザーエージェント

スーパーバイザーエージェントおよび関連リソースを管理するためのコマンド:

create-example、 create-supervisor-agent 、 create-tool 、 delete-example 、 delete-supervisor-agent 、 delete-tool 、 get-example 、 get-supervisor-agent 、 get-tool 、 list-examples 、 list-supervisor-agents 、 list-tools 、 update-example 、 update-supervisor-agent 、 update-tool

get-permission-levels、get-permissions、set-permissions、 update-permissions

グループ

説明とコマンド

genie

AI/BIを搭載した、ビジネスユーザーにノーコード体験を提供するGenieを変更するためのコマンド:

ask、create-message、create-message-comment、create-space、delete-conversation、delete-conversation-message、download-message-attachment-visualization、execute-message-attachment-query、generate-download-full-query-result、genie-create-eval-run、genie-get-eval-result-details、genie-get-eval-run、genie-list-eval-results、genie-list-eval-runs、get-download-full-query-result、get-message、get-message-attachment-query-result、get-space、list-conversation-comments、list-conversation-messages、list-conversations、list-message-comments、list-spaces、send-message-feedback、start-conversation、trash-space、 update-space

知識アシスタント

ナレッジアシスタントおよび関連リソースを管理するためのコマンド:

create-knowledge-assistant、create-knowledge-source、delete-knowledge-assistant、delete-knowledge-source、get-knowledge-assistant、get-knowledge-source、list-knowledge-assistants、list-knowledge-sources、sync-knowledge-sources、update-knowledge-assistant、 update-knowledge-source

スーパーバイザーエージェント

スーパーバイザーエージェントおよび関連リソースを管理するためのコマンド:

create-example、 create-supervisor-agent 、 create-tool 、 delete-example 、 delete-supervisor-agent 、 delete-tool 、 get-example 、 get-supervisor-agent 、 get-tool 、 list-examples 、 list-supervisor-agents 、 list-tools 、 update-example 、 update-supervisor-agent 、 update-tool

get-permission-levels、get-permissions、set-permissions、 update-permissions

Marketplace コマンド​

グループ

説明とコマンド

コンシューマーフルフィルメント

フルフィルメントを管理するためのコマンド (コンシューマーがインストールをプレビューできるようにするエンティティ)。

get, list

コンシューマ・インストール

インストールを管理するためのコマンド (コンシューマーが Databricks Marketplace リストと対話できるようにするエンティティ)。

create、delete、list、list-listing-installations、 update

コンシューマーリスト

Databricks Marketplace コンシューマー リストを管理するためのコマンド:

batch-get、get、list、 search

コンシューマーパーソナライゼーションリクエスト

パーソナライゼーション要求を管理するためのコマンドで、顧客は個別の Marketplace リスト フローと対話できます。

create、get、 list

コンシューマープロバイダー

プロバイダー (Marketplace にリストを発行するエンティティ) を管理するためのコマンド。

batch-get、get、 list

プロバイダー交換フィルター

Marketplace exchanges フィルターを管理するためのコマンドで、Exchange にアクセスできるグループをキュレーションします。

create、delete、list、 update

プロバイダー交換

Marketplace エクスチェンジを管理するためのコマンドで、プロバイダーはキュレーションされた一連の顧客とリストを共有できます。

add-listing-to-exchange, create, delete, delete-listing-from-exchange, get, list, list-exchanges-for-listing, list-listings-for-exchange, update

プロバイダファイル

Marketplace ファイルを管理するためのコマンド (プレビュー ノートブックやプロバイダー アイコンなど)。

create、delete、get、 list

プロバイダーリスト

プロバイダーのリストを管理するためのコマンド:

create、delete、get、list、 update

プロバイダーのパーソナライゼーション要求

パーソナライゼーション要求を管理するためのコマンドで、すぐに利用できるリストの代替です。

list, update

provider-provider-アナリティクス-dashboards

プロバイダーのテンプレート化されたアナリティクスを管理するためのコマンド:

create、get、get-latest-version、 update

プロバイダープロバイダー

Marketplace で資産を管理するプロバイダーを管理するためのコマンド。

create、delete、get、list、 update

グループ

説明とコマンド

コンシューマーフルフィルメント

フルフィルメントを管理するためのコマンド (コンシューマーがインストールをプレビューできるようにするエンティティ)。

get, list

コンシューマ・インストール

インストールを管理するためのコマンド (コンシューマーが Databricks Marketplace リストと対話できるようにするエンティティ)。

create、delete、list、list-listing-installations、 update

コンシューマーリスト

Databricks Marketplace コンシューマー リストを管理するためのコマンド:

batch-get、get、list、 search

コンシューマーパーソナライゼーションリクエスト

パーソナライゼーション要求を管理するためのコマンドで、顧客は個別の Marketplace リスト フローと対話できます。

create、get、 list

コンシューマープロバイダー

プロバイダー (Marketplace にリストを発行するエンティティ) を管理するためのコマンド。

batch-get、get、 list

プロバイダー交換フィルター

Marketplace exchanges フィルターを管理するためのコマンドで、Exchange にアクセスできるグループをキュレーションします。

create、delete、list、 update

プロバイダー交換

Marketplace エクスチェンジを管理するためのコマンドで、プロバイダーはキュレーションされた一連の顧客とリストを共有できます。

add-listing-to-exchange, create, delete, delete-listing-from-exchange, get, list, list-exchanges-for-listing, list-listings-for-exchange, update

プロバイダファイル

Marketplace ファイルを管理するためのコマンド (プレビュー ノートブックやプロバイダー アイコンなど)。

create、delete、get、 list

プロバイダーリスト

プロバイダーのリストを管理するためのコマンド:

create、delete、get、list、 update

プロバイダーのパーソナライゼーション要求

パーソナライゼーション要求を管理するためのコマンドで、すぐに利用できるリストの代替です。

list, update

provider-provider-アナリティクス-dashboards

プロバイダーのテンプレート化されたアナリティクスを管理するためのコマンド:

create、get、get-latest-version、 update

プロバイダープロバイダー

Marketplace で資産を管理するプロバイダーを管理するためのコマンド。

create、delete、get、list、 update

アプリのコマンド​

グループ

説明とコマンド

apps

Databricks インスタンス上で直接実行される Databricks アプリを管理するコマンド、データとの統合、Databricks サービスの使用と拡張、ユーザーがシングルサインオンによる対話を可能にするコマンド。

create、create-update、delete、delete-app-thumbnail、deploy、dev-remote、get、get-deployment、get-update、import、init、list、list-deployments、logs、manifest、run-local、start、stop、update、update-app-thumbnail、 validate

get-permission-levels、get-permissions、set-permissions、 update-permissions

グループ

説明とコマンド

apps

Databricks インスタンス上で直接実行される Databricks アプリを管理するコマンド、データとの統合、Databricks サービスの使用と拡張、ユーザーがシングルサインオンによる対話を可能にするコマンド。

create、create-update、delete、delete-app-thumbnail、deploy、dev-remote、get、get-deployment、get-update、import、init、list、list-deployments、logs、manifest、run-local、start、stop、update、update-app-thumbnail、 validate

get-permission-levels、get-permissions、set-permissions、 update-permissions

クリーンルームコマンド​

グループ

説明とコマンド

クリーンルーム資産の改訂

アップロードされたクリーンルーム アセットの新しいバージョンを表示するコマンド。

get, list

クリーンルーム資産

クリーンルーム資産 (クリーンルームと共有されるテーブル、ボリューム、ノートブックなどのデータおよびコードオブジェクト) を管理するためのコマンド。

create、create-clean-room-asset-review、delete、get、list、 update

クリーンルーム自動承認ルール

クリーンルームの自動承認ルールを管理するコマンド。

create、delete、get、list、 update

クリーンルームタスク実行

クリーンルーム内のノートブックの実行である、クリーンルームタスク実行を管理するためのコマンド。

list, list-clean-room-task-runs-handler

クリーンルーム

クリーンルームを管理するコマンド。クリーンルームは、OpenSharingとサーバレスコンピュートを使用して、複数の関係者が互いのデータに直接アクセスすることなく、機密性の高い企業データを共同で処理できる、安全でプライバシー保護された環境を提供します。

create、create-output-catalog、delete、get、list、 update

グループ

説明とコマンド

クリーンルーム資産の改訂

アップロードされたクリーンルーム アセットの新しいバージョンを表示するコマンド。

get, list

クリーンルーム資産

クリーンルーム資産 (クリーンルームと共有されるテーブル、ボリューム、ノートブックなどのデータおよびコードオブジェクト) を管理するためのコマンド。

create、create-clean-room-asset-review、delete、get、list、 update

クリーンルーム自動承認ルール

クリーンルームの自動承認ルールを管理するコマンド。

create、delete、get、list、 update

クリーンルームタスク実行

クリーンルーム内のノートブックの実行である、クリーンルームタスク実行を管理するためのコマンド。

list, list-clean-room-task-runs-handler

クリーンルーム

クリーンルームを管理するコマンド。クリーンルームは、OpenSharingとサーバレスコンピュートを使用して、複数の関係者が互いのデータに直接アクセスすることなく、機密性の高い企業データを共同で処理できる、安全でプライバシー保護された環境を提供します。

create、create-output-catalog、delete、get、list、 update

データベース・コマンド​

グループ

説明とコマンド

database

Lakebase データベース インスタンスを管理するコマンド。

create-database-catalog, create-database-instance, create-database-table, create-synced-database-table, delete-database-catalog, delete-database-instance, delete-database-table, delete-synced-database-table, find-database-instance-by-uid, generate-database-credential, get-database-catalog, get-database-instance, get-database-table, get-synced-database-table, list-database-instances, update-database-instance

Postgres

Lakebase Autoscaling Postgres インフラストラクチャ (プロジェクト、ブランチ、コンピュート エンドポイント、ロールなど) を作成および管理するコマンド:

create-branch、create-catalog、create-endpoint、create-project、create-role、create-synced-table、delete-branch、delete-catalog、delete-endpoint、delete-project、delete-role、delete-synced-table、generate-database-credential、get-branch、get-catalog、get-endpoint、get-operation、get-project、get-role、get-synced-table、list-branches、list-cdf-configs、list-cdf-statuses、list-databases、list-endpoints、list-projects、list-roles、undelete-project、update-branch、update-endpoint、update-project、 update-role

psql

指定されたデータベース インスタンスに接続するコマンド。

グループ

説明とコマンド

database

Lakebase データベース インスタンスを管理するコマンド。

create-database-catalog, create-database-instance, create-database-table, create-synced-database-table, delete-database-catalog, delete-database-instance, delete-database-table, delete-synced-database-table, find-database-instance-by-uid, generate-database-credential, get-database-catalog, get-database-instance, get-database-table, get-synced-database-table, list-database-instances, update-database-instance

Postgres

Lakebase Autoscaling Postgres インフラストラクチャ (プロジェクト、ブランチ、コンピュート エンドポイント、ロールなど) を作成および管理するコマンド:

create-branch、create-catalog、create-endpoint、create-project、create-role、create-synced-table、delete-branch、delete-catalog、delete-endpoint、delete-project、delete-role、delete-synced-table、generate-database-credential、get-branch、get-catalog、get-endpoint、get-operation、get-project、get-role、get-synced-table、list-branches、list-cdf-configs、list-cdf-statuses、list-databases、list-endpoints、list-projects、list-roles、undelete-project、update-branch、update-endpoint、update-project、 update-role

psql

指定されたデータベース インスタンスに接続するコマンド。

追加のコマンド​

グループ

説明とコマンド

api

Databricks REST API に要求を行うコマンド:

delete、get、head、patch、post、 put

キャッシュ

パフォーマンス向上のためにDatabricks CLIが使用するローカルキャッシュを管理するコマンド:

clear

completion

指定したシェルのオートコンプリートスクリプトを生成するコマンド:

bash、fish、powershell、 zsh

configure

Databricks CLI を構成します。

help

すべての Databricks CLI コマンドの概要情報を出力します。

labs

Databricks Labs のインストールを管理するためのコマンド:

clear-cache、install、installed、list、show、uninstall、 upgrade

クイックスタート

認証、プロファイル、Declarative Automation Bundles を使用した構築、および次のステップなど、Databricks CLI の概要を表示します。

version

現在使用されているCLIのバージョンを取得します。

グループ

説明とコマンド

api

Databricks REST API に要求を行うコマンド:

delete、get、head、patch、post、 put

キャッシュ

パフォーマンス向上のためにDatabricks CLIが使用するローカルキャッシュを管理するコマンド:

clear

completion

指定したシェルのオートコンプリートスクリプトを生成するコマンド:

bash、fish、powershell、 zsh

configure

Databricks CLI を構成します。

help

すべての Databricks CLI コマンドの概要情報を出力します。

labs

Databricks Labs のインストールを管理するためのコマンド:

clear-cache、install、installed、list、show、uninstall、 upgrade

クイックスタート

認証、プロファイル、Declarative Automation Bundles を使用した構築、および次のステップなど、Databricks CLI の概要を表示します。

version

現在使用されているCLIのバージョンを取得します。

グローバルフラグ​

次のフラグは、すべての Databricks CLI コマンドで使用できます。 一部のフラグは、一部のコマンドには適用されないことに注意してください。 特定のコマンドとそのフラグの詳細については、コマンド ラインのヘルプを参照してください。

--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

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