通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Databricks 工作区

  • 项目

Bicep 资源定义

可以使用目标操作部署工作区资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Databricks/workspaces 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Databricks/workspaces@2024-09-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    accessConnector: {
      id: 'string'
      identityType: 'string'
      userAssignedIdentityId: 'string'
    }
    authorizations: [
      {
        principalId: 'string'
        roleDefinitionId: 'string'
      }
    ]
    createdBy: {}
    defaultCatalog: {
      initialName: 'string'
      initialType: 'string'
    }
    defaultStorageFirewall: 'string'
    encryption: {
      entities: {
        managedDisk: {
          keySource: 'string'
          keyVaultProperties: {
            keyName: 'string'
            keyVaultUri: 'string'
            keyVersion: 'string'
          }
          rotationToLatestKeyVersionEnabled: bool
        }
        managedServices: {
          keySource: 'string'
          keyVaultProperties: {
            keyName: 'string'
            keyVaultUri: 'string'
            keyVersion: 'string'
          }
        }
      }
    }
    enhancedSecurityCompliance: {
      automaticClusterUpdate: {
        value: 'string'
      }
      complianceSecurityProfile: {
        complianceStandards: [
          'string'
        ]
        value: 'string'
      }
      enhancedSecurityMonitoring: {
        value: 'string'
      }
    }
    managedDiskIdentity: {}
    managedResourceGroupId: 'string'
    parameters: {
      amlWorkspaceId: {
        value: 'string'
      }
      customPrivateSubnetName: {
        value: 'string'
      }
      customPublicSubnetName: {
        value: 'string'
      }
      customVirtualNetworkId: {
        value: 'string'
      }
      enableNoPublicIp: {
        value: bool
      }
      encryption: {
        value: {
          KeyName: 'string'
          keySource: 'string'
          keyvaulturi: 'string'
          keyversion: 'string'
        }
      }
      loadBalancerBackendPoolName: {
        value: 'string'
      }
      loadBalancerId: {
        value: 'string'
      }
      natGatewayName: {
        value: 'string'
      }
      prepareEncryption: {
        value: bool
      }
      publicIpName: {
        value: 'string'
      }
      requireInfrastructureEncryption: {
        value: bool
      }
      storageAccountName: {
        value: 'string'
      }
      storageAccountSkuName: {
        value: 'string'
      }
      vnetAddressPrefix: {
        value: 'string'
      }
    }
    publicNetworkAccess: 'string'
    requiredNsgRules: 'string'
    storageAccountIdentity: {}
    uiDefinitionUri: 'string'
    updatedBy: {}
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AutomaticClusterUpdateDefinition

名字 描述 价值
价值 “Disabled”
“Enabled”

ComplianceSecurityProfileDefinition

名字 描述 价值
complianceStandards 与工作区关联的符合性标准。 包含任一项的字符串数组：
“CYBER_ESSENTIAL_PLUS”
“HIPAA”
“NONE”
“PCI_DSS”
价值 “Disabled”
“Enabled”

CreatedBy

名字 描述 价值

DefaultCatalogProperties

名字 描述 价值
initialName 指定默认目录的初始名称。 如果未指定，将使用工作区的名称。 字符串
initialType 定义默认目录的初始类型。 可能的值（不区分大小写）：HiveMetastore、UnityCatalog “HiveMetastore”
“UnityCatalog”

加密

名字 描述 价值
KeyName KeyVault 密钥的名称。 字符串
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：默认值，Microsoft.Keyvault “Default”
“Microsoft.Keyvault”
keyvaulturi KeyVault 的 URI。 字符串
keyversion KeyVault 密钥的版本。 字符串

EncryptionEntitiesDefinition

名字 描述 价值
managedDisk databricks 托管磁盘的加密属性。 ManagedDiskEncryption
managedServices databricks 托管服务的加密属性。 EncryptionV2

EncryptionV2

名字 描述 价值
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：Microsoft.Keyvault “Microsoft.Keyvault”（必需）
keyVaultProperties 用于加密的 Key Vault 输入属性。 EncryptionV2KeyVaultProperties

EncryptionV2KeyVaultProperties

名字 描述 价值
keyName KeyVault 密钥的名称。 string （必需）
keyVaultUri KeyVault 的 URI。 string （必需）
keyVersion KeyVault 密钥的版本。 string （必需）

EnhancedSecurityComplianceDefinition

名字 描述 价值
automaticClusterUpdate 自动群集更新功能的状态。 AutomaticClusterUpdateDefinition
complianceSecurityProfile 合规性安全配置文件功能的状态。 ComplianceSecurityProfileDefinition
enhancedSecurityMonitoring 增强的安全监视功能的状态。 EnhancedSecurityMonitoringDefinition

EnhancedSecurityMonitoringDefinition

名字 描述 价值
价值 “Disabled”
“Enabled”

ManagedDiskEncryption

名字 描述 价值
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：Microsoft.Keyvault “Microsoft.Keyvault”（必需）
keyVaultProperties 用于加密的 Key Vault 输入属性。 ManagedDiskEncryptionKeyVaultProperties （必需）
rotationToLatestKeyVersionEnabled 指示是否应自动将最新的密钥版本用于托管磁盘加密。 bool

ManagedDiskEncryptionKeyVaultProperties

名字 描述 价值
keyName KeyVault 密钥的名称。 string （必需）
keyVaultUri KeyVault 的 URI。 string （必需）
keyVersion KeyVault 密钥的版本。 string （必需）

ManagedIdentityConfiguration

名字 描述 价值

Microsoft.Databricks/workspaces

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3 （必需）
性能 工作区属性。 WorkspaceProperties（必需）
sku 资源的 SKU。 Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

Sku

名字 描述 价值
名字 SKU 名称。 string （必需）
层 SKU 层。 字符串

TrackedResourceTags

名字 描述 价值

WorkspaceCustomBooleanParameter

名字 描述 价值
价值 应用于此字段的值。 bool （必需）

WorkspaceCustomParameters

名字 描述 价值
amlWorkspaceId 要链接到 Databricks 工作区的 Azure 机器学习工作区的 ID WorkspaceCustomStringParameter
customPrivateSubnetName 虚拟网络中的专用子网的名称 WorkspaceCustomStringParameter
customPublicSubnetName 虚拟网络中公共子网的名称 WorkspaceCustomStringParameter
customVirtualNetworkId 应在其中创建此 Databricks 群集的虚拟网络的 ID WorkspaceCustomStringParameter
enableNoPublicIp 指示是否应禁用公共 IP 的布尔值。 默认值为 true WorkspaceNoPublicIPBooleanParameter
加密 包含已启用 Customer-Managed 密钥（CMK）工作区的加密详细信息。 WorkspaceEncryptionParameter
loadBalancerBackendPoolName 用于安全群集连接的出站负载均衡器后端池的名称（无公共 IP）。 WorkspaceCustomStringParameter
loadBalancerId 用于安全群集连接（无公共 IP）工作区的出站负载均衡器的资源 URI。 WorkspaceCustomStringParameter
natGatewayName 安全群集连接（无公共 IP）工作区子网的 NAT 网关的名称。 WorkspaceCustomStringParameter
prepareEncryption 准备工作区进行加密。 为托管存储帐户启用托管标识。 WorkspaceCustomBooleanParameter
publicIpName 具有托管 vNet 的无公共 IP 工作区的公共 IP 的名称。 WorkspaceCustomStringParameter
requireInfrastructureEncryption 一个布尔值，指示是否使用平台托管密钥对静态数据使用辅助加密层启用 DBFS 根文件系统。 WorkspaceCustomBooleanParameter
storageAccountName 默认 DBFS 存储帐户名称。 WorkspaceCustomStringParameter
storageAccountSkuName 存储帐户 SKU 名称，例如：Standard_GRS，Standard_LRS。 有关有效输入，请参阅 https://aka.ms/storageskus。 WorkspaceCustomStringParameter
vnetAddressPrefix 托管虚拟网络的地址前缀。 此输入的默认值为 10.139。 WorkspaceCustomStringParameter

WorkspaceCustomStringParameter

名字 描述 价值
价值 应用于此字段的值。 string （必需）

WorkspaceEncryptionParameter

名字 描述 价值
价值 应用于此字段的值。 加密

WorkspaceNoPublicIPBooleanParameter

名字 描述 价值
价值 应用于此字段的值。 bool （必需）

WorkspaceProperties

名字 描述 价值
accessConnector 要与 Databricks 工作区关联的访问连接器资源 WorkspacePropertiesAccessConnector
授权 工作区提供程序授权。 WorkspaceProviderAuthorization[]
createdBy 指示创建工作区的实体的对象 ID、PUID 和应用程序 ID。 CreatedBy
defaultCatalog 创建工作区期间的默认目录配置的属性。 DefaultCatalogProperties
defaultStorageFirewall 获取或设置默认存储防火墙配置信息 “Disabled”
“Enabled”
加密 databricks 工作区的加密属性 WorkspacePropertiesEncryption
enhancedSecurityCompliance 包含与增强的安全性和合规性加载项相关的设置。 EnhancedSecurityComplianceDefinition
managedDiskIdentity 用于托管磁盘加密的磁盘加密集的托管标识的详细信息 ManagedIdentityConfiguration
managedResourceGroupId 托管资源组 ID。 string （必需）
参数 工作区的自定义参数。 WorkspaceCustomParameters
publicNetworkAccess 用于访问工作区的网络访问类型。 将值设置为禁用，以便仅通过专用链接访问工作区。 “Disabled”
“Enabled”
requiredNsgRules 获取或设置一个值，该值指示是否通过专用终结点控制平面通信的数据平面（群集）。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅用于内部使用。 “AllRules”
“NoAzureDatabricksRules”
“NoAzureServiceRules”
storageAccountIdentity 存储帐户的托管标识的详细信息 ManagedIdentityConfiguration
uiDefinitionUri UI 定义文件所在的 Blob URI。 字符串
updatedBy 指示上次更新工作区的实体的对象 ID、PUID 和应用程序 ID。 CreatedBy

WorkspacePropertiesAccessConnector

名字 描述 价值
id Azure Databricks 访问连接器资源的资源 ID。 string （必需）
identityType 访问连接器资源的标识类型。 “SystemAssigned”
“UserAssigned”（必需）
userAssignedIdentityId 与访问连接器资源关联的用户分配标识的资源 ID。 对于类型“UserAssigned”，对类型“SystemAssigned”无效，这是必需的。 字符串

WorkspacePropertiesEncryption

名字 描述 价值
实体 工作区的加密实体定义。 EncryptionEntitiesDefinition （必需）

WorkspaceProviderAuthorization

名字 描述 价值
principalId 提供程序的主体标识符。 这是提供程序用于调用 ARM 来管理工作区资源的标识。 字符串

约束：
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ （必需）
roleDefinitionId 提供程序的角色定义标识符。 此角色将定义提供程序在工作区的容器资源组上必须具有的所有权限。 此角色定义不能具有删除资源组的权限。 字符串

约束：
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ （必需）

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
Azure Databricks 一体式模板 VNetInjection-Pvtendpt 使用此模板可以创建网络安全组、虚拟网络和包含虚拟网络的 Azure Databricks 工作区和专用终结点。
用于 VNet 注入的 Azure Databricks 一体式模板 使用此模板，可以使用虚拟网络创建网络安全组、虚拟网络、NAT 网关和 Azure Databricks 工作区。
使用自定义地址范围 Azure Databricks 工作区 使用此模板，可以使用自定义虚拟网络地址范围创建 Azure Databricks 工作区。
使用 VNet 注入 Azure Databricks 工作区 使用此模板，可以使用自定义虚拟网络创建 Azure Databricks 工作区。
默认存储防火墙 的 AzureDatabricks 模板 使用此模板，可以使用虚拟网络和系统分配的访问连接器创建网络安全组、虚拟网络、专用终结点和启用默认存储防火墙的 Azure Databricks 工作区。
使用 NAT 网关 用于 VNet 注入的 AzureDatabricks 模板 使用此模板，可以使用虚拟网络创建 NAT 网关、网络安全组、虚拟网络和 Azure Databricks 工作区。
用于 VNetInjection 和负载均衡器的 AzureDatabricks 模板 使用此模板，可以使用虚拟网络创建负载均衡器、网络安全组、虚拟网络和 Azure Databricks 工作区。
部署 Azure Databricks 工作区 使用此模板可以创建 Azure Databricks 工作区。
部署包含所有 3 种 CMK 形式的 Azure Databricks 工作区 使用此模板，可以使用托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。
使用托管磁盘 CMK 部署 Azure Databricks 工作区 使用此模板，可以使用托管磁盘 CMK 创建 Azure Databricks 工作区。
使用 CMK 部署用于 DBFS 加密的 Azure Databricks WS 使用此模板，可以使用 CMK 为 DBFS 根加密创建 Azure Databricks 工作区
使用托管服务 CMK 部署 Azure Databricks 工作区 使用此模板，可以使用托管服务 CMK 创建 Azure Databricks 工作区。
在 Azure 体系结构 上部署体育分析 创建启用了 ADLS Gen 2 的 Azure 存储帐户、存储帐户的链接服务的 Azure 数据工厂实例（如果已部署的 Azure SQL 数据库）和 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识以及 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure Key Vault 实例、Azure SQL 数据库和 Azure 事件中心（用于流式处理用例）。 部署 Azure Key Vault 后，将为部署模板的用户提供数据工厂托管标识和 AAD 标识，并被授予 Key Vault 机密用户角色。

ARM 模板资源定义

可以使用目标操作部署工作区资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Databricks/workspaces 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Databricks/workspaces",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "accessConnector": {
      "id": "string",
      "identityType": "string",
      "userAssignedIdentityId": "string"
    },
    "authorizations": [
      {
        "principalId": "string",
        "roleDefinitionId": "string"
      }
    ],
    "createdBy": {
    },
    "defaultCatalog": {
      "initialName": "string",
      "initialType": "string"
    },
    "defaultStorageFirewall": "string",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "string",
          "keyVaultProperties": {
            "keyName": "string",
            "keyVaultUri": "string",
            "keyVersion": "string"
          },
          "rotationToLatestKeyVersionEnabled": "bool"
        },
        "managedServices": {
          "keySource": "string",
          "keyVaultProperties": {
            "keyName": "string",
            "keyVaultUri": "string",
            "keyVersion": "string"
          }
        }
      }
    },
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "string"
      },
      "complianceSecurityProfile": {
        "complianceStandards": [ "string" ],
        "value": "string"
      },
      "enhancedSecurityMonitoring": {
        "value": "string"
      }
    },
    "managedDiskIdentity": {
    },
    "managedResourceGroupId": "string",
    "parameters": {
      "amlWorkspaceId": {
        "value": "string"
      },
      "customPrivateSubnetName": {
        "value": "string"
      },
      "customPublicSubnetName": {
        "value": "string"
      },
      "customVirtualNetworkId": {
        "value": "string"
      },
      "enableNoPublicIp": {
        "value": "bool"
      },
      "encryption": {
        "value": {
          "KeyName": "string",
          "keySource": "string",
          "keyvaulturi": "string",
          "keyversion": "string"
        }
      },
      "loadBalancerBackendPoolName": {
        "value": "string"
      },
      "loadBalancerId": {
        "value": "string"
      },
      "natGatewayName": {
        "value": "string"
      },
      "prepareEncryption": {
        "value": "bool"
      },
      "publicIpName": {
        "value": "string"
      },
      "requireInfrastructureEncryption": {
        "value": "bool"
      },
      "storageAccountName": {
        "value": "string"
      },
      "storageAccountSkuName": {
        "value": "string"
      },
      "vnetAddressPrefix": {
        "value": "string"
      }
    },
    "publicNetworkAccess": "string",
    "requiredNsgRules": "string",
    "storageAccountIdentity": {
    },
    "uiDefinitionUri": "string",
    "updatedBy": {
    }
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AutomaticClusterUpdateDefinition

名字 描述 价值
价值 “Disabled”
“Enabled”

ComplianceSecurityProfileDefinition

名字 描述 价值
complianceStandards 与工作区关联的符合性标准。 包含任一项的字符串数组：
“CYBER_ESSENTIAL_PLUS”
“HIPAA”
“NONE”
“PCI_DSS”
价值 “Disabled”
“Enabled”

CreatedBy

名字 描述 价值

DefaultCatalogProperties

名字 描述 价值
initialName 指定默认目录的初始名称。 如果未指定，将使用工作区的名称。 字符串
initialType 定义默认目录的初始类型。 可能的值（不区分大小写）：HiveMetastore、UnityCatalog “HiveMetastore”
“UnityCatalog”

加密

名字 描述 价值
KeyName KeyVault 密钥的名称。 字符串
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：默认值，Microsoft.Keyvault “Default”
“Microsoft.Keyvault”
keyvaulturi KeyVault 的 URI。 字符串
keyversion KeyVault 密钥的版本。 字符串

EncryptionEntitiesDefinition

名字 描述 价值
managedDisk databricks 托管磁盘的加密属性。 ManagedDiskEncryption
managedServices databricks 托管服务的加密属性。 EncryptionV2

EncryptionV2

名字 描述 价值
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：Microsoft.Keyvault “Microsoft.Keyvault”（必需）
keyVaultProperties 用于加密的 Key Vault 输入属性。 EncryptionV2KeyVaultProperties

EncryptionV2KeyVaultProperties

名字 描述 价值
keyName KeyVault 密钥的名称。 string （必需）
keyVaultUri KeyVault 的 URI。 string （必需）
keyVersion KeyVault 密钥的版本。 string （必需）

EnhancedSecurityComplianceDefinition

名字 描述 价值
automaticClusterUpdate 自动群集更新功能的状态。 AutomaticClusterUpdateDefinition
complianceSecurityProfile 合规性安全配置文件功能的状态。 ComplianceSecurityProfileDefinition
enhancedSecurityMonitoring 增强的安全监视功能的状态。 EnhancedSecurityMonitoringDefinition

EnhancedSecurityMonitoringDefinition

名字 描述 价值
价值 “Disabled”
“Enabled”

ManagedDiskEncryption

名字 描述 价值
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：Microsoft.Keyvault “Microsoft.Keyvault”（必需）
keyVaultProperties 用于加密的 Key Vault 输入属性。 ManagedDiskEncryptionKeyVaultProperties （必需）
rotationToLatestKeyVersionEnabled 指示是否应自动将最新的密钥版本用于托管磁盘加密。 bool

ManagedDiskEncryptionKeyVaultProperties

名字 描述 价值
keyName KeyVault 密钥的名称。 string （必需）
keyVaultUri KeyVault 的 URI。 string （必需）
keyVersion KeyVault 密钥的版本。 string （必需）

ManagedIdentityConfiguration

名字 描述 价值

Microsoft.Databricks/workspaces

名字 描述 价值
apiVersion API 版本 '2024-09-01-preview'
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3 （必需）
性能 工作区属性。 WorkspaceProperties（必需）
sku 资源的 SKU。 Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Databricks/workspaces”

Sku

名字 描述 价值
名字 SKU 名称。 string （必需）
层 SKU 层。 字符串

TrackedResourceTags

名字 描述 价值

WorkspaceCustomBooleanParameter

名字 描述 价值
价值 应用于此字段的值。 bool （必需）

WorkspaceCustomParameters

名字 描述 价值
amlWorkspaceId 要链接到 Databricks 工作区的 Azure 机器学习工作区的 ID WorkspaceCustomStringParameter
customPrivateSubnetName 虚拟网络中的专用子网的名称 WorkspaceCustomStringParameter
customPublicSubnetName 虚拟网络中公共子网的名称 WorkspaceCustomStringParameter
customVirtualNetworkId 应在其中创建此 Databricks 群集的虚拟网络的 ID WorkspaceCustomStringParameter
enableNoPublicIp 指示是否应禁用公共 IP 的布尔值。 默认值为 true WorkspaceNoPublicIPBooleanParameter
加密 包含已启用 Customer-Managed 密钥（CMK）工作区的加密详细信息。 WorkspaceEncryptionParameter
loadBalancerBackendPoolName 用于安全群集连接的出站负载均衡器后端池的名称（无公共 IP）。 WorkspaceCustomStringParameter
loadBalancerId 用于安全群集连接（无公共 IP）工作区的出站负载均衡器的资源 URI。 WorkspaceCustomStringParameter
natGatewayName 安全群集连接（无公共 IP）工作区子网的 NAT 网关的名称。 WorkspaceCustomStringParameter
prepareEncryption 准备工作区进行加密。 为托管存储帐户启用托管标识。 WorkspaceCustomBooleanParameter
publicIpName 具有托管 vNet 的无公共 IP 工作区的公共 IP 的名称。 WorkspaceCustomStringParameter
requireInfrastructureEncryption 一个布尔值，指示是否使用平台托管密钥对静态数据使用辅助加密层启用 DBFS 根文件系统。 WorkspaceCustomBooleanParameter
storageAccountName 默认 DBFS 存储帐户名称。 WorkspaceCustomStringParameter
storageAccountSkuName 存储帐户 SKU 名称，例如：Standard_GRS，Standard_LRS。 有关有效输入，请参阅 https://aka.ms/storageskus。 WorkspaceCustomStringParameter
vnetAddressPrefix 托管虚拟网络的地址前缀。 此输入的默认值为 10.139。 WorkspaceCustomStringParameter

WorkspaceCustomStringParameter

名字 描述 价值
价值 应用于此字段的值。 string （必需）

WorkspaceEncryptionParameter

名字 描述 价值
价值 应用于此字段的值。 加密

WorkspaceNoPublicIPBooleanParameter

名字 描述 价值
价值 应用于此字段的值。 bool （必需）

WorkspaceProperties

名字 描述 价值
accessConnector 要与 Databricks 工作区关联的访问连接器资源 WorkspacePropertiesAccessConnector
授权 工作区提供程序授权。 WorkspaceProviderAuthorization[]
createdBy 指示创建工作区的实体的对象 ID、PUID 和应用程序 ID。 CreatedBy
defaultCatalog 创建工作区期间的默认目录配置的属性。 DefaultCatalogProperties
defaultStorageFirewall 获取或设置默认存储防火墙配置信息 “Disabled”
“Enabled”
加密 databricks 工作区的加密属性 WorkspacePropertiesEncryption
enhancedSecurityCompliance 包含与增强的安全性和合规性加载项相关的设置。 EnhancedSecurityComplianceDefinition
managedDiskIdentity 用于托管磁盘加密的磁盘加密集的托管标识的详细信息 ManagedIdentityConfiguration
managedResourceGroupId 托管资源组 ID。 string （必需）
参数 工作区的自定义参数。 WorkspaceCustomParameters
publicNetworkAccess 用于访问工作区的网络访问类型。 将值设置为禁用，以便仅通过专用链接访问工作区。 “Disabled”
“Enabled”
requiredNsgRules 获取或设置一个值，该值指示是否通过专用终结点控制平面通信的数据平面（群集）。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅用于内部使用。 “AllRules”
“NoAzureDatabricksRules”
“NoAzureServiceRules”
storageAccountIdentity 存储帐户的托管标识的详细信息 ManagedIdentityConfiguration
uiDefinitionUri UI 定义文件所在的 Blob URI。 字符串
updatedBy 指示上次更新工作区的实体的对象 ID、PUID 和应用程序 ID。 CreatedBy

WorkspacePropertiesAccessConnector

名字 描述 价值
id Azure Databricks 访问连接器资源的资源 ID。 string （必需）
identityType 访问连接器资源的标识类型。 “SystemAssigned”
“UserAssigned”（必需）
userAssignedIdentityId 与访问连接器资源关联的用户分配标识的资源 ID。 对于类型“UserAssigned”，对类型“SystemAssigned”无效，这是必需的。 字符串

WorkspacePropertiesEncryption

名字 描述 价值
实体 工作区的加密实体定义。 EncryptionEntitiesDefinition （必需）

WorkspaceProviderAuthorization

名字 描述 价值
principalId 提供程序的主体标识符。 这是提供程序用于调用 ARM 来管理工作区资源的标识。 字符串

约束：
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ （必需）
roleDefinitionId 提供程序的角色定义标识符。 此角色将定义提供程序在工作区的容器资源组上必须具有的所有权限。 此角色定义不能具有删除资源组的权限。 字符串

约束：
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ （必需）

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
Azure Databricks 一体式模板 VNetInjection-Pvtendpt

部署到 Azure 		使用此模板可以创建网络安全组、虚拟网络和包含虚拟网络的 Azure Databricks 工作区和专用终结点。
用于 VNet 注入的 Azure Databricks 一体式模板

部署到 Azure 		使用此模板，可以使用虚拟网络创建网络安全组、虚拟网络、NAT 网关和 Azure Databricks 工作区。
使用自定义地址范围 Azure Databricks 工作区

部署到 Azure 		使用此模板，可以使用自定义虚拟网络地址范围创建 Azure Databricks 工作区。
使用 VNet 注入 Azure Databricks 工作区

部署到 Azure 		使用此模板，可以使用自定义虚拟网络创建 Azure Databricks 工作区。
默认存储防火墙 的 AzureDatabricks 模板

部署到 Azure 		使用此模板，可以使用虚拟网络和系统分配的访问连接器创建网络安全组、虚拟网络、专用终结点和启用默认存储防火墙的 Azure Databricks 工作区。
使用 NAT 网关 用于 VNet 注入的 AzureDatabricks 模板

部署到 Azure 		使用此模板，可以使用虚拟网络创建 NAT 网关、网络安全组、虚拟网络和 Azure Databricks 工作区。
用于 VNetInjection 和负载均衡器的 AzureDatabricks 模板

部署到 Azure 		使用此模板，可以使用虚拟网络创建负载均衡器、网络安全组、虚拟网络和 Azure Databricks 工作区。
使用默认存储防火墙 AzureDatabricks 模板

部署到 Azure 		使用此模板，可以使用 Privateendpoint、所有三种形式的 CMK 和 User-Assigned Access Connector 创建启用了默认存储防火墙的 Azure Databricks 工作区。
部署 Azure Databricks 工作区

部署到 Azure 		使用此模板可以创建 Azure Databricks 工作区。
部署包含所有 3 种 CMK 形式的 Azure Databricks 工作区

部署到 Azure 		使用此模板，可以使用托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。
使用托管磁盘 CMK 部署 Azure Databricks 工作区

部署到 Azure 		使用此模板，可以使用托管磁盘 CMK 创建 Azure Databricks 工作区。
使用 PE 部署 Azure Databricks 工作区，CMK 所有窗体

部署到 Azure 		使用此模板，可以使用 PrivateEndpoint 和托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。
使用 CMK 部署用于 DBFS 加密的 Azure Databricks WS

部署到 Azure 		使用此模板，可以使用 CMK 为 DBFS 根加密创建 Azure Databricks 工作区
使用托管服务 CMK 部署 Azure Databricks 工作区

部署到 Azure 		使用此模板，可以使用托管服务 CMK 创建 Azure Databricks 工作区。
在 Azure 体系结构 上部署体育分析

部署到 Azure 		创建启用了 ADLS Gen 2 的 Azure 存储帐户、存储帐户的链接服务的 Azure 数据工厂实例（如果已部署的 Azure SQL 数据库）和 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识以及 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure Key Vault 实例、Azure SQL 数据库和 Azure 事件中心（用于流式处理用例）。 部署 Azure Key Vault 后，将为部署模板的用户提供数据工厂托管标识和 AAD 标识，并被授予 Key Vault 机密用户角色。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署工作区资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Databricks/workspaces 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Databricks/workspaces@2024-09-01-preview"
  name = "string"
  location = "string"
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      accessConnector = {
        id = "string"
        identityType = "string"
        userAssignedIdentityId = "string"
      }
      authorizations = [
        {
          principalId = "string"
          roleDefinitionId = "string"
        }
      ]
      createdBy = {
      }
      defaultCatalog = {
        initialName = "string"
        initialType = "string"
      }
      defaultStorageFirewall = "string"
      encryption = {
        entities = {
          managedDisk = {
            keySource = "string"
            keyVaultProperties = {
              keyName = "string"
              keyVaultUri = "string"
              keyVersion = "string"
            }
            rotationToLatestKeyVersionEnabled = bool
          }
          managedServices = {
            keySource = "string"
            keyVaultProperties = {
              keyName = "string"
              keyVaultUri = "string"
              keyVersion = "string"
            }
          }
        }
      }
      enhancedSecurityCompliance = {
        automaticClusterUpdate = {
          value = "string"
        }
        complianceSecurityProfile = {
          complianceStandards = [
            "string"
          ]
          value = "string"
        }
        enhancedSecurityMonitoring = {
          value = "string"
        }
      }
      managedDiskIdentity = {
      }
      managedResourceGroupId = "string"
      parameters = {
        amlWorkspaceId = {
          value = "string"
        }
        customPrivateSubnetName = {
          value = "string"
        }
        customPublicSubnetName = {
          value = "string"
        }
        customVirtualNetworkId = {
          value = "string"
        }
        enableNoPublicIp = {
          value = bool
        }
        encryption = {
          value = {
            KeyName = "string"
            keySource = "string"
            keyvaulturi = "string"
            keyversion = "string"
          }
        }
        loadBalancerBackendPoolName = {
          value = "string"
        }
        loadBalancerId = {
          value = "string"
        }
        natGatewayName = {
          value = "string"
        }
        prepareEncryption = {
          value = bool
        }
        publicIpName = {
          value = "string"
        }
        requireInfrastructureEncryption = {
          value = bool
        }
        storageAccountName = {
          value = "string"
        }
        storageAccountSkuName = {
          value = "string"
        }
        vnetAddressPrefix = {
          value = "string"
        }
      }
      publicNetworkAccess = "string"
      requiredNsgRules = "string"
      storageAccountIdentity = {
      }
      uiDefinitionUri = "string"
      updatedBy = {
      }
    }
  })
}

属性值

AutomaticClusterUpdateDefinition

名字 描述 价值
价值 “Disabled”
“Enabled”

ComplianceSecurityProfileDefinition

名字 描述 价值
complianceStandards 与工作区关联的符合性标准。 包含任一项的字符串数组：
“CYBER_ESSENTIAL_PLUS”
“HIPAA”
“NONE”
“PCI_DSS”
价值 “Disabled”
“Enabled”

CreatedBy

名字 描述 价值

DefaultCatalogProperties

名字 描述 价值
initialName 指定默认目录的初始名称。 如果未指定，将使用工作区的名称。 字符串
initialType 定义默认目录的初始类型。 可能的值（不区分大小写）：HiveMetastore、UnityCatalog “HiveMetastore”
“UnityCatalog”

加密

名字 描述 价值
KeyName KeyVault 密钥的名称。 字符串
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：默认值，Microsoft.Keyvault “Default”
“Microsoft.Keyvault”
keyvaulturi KeyVault 的 URI。 字符串
keyversion KeyVault 密钥的版本。 字符串

EncryptionEntitiesDefinition

名字 描述 价值
managedDisk databricks 托管磁盘的加密属性。 ManagedDiskEncryption
managedServices databricks 托管服务的加密属性。 EncryptionV2

EncryptionV2

名字 描述 价值
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：Microsoft.Keyvault “Microsoft.Keyvault”（必需）
keyVaultProperties 用于加密的 Key Vault 输入属性。 EncryptionV2KeyVaultProperties

EncryptionV2KeyVaultProperties

名字 描述 价值
keyName KeyVault 密钥的名称。 string （必需）
keyVaultUri KeyVault 的 URI。 string （必需）
keyVersion KeyVault 密钥的版本。 string （必需）

EnhancedSecurityComplianceDefinition

名字 描述 价值
automaticClusterUpdate 自动群集更新功能的状态。 AutomaticClusterUpdateDefinition
complianceSecurityProfile 合规性安全配置文件功能的状态。 ComplianceSecurityProfileDefinition
enhancedSecurityMonitoring 增强的安全监视功能的状态。 EnhancedSecurityMonitoringDefinition

EnhancedSecurityMonitoringDefinition

名字 描述 价值
价值 “Disabled”
“Enabled”

ManagedDiskEncryption

名字 描述 价值
keySource 加密密钥来源（提供程序）。 可能的值（不区分大小写）：Microsoft.Keyvault “Microsoft.Keyvault”（必需）
keyVaultProperties 用于加密的 Key Vault 输入属性。 ManagedDiskEncryptionKeyVaultProperties （必需）
rotationToLatestKeyVersionEnabled 指示是否应自动将最新的密钥版本用于托管磁盘加密。 bool

ManagedDiskEncryptionKeyVaultProperties

名字 描述 价值
keyName KeyVault 密钥的名称。 string （必需）
keyVaultUri KeyVault 的 URI。 string （必需）
keyVersion KeyVault 密钥的版本。 string （必需）

ManagedIdentityConfiguration

名字 描述 价值

Microsoft.Databricks/workspaces

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3 （必需）
性能 工作区属性。 WorkspaceProperties（必需）
sku 资源的 SKU。 Sku
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Databricks/workspaces@2024-09-01-preview”

Sku

名字 描述 价值
名字 SKU 名称。 string （必需）
层 SKU 层。 字符串

TrackedResourceTags

名字 描述 价值

WorkspaceCustomBooleanParameter

名字 描述 价值
价值 应用于此字段的值。 bool （必需）

WorkspaceCustomParameters

名字 描述 价值
amlWorkspaceId 要链接到 Databricks 工作区的 Azure 机器学习工作区的 ID WorkspaceCustomStringParameter
customPrivateSubnetName 虚拟网络中的专用子网的名称 WorkspaceCustomStringParameter
customPublicSubnetName 虚拟网络中公共子网的名称 WorkspaceCustomStringParameter
customVirtualNetworkId 应在其中创建此 Databricks 群集的虚拟网络的 ID WorkspaceCustomStringParameter
enableNoPublicIp 指示是否应禁用公共 IP 的布尔值。 默认值为 true WorkspaceNoPublicIPBooleanParameter
加密 包含已启用 Customer-Managed 密钥（CMK）工作区的加密详细信息。 WorkspaceEncryptionParameter
loadBalancerBackendPoolName 用于安全群集连接的出站负载均衡器后端池的名称（无公共 IP）。 WorkspaceCustomStringParameter
loadBalancerId 用于安全群集连接（无公共 IP）工作区的出站负载均衡器的资源 URI。 WorkspaceCustomStringParameter
natGatewayName 安全群集连接（无公共 IP）工作区子网的 NAT 网关的名称。 WorkspaceCustomStringParameter
prepareEncryption 准备工作区进行加密。 为托管存储帐户启用托管标识。 WorkspaceCustomBooleanParameter
publicIpName 具有托管 vNet 的无公共 IP 工作区的公共 IP 的名称。 WorkspaceCustomStringParameter
requireInfrastructureEncryption 一个布尔值，指示是否使用平台托管密钥对静态数据使用辅助加密层启用 DBFS 根文件系统。 WorkspaceCustomBooleanParameter
storageAccountName 默认 DBFS 存储帐户名称。 WorkspaceCustomStringParameter
storageAccountSkuName 存储帐户 SKU 名称，例如：Standard_GRS，Standard_LRS。 有关有效输入，请参阅 https://aka.ms/storageskus。 WorkspaceCustomStringParameter
vnetAddressPrefix 托管虚拟网络的地址前缀。 此输入的默认值为 10.139。 WorkspaceCustomStringParameter

WorkspaceCustomStringParameter

名字 描述 价值
价值 应用于此字段的值。 string （必需）

WorkspaceEncryptionParameter

名字 描述 价值
价值 应用于此字段的值。 加密

WorkspaceNoPublicIPBooleanParameter

名字 描述 价值
价值 应用于此字段的值。 bool （必需）

WorkspaceProperties

名字 描述 价值
accessConnector 要与 Databricks 工作区关联的访问连接器资源 WorkspacePropertiesAccessConnector
授权 工作区提供程序授权。 WorkspaceProviderAuthorization[]
createdBy 指示创建工作区的实体的对象 ID、PUID 和应用程序 ID。 CreatedBy
defaultCatalog 创建工作区期间的默认目录配置的属性。 DefaultCatalogProperties
defaultStorageFirewall 获取或设置默认存储防火墙配置信息 “Disabled”
“Enabled”
加密 databricks 工作区的加密属性 WorkspacePropertiesEncryption
enhancedSecurityCompliance 包含与增强的安全性和合规性加载项相关的设置。 EnhancedSecurityComplianceDefinition
managedDiskIdentity 用于托管磁盘加密的磁盘加密集的托管标识的详细信息 ManagedIdentityConfiguration
managedResourceGroupId 托管资源组 ID。 string （必需）
参数 工作区的自定义参数。 WorkspaceCustomParameters
publicNetworkAccess 用于访问工作区的网络访问类型。 将值设置为禁用，以便仅通过专用链接访问工作区。 “Disabled”
“Enabled”
requiredNsgRules 获取或设置一个值，该值指示是否通过专用终结点控制平面通信的数据平面（群集）。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅用于内部使用。 “AllRules”
“NoAzureDatabricksRules”
“NoAzureServiceRules”
storageAccountIdentity 存储帐户的托管标识的详细信息 ManagedIdentityConfiguration
uiDefinitionUri UI 定义文件所在的 Blob URI。 字符串
updatedBy 指示上次更新工作区的实体的对象 ID、PUID 和应用程序 ID。 CreatedBy

WorkspacePropertiesAccessConnector

名字 描述 价值
id Azure Databricks 访问连接器资源的资源 ID。 string （必需）
identityType 访问连接器资源的标识类型。 “SystemAssigned”
“UserAssigned”（必需）
userAssignedIdentityId 与访问连接器资源关联的用户分配标识的资源 ID。 对于类型“UserAssigned”，对类型“SystemAssigned”无效，这是必需的。 字符串

WorkspacePropertiesEncryption

名字 描述 价值
实体 工作区的加密实体定义。 EncryptionEntitiesDefinition （必需）

WorkspaceProviderAuthorization

名字 描述 价值
principalId 提供程序的主体标识符。 这是提供程序用于调用 ARM 来管理工作区资源的标识。 字符串

约束：
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ （必需）
roleDefinitionId 提供程序的角色定义标识符。 此角色将定义提供程序在工作区的容器资源组上必须具有的所有权限。 此角色定义不能具有删除资源组的权限。 字符串

约束：
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ （必需）