次の方法で共有

Workspaces - Create Or Update

サービス:
Databricks
API バージョン:
2026-01-01

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

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}?api-version=2026-01-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

リソース グループの名前。 名前は大文字と小文字が区別されます。
subscriptionId
 path True

string (uuid)

ターゲット サブスクリプションの ID。 値は UUID である必要があります。
workspaceName
 path True

string

minLength: 3
maxLength: 64

ワークスペースの名前。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。

要求本文

名前 必須 型 説明
location True

string

リソースが存在する地理的な場所
properties.computeMode True

ComputeMode

ワークスペースのコンピューティング モード。 作成時に必須で、変更できません。 指定できる値には、'Serverless'、'Hybrid' が含まれます。
properties.accessConnector

AccessConnector

Databricks ワークスペースに関連付けられるコネクタ リソースにアクセスします。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.authorizations

WorkspaceProviderAuthorization[]

ワークスペース プロバイダーの承認。
properties.createdBy

CreatedBy

ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。
properties.defaultCatalog

DefaultCatalogProperties

ワークスペースの作成時の既定のカタログ構成のプロパティ。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.defaultStorageFirewall

defaultStorageFirewall

デフォルトのストレージファイアウォール構成情報を取得または設定します。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.encryption

WorkspaceProperties.Encryption

databricks ワークスペースの暗号化プロパティ。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。
properties.enhancedSecurityCompliance

EnhancedSecurityComplianceDefinition

セキュリティ強化およびコンプライアンス アドオンに関連する設定が含まれています。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。
properties.managedDiskIdentity

ManagedIdentityConfiguration

Managed Disk Encryption に使用されるディスク暗号化セットのマネージド ID の詳細。 ハイブリッド ComputeMode ワークスペースでのみ返されます。
properties.managedResourceGroupId

string

マネージド リソース グループ ID。ハイブリッド ComputeMode ワークスペースで必要です。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.parameters

WorkspaceCustomParameters

ワークスペースのカスタム パラメーター。
properties.publicNetworkAccess

PublicNetworkAccess

ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を無効に設定します。 Serverless ComputeModeワークスペースのフロントエンド専用プライベートリンクの設定に使用されました。
properties.requiredNsgRules

RequiredNsgRules

コントロール プレーン通信を制御するデータ プレーン (クラスター) がプライベート エンドポイント経由で行われるかどうかを示す値を取得または設定します。 サポートされている値は 、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部でのみ使用されます。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.storageAccountIdentity

ManagedIdentityConfiguration

ストレージ アカウントのマネージド ID の詳細。 ハイブリッド ComputeMode ワークスペースでのみ返されます。
properties.uiDefinitionUri

string

UI 定義ファイルが配置されている BLOB URI。
properties.updatedBy

CreatedBy

ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。
sku

Sku

リソースの SKU。
tags

object

リソース タグ。

応答

名前 型 説明
200 OK

Workspace

作成済み - プロビジョニングの状態など、ワークスペースに関する情報を返します。
201 Created

Workspace

作成済み - プロビジョニングの状態など、ワークスペースに関する情報を返します。
Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

Create a workspace which is ready for Customer-Managed Key (CMK) encryption
Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks
Create or update a workspace with Enhanced Security & Compliance Add-On
Create or update serverless workspace
Create or update workspace
Create or update workspace with custom parameters
Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption
Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace
Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

Create a workspace which is ready for Customer-Managed Key (CMK) encryption

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "prepareEncryption": {
        "value": true
      }
    }
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "sku": {
    "name": "premium"
  },
  "location": "East US 2",
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z"
  }
}

Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    }
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true
  }
}

Create or update a workspace with Enhanced Security & Compliance Add-On

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "Enabled"
      },
      "complianceSecurityProfile": {
        "value": "Enabled",
        "complianceStandards": [
          "PCI_DSS",
          "HIPAA"
        ]
      },
      "enhancedSecurityMonitoring": {
        "value": "Enabled"
      }
    }
  },
  "location": "eastus2",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "Enabled"
      },
      "complianceSecurityProfile": {
        "value": "Enabled",
        "complianceStandards": [
          "PCI_DSS",
          "HIPAA"
        ]
      },
      "enhancedSecurityMonitoring": {
        "value": "Enabled"
      }
    },
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2023-08-24T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "Enabled"
      },
      "complianceSecurityProfile": {
        "value": "Enabled",
        "complianceStandards": [
          "PCI_DSS",
          "HIPAA"
        ]
      },
      "enhancedSecurityMonitoring": {
        "value": "Enabled"
      }
    },
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2023-08-24T00:10:29.2858439Z",
    "isUcEnabled": true
  }
}

Create or update serverless workspace

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Serverless"
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Serverless",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "defaultCatalog": {
      "initialType": "UnityCatalog",
      "initialName": ""
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Serverless",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true
  }
}

Create or update workspace

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "defaultCatalog": {
      "initialType": "UnityCatalog",
      "initialName": ""
    },
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "SystemAssigned"
    },
    "defaultStorageFirewall": "Enabled"
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "SystemAssigned"
    },
    "defaultStorageFirewall": "Enabled",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "defaultCatalog": {
      "initialType": "UnityCatalog",
      "initialName": ""
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "SystemAssigned"
    },
    "defaultStorageFirewall": "Enabled",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true
  }
}

Create or update workspace with custom parameters

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "defaultCatalog": {
      "initialType": "HiveMetastore",
      "initialName": ""
    },
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "UserAssigned",
      "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
    },
    "defaultStorageFirewall": "Enabled",
    "parameters": {
      "customVirtualNetworkId": {
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "customPublicSubnetName": {
        "value": "myPublicSubnet"
      },
      "customPrivateSubnetName": {
        "value": "myPrivateSubnet"
      }
    }
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": null,
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "myPrivateSubnet"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "myPublicSubnet"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      }
    },
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "UserAssigned",
      "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
    },
    "defaultStorageFirewall": "Enabled",
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "defaultCatalog": {
      "initialType": "HiveMetastore",
      "initialName": ""
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true,
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "UserAssigned",
      "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
    },
    "defaultStorageFirewall": "Enabled",
    "defaultCatalog": {
      "initialType": "HiveMetastore",
      "initialName": ""
    }
  }
}

Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "prepareEncryption": {
        "value": true
      },
      "encryption": {
        "value": {
          "keySource": "Microsoft.Keyvault",
          "keyvaulturi": "https://myKeyVault.vault.azure.net/",
          "KeyName": "myKeyName",
          "keyversion": "00000000000000000000000000000000"
        }
      }
    }
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "sku": {
    "name": "premium"
  },
  "location": "East US 2",
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "PrivateBob"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "PublicSarah"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "prepareEncryption": {
        "type": "Bool",
        "value": true
      },
      "encryption": {
        "type": "Object",
        "value": {
          "keySource": "Microsoft.Keyvault",
          "keyvaulturi": "https://myKeyVault.vault.azure.net/",
          "KeyName": "myKeyName",
          "keyversion": "00000000000000000000000000000000"
        }
      }
    },
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "isUcEnabled": true
  }
}

Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "encryption": {
        "value": {
          "keySource": "Default"
        }
      }
    }
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  }
}

応答のサンプル

状態コード:
200 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "sku": {
    "name": "premium"
  },
  "location": "East US 2",
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "PrivateBob"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "PublicSarah"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "prepareEncryption": {
        "type": "Bool",
        "value": true
      },
      "encryption": {
        "type": "Object",
        "value": {
          "keySource": "Default"
        }
      }
    },
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "environment": "dev"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "storageAccountIdentity": {
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666",
      "type": "SystemAssigned"
    },
    "isUcEnabled": true
  }
}

Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

要求のサンプル

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    }
  },
  "location": "westus",
  "sku": {
    "name": "premium"
  },
  "tags": {
    "mytag1": "myvalue1"
  }
}

応答のサンプル

状態コード:
200 
{
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "mytag1": "myvalue1"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "6666666666666666",
    "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}
状態コード:
201 
{
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "tags": {
    "mytag1": "myvalue1"
  },
  "sku": {
    "name": "premium"
  },
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyName": "test-cmk-key",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "createdBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "updatedBy": {
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333",
      "applicationId": "44444444-4444-4444-4444-444444444444"
    },
    "managedDiskIdentity": {
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444",
      "type": "SystemAssigned"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "6666666666666666",
    "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}

定義

名前 説明
AccessConnector

Databricks ワークスペースに関連付けられるコネクタ リソースにアクセスします。 サーバーレス ComputeMode ワークスペースでは許可されません。
AutomaticClusterUpdateDefinition

自動クラスター更新機能の状態。
AutomaticClusterUpdateValue
ComplianceSecurityProfileDefinition

コンプライアンス セキュリティ プロファイル機能の状態。
ComplianceSecurityProfileValue
ComputeMode

ワークスペースのコンピューティング モード。 作成時に必須で、変更できません。 指定できる値には、'Serverless'、'Hybrid' が含まれます。
CreatedBy

ワークスペースを作成/更新したエンティティの詳細を提供します。
createdByType

リソースを作成した ID の種類。
CustomParameterType

これが変数の型
DefaultCatalogProperties

これらのプロパティを使用すると、ワークスペースの作成時に既定のカタログ プロパティを指定できます。 サーバーレス ComputeMode ワークスペースでは許可されません。
defaultStorageFirewall

デフォルトのストレージファイアウォール構成情報を取得または設定します。 サーバーレス ComputeMode ワークスペースでは許可されません。
Encryption

ワークスペースで使用される暗号化の詳細を含むオブジェクト。
EncryptionEntitiesDefinition

databricks ワークスペース リソースの暗号化エンティティ。
EncryptionKeySource

暗号化 keySource (プロバイダー)。 使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault
EncryptionV2

ワークスペースで使用される暗号化の詳細を含むオブジェクト。
EnhancedSecurityComplianceDefinition

セキュリティとコンプライアンスの強化アドオンに関連する設定のステータス。
EnhancedSecurityMonitoringDefinition

セキュリティ強化監視機能の状態。
EnhancedSecurityMonitoringValue
ErrorDetail

エラーの詳細。
ErrorInfo

エラーのコードとメッセージ。
ErrorResponse

エラー応答。
IdentityType

Access Connector リソースの ID の種類。
initialType

既定のカタログの初期型を定義します。 使用可能な値 (大文字と小文字を区別しない): HiveMetastore、UnityCatalog
KeySource

暗号化 keySource (プロバイダー)。 使用可能な値 (大文字と小文字を区別): 既定値、Microsoft.Keyvault
KeyVaultProperties

暗号化用の Key Vault 入力プロパティ。
ManagedDiskEncryption

ワークスペースで使用される暗号化の詳細を含むオブジェクト。
ManagedIdentityConfiguration

ストレージ アカウントのマネージド ID の詳細。
PrivateEndpoint

プライベート エンドポイント接続のプライベート エンドポイント プロパティ。
PrivateEndpointConnection

ワークスペースのプライベート エンドポイント接続。
PrivateEndpointConnectionProperties

プライベート エンドポイント接続のプロパティ。
PrivateEndpointConnectionProvisioningState

現在のプロビジョニング状態。
PrivateLinkServiceConnectionState

プライベート エンドポイント接続の現在の状態。
PrivateLinkServiceConnectionStatus

プライベート エンドポイント接続の状態
ProvisioningState

ワークスペースのプロビジョニング状態。
PublicNetworkAccess

ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を無効に設定します。 Serverless ComputeModeワークスペースのフロントエンド専用プライベートリンクの設定に使用されました。
RequiredNsgRules

コントロール プレーン通信を制御するデータ プレーン (クラスター) がプライベート エンドポイント経由で行われるかどうかを示す値を取得または設定します。 サポートされている値は 、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部でのみ使用されます。 サーバーレス ComputeMode ワークスペースでは許可されません。
Sku

リソースの SKU。
systemData

リソースの作成と最後の変更に関連するメタデータ。
Workspace

ワークスペースに関する情報。
Workspace.WorkspaceProperties.Encryption

databricks ワークスペースの暗号化プロパティ。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。
WorkspaceCustomBooleanParameter

このフィールドに使用する値。
WorkspaceCustomObjectParameter

このフィールドに使用する値。
WorkspaceCustomParameters

ワークスペース作成に使われるカスタムパラメータ。 サーバーレス ComputeMode ワークスペースでは許可されません。
WorkspaceCustomStringParameter

値。
WorkspaceEncryptionParameter

ワークスペースで使用される暗号化の詳細を含むオブジェクト。
WorkspaceNoPublicIPBooleanParameter

このフィールドに使用する値。
WorkspaceProperties.Encryption

databricks ワークスペースの暗号化プロパティ。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。
WorkspaceProviderAuthorization

ワークスペース プロバイダーの承認。

AccessConnector

Object

Databricks ワークスペースに関連付けられるコネクタ リソースにアクセスします。 サーバーレス ComputeMode ワークスペースでは許可されません。

名前 型 説明
id

string (arm-id)

Azure Databricks Access Connector リソースのリソース ID。
identityType

IdentityType

Access Connector リソースの ID の種類。
userAssignedIdentityId

string (arm-id)

Access Connector リソースに関連付けられているユーザー割り当て ID のリソース ID。 これは型 'UserAssigned' に必要であり、型 'SystemAssigned' には無効です。

AutomaticClusterUpdateDefinition

Object

自動クラスター更新機能の状態。

名前 型 説明
value

AutomaticClusterUpdateValue

AutomaticClusterUpdateValue

列挙
値 説明
Enabled
Disabled

ComplianceSecurityProfileDefinition

Object

コンプライアンス セキュリティ プロファイル機能の状態。

名前 型 説明
complianceStandards

string[]

ワークスペースに関連付けられているコンプライアンス標準。
value

ComplianceSecurityProfileValue

ComplianceSecurityProfileValue

列挙
値 説明
Enabled
Disabled

ComputeMode

列挙

ワークスペースのコンピューティング モード。 作成時に必須で、変更できません。 指定できる値には、'Serverless'、'Hybrid' が含まれます。

値 説明
Serverless
Hybrid

CreatedBy

Object

ワークスペースを作成/更新したエンティティの詳細を提供します。

名前 型 説明
applicationId

string (uuid)

ワークスペースの作成を開始したアプリケーションのアプリケーション ID。 たとえば、Azure Portal などです。
oid

string (uuid)

ワークスペースを作成したオブジェクト ID。
puid

string

上記のオブジェクト ID に対応する個人オブジェクト ID

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

CustomParameterType

列挙

これが変数の型

値 説明
Bool
Object
String

DefaultCatalogProperties

Object

これらのプロパティを使用すると、ワークスペースの作成時に既定のカタログ プロパティを指定できます。 サーバーレス ComputeMode ワークスペースでは許可されません。

名前 型 規定値 説明
initialName

string

既定のカタログの初期名を指定します。 指定しない場合は、ワークスペースの名前が使用されます。
initialType

initialType

HiveMetastore

既定のカタログの初期型を定義します。 使用可能な値 (大文字と小文字を区別しない): HiveMetastore、UnityCatalog

defaultStorageFirewall

列挙

デフォルトのストレージファイアウォール構成情報を取得または設定します。 サーバーレス ComputeMode ワークスペースでは許可されません。

値 説明
Disabled
Enabled

Encryption

Object

ワークスペースで使用される暗号化の詳細を含むオブジェクト。

名前 型 規定値 説明
KeyName

string

KeyVault キーの名前。
keySource

KeySource

Default

暗号化 keySource (プロバイダー)。 使用可能な値 (大文字と小文字を区別): 既定値、Microsoft.Keyvault
keyvaulturi

string

KeyVault の URI。
keyversion

string

KeyVault キーのバージョン。

EncryptionEntitiesDefinition

Object

databricks ワークスペース リソースの暗号化エンティティ。

名前 型 説明
managedDisk

ManagedDiskEncryption

databricks マネージド ディスクの暗号化プロパティ。 サーバーレス ComputeMode ワークスペースでは許可されません。
managedServices

EncryptionV2

databricks マネージド サービスの暗号化プロパティ。 サーバーレスとハイブリッド コンピューティング モードの両方でサポートされています。

EncryptionKeySource

列挙

暗号化 keySource (プロバイダー)。 使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault

値 説明
Microsoft.Keyvault

EncryptionV2

Object

ワークスペースで使用される暗号化の詳細を含むオブジェクト。

名前 型 説明
keySource

EncryptionKeySource

暗号化 keySource (プロバイダー)。 使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault
keyVaultProperties

KeyVaultProperties

暗号化用の Key Vault 入力プロパティ。

EnhancedSecurityComplianceDefinition

Object

セキュリティとコンプライアンスの強化アドオンに関連する設定のステータス。

名前 型 説明
automaticClusterUpdate

AutomaticClusterUpdateDefinition

自動クラスター更新機能の状態。
complianceSecurityProfile

ComplianceSecurityProfileDefinition

コンプライアンス セキュリティ プロファイル機能の状態。
enhancedSecurityMonitoring

EnhancedSecurityMonitoringDefinition

セキュリティ強化監視機能の状態。

EnhancedSecurityMonitoringDefinition

Object

セキュリティ強化監視機能の状態。

名前 型 説明
value

EnhancedSecurityMonitoringValue

EnhancedSecurityMonitoringValue

列挙
値 説明
Enabled
Disabled

ErrorDetail

Object

エラーの詳細。

名前 型 説明
code

string

エラーのコード。
message

string

人間が判読できるエラー メッセージ。
target

string

要求内のどのプロパティがエラーの原因となっているかを示します。

ErrorInfo

Object

エラーのコードとメッセージ。

名前 型 説明
code

string

機械可読エラー コード。
details

ErrorDetail[]

エラーの詳細。
innererror

string

内部エラーの詳細が存在する場合。
message

string

人間が判読できるエラー メッセージ。

ErrorResponse

Object

エラー応答。

名前 型 説明
error

ErrorInfo

エラーのコードとメッセージ。
エラーの詳細。

IdentityType

列挙

Access Connector リソースの ID の種類。

値 説明
SystemAssigned
UserAssigned

initialType

列挙

既定のカタログの初期型を定義します。 使用可能な値 (大文字と小文字を区別しない): HiveMetastore、UnityCatalog

値 説明
HiveMetastore
UnityCatalog

KeySource

列挙

暗号化 keySource (プロバイダー)。 使用可能な値 (大文字と小文字を区別): 既定値、Microsoft.Keyvault

値 説明
Default
Microsoft.Keyvault

KeyVaultProperties

Object

暗号化用の Key Vault 入力プロパティ。

名前 型 説明
keyName

string

KeyVault キーの名前。
keyVaultUri

string

KeyVault の URI。
keyVersion

string

KeyVault キーのバージョン。

ManagedDiskEncryption

Object

ワークスペースで使用される暗号化の詳細を含むオブジェクト。

名前 型 説明
keySource

EncryptionKeySource

暗号化 keySource (プロバイダー)。 可能な値 (大文字と小文字を区別しない): Microsoft.Keyvault。 サーバーレス ComputeMode ワークスペースでは許可されません。
keyVaultProperties

KeyVaultProperties

暗号化用の Key Vault 入力プロパティ。
rotationToLatestKeyVersionEnabled

boolean

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

ManagedIdentityConfiguration

Object

ストレージ アカウントのマネージド ID の詳細。

名前 型 説明
principalId

string (uuid)

マネージド ストレージ アカウントにリンクされているマネージド ID の objectId。
tenantId

string (uuid)

マネージド ID が作成されるテナント ID。
type

string

作成された ID のタイプ。 SystemAssigned または UserAssigned のいずれかです。

PrivateEndpoint

Object

プライベート エンドポイント接続のプライベート エンドポイント プロパティ。

名前 型 説明
id

string

リソース識別子。

PrivateEndpointConnection

Object

ワークスペースのプライベート エンドポイント接続。

名前 型 説明
id

string

リソース識別子。
name

string

リソース名。
properties

PrivateEndpointConnectionProperties

プライベート エンドポイント接続プロパティ。
type

string

リソースの種類。

PrivateEndpointConnectionProperties

Object

プライベート エンドポイント接続のプロパティ。

名前 型 説明
groupIds

string[]

プライベート リンク サービス リソースの GroupId。
privateEndpoint

PrivateEndpoint

プライベート エンドポイント
プライベート エンドポイント
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

プライベート リンク サービス サービスの接続状態
プライベート エンドポイントの接続状態
provisioningState

PrivateEndpointConnectionProvisioningState

プライベート エンドポイント接続のプロビジョニング状態。

PrivateEndpointConnectionProvisioningState

列挙

現在のプロビジョニング状態。

値 説明
Succeeded
Creating
Updating
Deleting
Failed

PrivateLinkServiceConnectionState

Object

プライベート エンドポイント接続の現在の状態。

名前 型 説明
actionsRequired

string

プライベート エンドポイント接続に必要なアクション
description

string

プライベート エンドポイント接続の現在の状態の説明
status

PrivateLinkServiceConnectionStatus

プライベート エンドポイント接続の状態

PrivateLinkServiceConnectionStatus

列挙

プライベート エンドポイント接続の状態

値 説明
Pending
Approved
Rejected
Disconnected

ProvisioningState

列挙

ワークスペースのプロビジョニング状態。

値 説明
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

PublicNetworkAccess

列挙

ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を無効に設定します。 Serverless ComputeModeワークスペースのフロントエンド専用プライベートリンクの設定に使用されました。

値 説明
Enabled
Disabled

RequiredNsgRules

列挙

コントロール プレーン通信を制御するデータ プレーン (クラスター) がプライベート エンドポイント経由で行われるかどうかを示す値を取得または設定します。 サポートされている値は 、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部でのみ使用されます。 サーバーレス ComputeMode ワークスペースでは許可されません。

値 説明
AllRules
NoAzureDatabricksRules
NoAzureServiceRules

Sku

Object

リソースの SKU。

名前 型 説明
name

string

SKU 名。
tier

string

SKU 階層。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

Workspace

Object

ワークスペースに関する情報。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

リソースが存在する地理的な場所
name

string

リソースの名前
properties.accessConnector

AccessConnector

Databricks ワークスペースに関連付けられるコネクタ リソースにアクセスします。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.authorizations

WorkspaceProviderAuthorization[]

ワークスペース プロバイダーの承認。
properties.computeMode

ComputeMode

ワークスペースのコンピューティング モード。 作成時に必須で、変更できません。 指定できる値には、'Serverless'、'Hybrid' が含まれます。
properties.createdBy

CreatedBy

ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。
properties.createdDateTime

string (date-time)

ワークスペースが作成される日時を指定します。
properties.defaultCatalog

DefaultCatalogProperties

ワークスペースの作成時の既定のカタログ構成のプロパティ。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.defaultStorageFirewall

defaultStorageFirewall

デフォルトのストレージファイアウォール構成情報を取得または設定します。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.diskEncryptionSetId

string

マネージド ディスク暗号化セットのリソース ID。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.encryption

WorkspaceProperties.Encryption

databricks ワークスペースの暗号化プロパティ。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。
properties.enhancedSecurityCompliance

EnhancedSecurityComplianceDefinition

セキュリティ強化およびコンプライアンス アドオンに関連する設定が含まれています。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。
properties.isUcEnabled

boolean

ワークスペースで Unity Catalog が有効になっているかどうかを示します。 Serverless ComputeMode ワークスペースで true として設定します。
properties.managedDiskIdentity

ManagedIdentityConfiguration

Managed Disk Encryption に使用されるディスク暗号化セットのマネージド ID の詳細。 ハイブリッド ComputeMode ワークスペースでのみ返されます。
properties.managedResourceGroupId

string

マネージド リソース グループ ID。ハイブリッド ComputeMode ワークスペースで必要です。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.parameters

WorkspaceCustomParameters

ワークスペースのカスタム パラメーター。
properties.privateEndpointConnections

PrivateEndpointConnection[]

ワークスペースで作成されたプライベート エンドポイント接続。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。
properties.provisioningState

ProvisioningState

ワークスペースのプロビジョニング状態。
properties.publicNetworkAccess

PublicNetworkAccess

ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を無効に設定します。 Serverless ComputeModeワークスペースのフロントエンド専用プライベートリンクの設定に使用されました。
properties.requiredNsgRules

RequiredNsgRules

コントロール プレーン通信を制御するデータ プレーン (クラスター) がプライベート エンドポイント経由で行われるかどうかを示す値を取得または設定します。 サポートされている値は 、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部でのみ使用されます。 サーバーレス ComputeMode ワークスペースでは許可されません。
properties.storageAccountIdentity

ManagedIdentityConfiguration

ストレージ アカウントのマネージド ID の詳細。 ハイブリッド ComputeMode ワークスペースでのみ返されます。
properties.uiDefinitionUri

string

UI 定義ファイルが配置されている BLOB URI。
properties.updatedBy

CreatedBy

ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。
properties.workspaceId

string

Databricks コントロール プレーン内の databricks ワークスペースの一意の識別子。
properties.workspaceUrl

string

「adb-{workspaceId}」の形式のワークスペース URL。{random}.azuredatabricks.net'
sku

Sku

リソースの SKU。
systemData

systemData

このリソースに関連するシステム・メタデータ
tags

object

リソース タグ。
type

string

リソースの型。 例: Microsoft.Compute/virtualMachines または Microsoft.Storage/storageAccounts。

Workspace.WorkspaceProperties.Encryption

Object

databricks ワークスペースの暗号化プロパティ。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。

名前 型 説明
entities

EncryptionEntitiesDefinition

ワークスペースの暗号化エンティティ定義。

WorkspaceCustomBooleanParameter

Object

このフィールドに使用する値。

名前 型 説明
type

CustomParameterType

これが変数の型
value

boolean

このフィールドに使用する値。

WorkspaceCustomObjectParameter

Object

このフィールドに使用する値。

名前 型 説明
type

CustomParameterType

これが変数の型
value

object

このフィールドに使用する値。

WorkspaceCustomParameters

Object

ワークスペース作成に使われるカスタムパラメータ。 サーバーレス ComputeMode ワークスペースでは許可されません。

名前 型 説明
amlWorkspaceId

WorkspaceCustomStringParameter

Databricks ワークスペースにリンクする Azure Machine Learning ワークスペースの ID。 サーバーレス ComputeMode ワークスペースでは許可されません。
customPrivateSubnetName

WorkspaceCustomStringParameter

仮想ネットワーク内のプライベート サブネットの名前。 サーバーレス ComputeMode ワークスペースでは許可されません。
customPublicSubnetName

WorkspaceCustomStringParameter

仮想ネットワーク内のパブリック サブネットの名前。 サーバーレス ComputeMode ワークスペースでは許可されません。
customVirtualNetworkId

WorkspaceCustomStringParameter

この Databricks クラスターを作成する仮想ネットワークの ID。 サーバーレス ComputeMode ワークスペースでは許可されません。
enableNoPublicIp

WorkspaceNoPublicIPBooleanParameter

パブリック IP を無効にするかどうかを示すブール値。 既定値は true です。 サーバーレス ComputeMode ワークスペースでは許可されません。
encryption

WorkspaceEncryptionParameter

Customer-Managed キー (CMK) が有効なワークスペースの暗号化の詳細が含まれます。サーバーレス ComputeMode ワークスペースでは許可されません。
loadBalancerBackendPoolName

WorkspaceCustomStringParameter

セキュリティで保護されたクラスター接続用の送信ロード バランサー バックエンド プールの名前 (パブリック IP なし)。 サーバーレス ComputeMode ワークスペースでは許可されません。
loadBalancerId

WorkspaceCustomStringParameter

セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペースの送信ロード バランサーのリソース URI。 サーバーレス ComputeMode ワークスペースでは許可されません。
natGatewayName

WorkspaceCustomStringParameter

セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペース サブネットの NAT ゲートウェイの名前。 サーバーレス ComputeMode ワークスペースでは許可されません。
prepareEncryption

WorkspaceCustomBooleanParameter

暗号化用にワークスペースを準備します。 マネージド ストレージ アカウントのマネージド ID を有効にします。 サーバーレス ComputeMode ワークスペースでは許可されません。
publicIpName

WorkspaceCustomStringParameter

マネージド vNet を持つパブリック IP なしワークスペースのパブリック IP の名前。 サーバーレス ComputeMode ワークスペースでは許可されません。
requireInfrastructureEncryption

WorkspaceCustomBooleanParameter

保存データのプラットフォーム マネージド キーによる暗号化のセカンダリ レイヤーで DBFS ルート ファイル システムを有効にするかどうかを示すブール値。 サーバーレス ComputeMode ワークスペースでは許可されません。
resourceTags

WorkspaceCustomObjectParameter

[マネージド リソース グループ] の下のリソースに適用されるタグ。 これらは、ワークスペースレベルでタグを更新することで更新できます。 サーバーレス ComputeMode ワークスペースでは許可されません。
storageAccountName

WorkspaceCustomStringParameter

既定の DBFS ストレージ アカウント名。 サーバーレス ComputeMode ワークスペースでは許可されません。
storageAccountSkuName

WorkspaceCustomStringParameter

ストレージ アカウント SKU 名 (例: Standard_GRS、Standard_LRS)。 有効な入力については、 https://aka.ms/storageskus を参照してください。 サーバーレス ComputeMode ワークスペースでは許可されません。
vnetAddressPrefix

WorkspaceCustomStringParameter

マネージド仮想ネットワークのアドレス プレフィックス。 この入力の既定値は 10.139 です。 サーバーレス ComputeMode ワークスペースでは許可されません。

WorkspaceCustomStringParameter

Object

値。

名前 型 説明
type

CustomParameterType

これが変数の型
value

string

このフィールドに使用する値。

WorkspaceEncryptionParameter

Object

ワークスペースで使用される暗号化の詳細を含むオブジェクト。

名前 型 説明
type

CustomParameterType

これが変数の型
value

Encryption

このフィールドに使用する値。

WorkspaceNoPublicIPBooleanParameter

Object

このフィールドに使用する値。

名前 型 説明
type

CustomParameterType

これが変数の型
value

boolean

このフィールドに使用する値。

WorkspaceProperties.Encryption

Object

databricks ワークスペースの暗号化プロパティ。 サーバーレスとハイブリッド ComputeMode の両方のワークスペースでサポートされています。

名前 型 説明
entities

EncryptionEntitiesDefinition

ワークスペースの暗号化エンティティ定義。

WorkspaceProviderAuthorization

Object

ワークスペース プロバイダーの承認。

名前 型 説明
principalId

string (uuid)

プロバイダーのプリンシパル識別子。 これは、プロバイダーが ARM を呼び出してワークスペース リソースを管理するために使用する ID です。
roleDefinitionId

string (uuid)

プロバイダーのロール定義識別子。 このロールは、プロバイダーがワークスペースのコンテナー リソース グループに対して持つ必要があるすべてのアクセス許可を定義します。 このロール定義には、リソース グループを削除するアクセス許可を持つことはできません。