az databricks workspace

  • リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.57.0 以降) の databricks 拡張機能の一部です。 az databricks workspace コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細をご覧ください。

databricks ワークスペースを管理するコマンド。

コマンド

名前 説明 型 状態
az databricks workspace create

新しいワークスペースを作成します。

 拡張子 GA
az databricks workspace delete

ワークスペースを削除します。

 拡張子 GA
az databricks workspace list

すべてのワークスペースを取得します。

 拡張子 GA
az databricks workspace outbound-endpoint

指定したワークスペース内のエンドポイントを管理するコマンド。

 拡張子 GA
az databricks workspace outbound-endpoint list

VNET 挿入ワークスペースが Azure Databricks コントロール プレーンを呼び出すエンドポイントの一覧を表示します。 これらのエンドポイントを使用して送信アクセスを構成する必要があります。 詳細については、https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udrを参照してください。

 拡張子 GA
az databricks workspace private-endpoint-connection

databricks ワークスペースのプライベート エンドポイント接続を管理するコマンド。

 拡張子 GA
az databricks workspace private-endpoint-connection create

指定した名前でプライベート エンドポイント接続の状態を作成します。

 拡張子 GA
az databricks workspace private-endpoint-connection delete

指定した名前のプライベート エンドポイント接続を削除します。

 拡張子 GA
az databricks workspace private-endpoint-connection list

ワークスペースのプライベート エンドポイント接続を一覧表示します。

 拡張子 GA
az databricks workspace private-endpoint-connection show

ワークスペースのプライベート エンドポイント接続プロパティを取得します。

 拡張子 GA
az databricks workspace private-endpoint-connection update

プライベート エンドポイント接続の状態を、指定した名前で更新します。

 拡張子 GA
az databricks workspace private-endpoint-connection wait

条件が満たされるまで CLI を待機状態にします。

 拡張子 GA
az databricks workspace private-link-resource

databricks ワークスペースのプライベート リンク リソースを管理するコマンド。

 拡張子 GA
az databricks workspace private-link-resource list

特定のワークスペースのプライベート リンク リソースを一覧表示します。

 拡張子 GA
az databricks workspace private-link-resource show

指定されたグループ ID (サブリソース) の指定されたプライベート リンク リソースを取得します。

 拡張子 GA
az databricks workspace show

ワークスペースを表示します。

 拡張子 GA
az databricks workspace update

ワークスペースを更新します。

 拡張子 GA
az databricks workspace vnet-peering

databricks ワークスペースの vnet ピアリングを管理するコマンド。

 拡張子 GA
az databricks workspace vnet-peering create

ワークスペースの vnet ピアリングを作成します。

 拡張子 GA
az databricks workspace vnet-peering delete

vnet ピアリングを削除します。

 拡張子 GA
az databricks workspace vnet-peering list

ワークスペースの下に vnet ピアリングを一覧表示します。

 拡張子 GA
az databricks workspace vnet-peering show

vnet ピアリングを表示します。

 拡張子 GA
az databricks workspace vnet-peering update

vnet ピアリングを更新します。

 拡張子 GA
az databricks workspace vnet-peering wait

条件が満たされるまで CLI を待機状態にします。

 拡張子 GA
az databricks workspace wait

条件が満たされるまで CLI を待機状態にします。

 拡張子 GA

az databricks workspace create

新しいワークスペースを作成します。

az databricks workspace create --name
                               --resource-group
                               [--access-connector]
                               [--default-catalog]
                               [--default-storage-firewall {Disabled, Enabled}]
                               [--disk-key-auto-rotation {0, 1, f, false, n, no, t, true, y, yes}]
                               [--disk-key-name]
                               [--disk-key-vault]
                               [--disk-key-version]
                               [--enable-no-public-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enhanced-security-compliance]
                               [--location]
                               [--managed-resource-group]
                               [--managed-services-key-name]
                               [--managed-services-key-vault]
                               [--managed-services-key-version]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--prepare-encryption {0, 1, f, false, n, no, t, true, y, yes}]
                               [--private-subnet]
                               [--public-network-access {Disabled, Enabled}]
                               [--public-subnet]
                               [--require-infrastructure-encryption {0, 1, f, false, n, no, t, true, y, yes}]
                               [--required-nsg-rules {AllRules, NoAzureDatabricksRules, NoAzureServiceRules}]
                               [--sku]
                               [--tags]
                               [--vnet]

例

ワークスペースの作成

az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location westus --sku standard

ストレージ アカウントのマネージド ID を使用してワークスペースを作成する

az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location eastus2euap --sku premium --prepare-encryption

必須のパラメーター

--name -n

ワークスペースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--access-connector

Databricks ワークスペースに関連付けられる Access Connector リソースでは、短縮構文、json ファイル、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

--default-catalog

ワークスペースの作成時の既定のカタログ構成のプロパティ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--default-storage-firewall

既定のストレージ ファイアウォール構成情報を取得または設定します。

指定可能な値: Disabled, Enabled
--disk-key-auto-rotation

マネージド ディスク暗号化に最新のキー バージョンを自動的に使用するかどうかを指定します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--disk-key-name

KeyVault キーの名前。

--disk-key-vault

KeyVault の URI。

--disk-key-version

KeyVault キーのバージョン。

--enable-no-public-ip

パブリック IP なしの機能を有効にするフラグ。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--enhanced-security-compliance

セキュリティ強化およびコンプライアンス アドオンに関連する設定が含まれています。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--location -l

Location。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。 指定しない場合は、リソース グループの場所が使用されます。

--managed-resource-group

作成するマネージド リソース グループ。 名前またはリソース ID を指定できます。

--managed-services-key-name --ms-key-name

KeyVault キーの名前。

--managed-services-key-vault --ms-key-vault

KeyVault の URI。

--managed-services-key-version --ms-key-version

KeyVault キーのバージョン。

--no-wait

実行時間の長い操作の終了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--prepare-encryption

マネージド ストレージ アカウントのマネージド ID が CMK 暗号化の準備を有効にするフラグ。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--private-subnet

仮想ネットワーク内のプライベート サブネットの名前。

--public-network-access

パブリック インターネットからエンドポイントへのネットワーク アクセスを許可するかどうかを設定する構成。 使用できる値: 無効、有効。

指定可能な値: Disabled, Enabled
--public-subnet

仮想ネットワーク内のパブリック サブネットの名前。

--require-infrastructure-encryption

保存データのプラットフォーム マネージド キーを使用した暗号化のセカンダリ レイヤーを使用して DBFS ルート ファイル システムを有効にするフラグ。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--required-nsg-rules

内部使用専用の Nsg ルールの種類。 使用できる値: AllRules、NoAzureDatabricksRules、NoAzureServiceRules。

指定可能な値: AllRules, NoAzureDatabricksRules, NoAzureServiceRules
--sku

SKU レベル名。 使用できる値: Premium、Standard、試用版。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--vnet

仮想ネットワーク名またはリソース ID。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az databricks workspace delete

ワークスペースを削除します。

az databricks workspace delete [--force-deletion {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--resource-group]
                               [--subscription]
                               [--yes]

例

ワークスペースを削除する

az databricks workspace delete --resource-group MyResourceGroup --name MyWorkspace -y

省略可能のパラメーター

--force-deletion

既定の Unity カタログ データを保持する省略可能なパラメーター。 既定では、Uc がワークスペースで有効になっている場合、データは保持されます。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
規定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

ワークスペースの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

規定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az databricks workspace list

すべてのワークスペースを取得します。

az databricks workspace list [--max-items]
                             [--next-token]
                             [--resource-group]

例

リソース グループ内のワークスペースを一覧表示する

az databricks workspace list --resource-group MyResourceGroup

既定のサブスクリプション内のワークスペースを一覧表示する

az databricks workspace list

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az databricks workspace show

ワークスペースを表示します。

az databricks workspace show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

例

ワークスペースを表示する

az databricks workspace show --resource-group MyResourceGroup --name MyWorkspace

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

ワークスペースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az databricks workspace update

ワークスペースを更新します。

az databricks workspace update [--access-connector]
                               [--add]
                               [--default-catalog]
                               [--default-storage-firewall {Disabled, Enabled}]
                               [--disk-key-auto-rotation {0, 1, f, false, n, no, t, true, y, yes}]
                               [--disk-key-name]
                               [--disk-key-vault]
                               [--disk-key-version]
                               [--enable-no-public-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enhanced-security-compliance]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--key-name]
                               [--key-source {Default, Microsoft.Keyvault}]
                               [--key-vault]
                               [--key-version]
                               [--managed-services-key-name]
                               [--managed-services-key-vault]
                               [--managed-services-key-version]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--prepare-encryption {0, 1, f, false, n, no, t, true, y, yes}]
                               [--public-network-access {Disabled, Enabled}]
                               [--remove]
                               [--required-nsg-rules {AllRules, NoAzureDatabricksRules, NoAzureServiceRules}]
                               [--resource-group]
                               [--sa-sku-name]
                               [--set]
                               [--sku]
                               [--subscription]
                               [--tags]

例

ワークスペースのタグを更新します。

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags key1=value1 key2=value2

ワークスペースのタグを消去します。

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags ""

ストレージ アカウントの ID を割り当てることで、CMK 暗号化を準備します。

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --prepare-encryption

CMK 暗号化の構成

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --key-source Microsoft.KeyVault --key-name MyKey --key-vault https://myKeyVault.vault.azure.net/ --key-version 00000000000000000000000000000000

暗号化を Microsoft マネージド キーに戻す

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --key-source Default

省略可能のパラメーター

--access-connector

Databricks ワークスペースに関連付けられる Access Connector リソースでは、短縮構文、json ファイル、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>.

--default-catalog

ワークスペースの作成時の既定のカタログ構成のプロパティ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--default-storage-firewall

既定のストレージ ファイアウォール構成情報を取得または設定します。

指定可能な値: Disabled, Enabled
--disk-key-auto-rotation

マネージド ディスク暗号化に最新のキー バージョンを自動的に使用するかどうかを指定します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--disk-key-name

KeyVault キーの名前。

--disk-key-vault

KeyVault の URI。

--disk-key-version

KeyVault キーのバージョン。

--enable-no-public-ip

パブリック IP なしの機能を有効にするフラグ。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--enhanced-security-compliance

セキュリティ強化およびコンプライアンス アドオンに関連する設定が含まれています。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--key-name

KeyVault キーの名前。

--key-source

暗号化キー ソース (プロバイダー)。 使用できる値: 既定値、Microsoft.Keyvault。

指定可能な値: Default, Microsoft.Keyvault
--key-vault

KeyVault の URI。

--key-version

KeyVault キーのバージョン。 CMK を更新する場合は省略可能です。

--managed-services-key-name --ms-key-name

KeyVault キーの名前。

--managed-services-key-vault --ms-key-vault

KeyVault の URI。

--managed-services-key-version --ms-key-version

KeyVault キーのバージョン。

--name -n

ワークスペースの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--prepare-encryption

マネージド ストレージ アカウントのマネージド ID が CMK 暗号化の準備を有効にするフラグ。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を無効に設定します。

指定可能な値: Disabled, Enabled
--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--required-nsg-rules

内部使用専用の Nsg ルールの種類。 使用できる値: AllRules、NoAzureDatabricksRules、NoAzureServiceRules。

指定可能な値: AllRules, NoAzureDatabricksRules, NoAzureServiceRules
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--sa-sku-name --storage-account-sku-name

ストレージ アカウント SKU 名 (例: Standard_GRS、Standard_LRS)。 有効な入力については、 https://aka.ms/storageskus を参照してください。

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--sku

SKU レベル名。 使用できる値: Premium、Standard、試用版。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az databricks workspace wait

条件が満たされるまで CLI を待機状態にします。

az databricks workspace wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

規定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

規定値: False
--exists

リソースが存在するまで待ちます。

規定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

規定値: 30
--name -n

ワークスペースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

規定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
規定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。