共用方式為

Microsoft.Databricks 工作區 2024-09-01-preview

  • 發行項

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 金鑰的名稱。 字串 （必要）
keyVaultUri KeyVault 的 URI。 字串 （必要）
keyVersion KeyVault 金鑰的版本。 字串 （必要）

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 金鑰的名稱。 字串 （必要）
keyVaultUri KeyVault 的 URI。 字串 （必要）
keyVersion KeyVault 金鑰的版本。 字串 （必要）

ManagedIdentityConfiguration

名字 描述 價值

Microsoft.Databricks/workspaces

名字 描述 價值
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串

約束：
最小長度 = 3
最大長度 = 3 （必要）
性能 工作區屬性。 WorkspaceProperties （必要）
sku 資源的 SKU。 Sku
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

Sku

名字 描述 價值
名字 SKU 名稱。 字串 （必要）
層 SKU 層。 字串

TrackedResourceTags

名字 描述 價值

WorkspaceCustomBooleanParameter

名字 描述 價值
價值 應該用於此欄位的值。 布林 （必要）

WorkspaceCustomParameters

名字 描述 價值
amlWorkspaceId 要與 Databricks 工作區連結的 Azure Machine Learning 工作區標識符 WorkspaceCustomStringParameter
customPrivateSubnetName 虛擬網路內私人子網的名稱 WorkspaceCustomStringParameter
customPublicSubnetName 虛擬網路內公用子網的名稱 WorkspaceCustomStringParameter
customVirtualNetworkId 應該建立此 Databricks 叢集之虛擬網路的標識碼 WorkspaceCustomStringParameter
enableNoPublicIp 布爾值，指出是否應該停用公用IP。 默認值為 true WorkspaceNoPublicIPBooleanParameter
加密 包含已啟用 Customer-Managed 金鑰 （CMK） 工作區的加密詳細資料。 WorkspaceEncryptionParameter
loadBalancerBackendPoolName 安全叢集聯機的輸出Load Balancer後端集區名稱（無公用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

名字 描述 價值
價值 應該用於此欄位的值。 字串 （必要）

WorkspaceEncryptionParameter

名字 描述 價值
價值 應該用於此欄位的值。 加密

WorkspaceNoPublicIPBooleanParameter

名字 描述 價值
價值 應該用於此欄位的值。 布林 （必要）

WorkspaceProperties

名字 描述 價值
accessConnector 存取即將與 Databricks 工作區相關聯的連接器資源 WorkspacePropertiesAccessConnector
授權 工作區提供者授權。 WorkspaceProviderAuthorization[]
createdBy 指出建立工作區之實體的物件標識碼、PUID 和應用程式識別碼。 CreatedBy
defaultCatalog 工作區建立期間的預設目錄組態屬性。 DefaultCatalogProperties
defaultStorageFirewall 取得或設定預設記憶體防火牆組態資訊 'Disabled'
'Enabled'
加密 databricks 工作區的加密屬性 WorkspacePropertiesEncryption
enhancedSecurityCompliance 包含與增強式安全性與合規性附加元件相關的設定。 EnhancedSecurityComplianceDefinition
managedDiskIdentity 用於受控磁碟加密之磁碟加密集的受控識別詳細數據 ManagedIdentityConfiguration
managedResourceGroupId 受控資源群組標識碼。 字串 （必要）
參數 工作區的自定義參數。 WorkspaceCustomParameters
publicNetworkAccess 用於存取工作區的網路存取類型。 將值設定為停用，以僅透過私人連結存取工作區。 'Disabled'
'Enabled'
requiredNsgRules 取得或設定值，指出是否透過私人端點控制平面通訊的數據平面（叢集）。 支援的值為 'AllRules' 和 'NoAzureDatabricksRules'。 'NoAzureServiceRules' 值僅供內部使用。 'AllRules'
'NoAzureDatabricksRules'
'NoAzureServiceRules'
storageAccountIdentity 記憶體帳戶受控識別的詳細數據 ManagedIdentityConfiguration
uiDefinitionUri UI 定義檔案所在的 Blob URI。 字串
updatedBy 指出上次更新工作區之實體的物件標識碼、PUID 和應用程式識別碼。 CreatedBy

WorkspacePropertiesAccessConnector

名字 描述 價值
id Azure Databricks Access Connector 資源的資源標識符。 字串 （必要）
identityType Access Connector 資源的識別類型。 'SystemAssigned'
'UserAssigned' （必要）
userAssignedIdentityId 與 Access Connector 資源相關聯的使用者指派身分識別的資源識別碼。 類型 '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 All-in-one Templat VNetInjection-Pvtendpt 此範本可讓您使用虛擬網路和私人端點建立網路安全組、虛擬網路和 Azure Databricks 工作區。
適用於 VNet 插入 的 Azure Databricks 全方位範本 此範本可讓您使用虛擬網路建立網路安全組、虛擬網路、NAT 閘道和 Azure Databricks 工作區。
使用自訂位址範圍 Azure Databricks 工作區 此範本可讓您建立具有自定義虛擬網路位址範圍的 Azure Databricks 工作區。
使用 VNet 插入 Azure Databricks 工作區 此範本可讓您使用自定義虛擬網路建立 Azure Databricks 工作區。
預設記憶體防火牆的 AzureDatabricks 範本 此範本可讓您使用虛擬網路和系統指派的存取連接器，建立網路安全組、虛擬網路、私人端點，以及啟用預設記憶體防火牆的預設記憶體防火牆。
使用 NAT 閘道進行 VNet 插入的 AzureDatabricks 樣本 此範本可讓您使用虛擬網路建立 NAT 閘道、網路安全組、虛擬網路和 Azure Databricks 工作區。
適用於 VNetInjection 和 Load Balancer 的 AzureDatabricks 範本 此範本可讓您使用虛擬網路建立負載平衡器、網路安全組、虛擬網路和 Azure Databricks 工作區。
部署 Azure Databricks 工作區 此範本可讓您建立 Azure Databricks 工作區。
部署所有 3 種 CMK 形式的 Azure Databricks 工作區 此範本可讓您使用受控服務和具有 DBFS 加密的 CMK 來建立 Azure Databricks 工作區。
部署具有受控磁碟的 Azure Databricks 工作區 CMK 此範本可讓您使用受控磁碟 CMK 建立 Azure Databricks 工作區。
使用 CMK 部署適用於 DBFS 加密的 Azure Databricks WS 此範本可讓您使用 CMK 建立適用於 DBFS 根加密的 Azure Databricks 工作區
使用受控服務 CMK 部署 Azure Databricks 工作區 此範本可讓您使用受控服務 CMK 建立 Azure Databricks 工作區。
在 Azure 架構上部署體育分析 建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例（如果已部署的 Azure SQL Database），以及 Azure Databricks 實例。 部署範本和 ADF 實例受控識別的使用者 AAD 身分識別，將會在記憶體帳戶上授與記憶體 Blob 數據參與者角色。 還有一個選項可用來部署 Azure Key Vault 實例、Azure SQL Database 和 Azure 事件中樞（適用於串流使用案例）。 部署 Azure Key Vault 時，部署範本之使用者的 Data Factory 受控識別和 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 金鑰的名稱。 字串 （必要）
keyVaultUri KeyVault 的 URI。 字串 （必要）
keyVersion KeyVault 金鑰的版本。 字串 （必要）

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 金鑰的名稱。 字串 （必要）
keyVaultUri KeyVault 的 URI。 字串 （必要）
keyVersion KeyVault 金鑰的版本。 字串 （必要）

ManagedIdentityConfiguration

名字 描述 價值

Microsoft.Databricks/workspaces

名字 描述 價值
apiVersion API 版本 '2024-09-01-preview'
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串

約束：
最小長度 = 3
最大長度 = 3 （必要）
性能 工作區屬性。 WorkspaceProperties （必要）
sku 資源的 SKU。 Sku
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.Databricks/workspaces'

Sku

名字 描述 價值
名字 SKU 名稱。 字串 （必要）
層 SKU 層。 字串

TrackedResourceTags

名字 描述 價值

WorkspaceCustomBooleanParameter

名字 描述 價值
價值 應該用於此欄位的值。 布林 （必要）

WorkspaceCustomParameters

名字 描述 價值
amlWorkspaceId 要與 Databricks 工作區連結的 Azure Machine Learning 工作區標識符 WorkspaceCustomStringParameter
customPrivateSubnetName 虛擬網路內私人子網的名稱 WorkspaceCustomStringParameter
customPublicSubnetName 虛擬網路內公用子網的名稱 WorkspaceCustomStringParameter
customVirtualNetworkId 應該建立此 Databricks 叢集之虛擬網路的標識碼 WorkspaceCustomStringParameter
enableNoPublicIp 布爾值，指出是否應該停用公用IP。 默認值為 true WorkspaceNoPublicIPBooleanParameter
加密 包含已啟用 Customer-Managed 金鑰 （CMK） 工作區的加密詳細資料。 WorkspaceEncryptionParameter
loadBalancerBackendPoolName 安全叢集聯機的輸出Load Balancer後端集區名稱（無公用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

名字 描述 價值
價值 應該用於此欄位的值。 字串 （必要）

WorkspaceEncryptionParameter

名字 描述 價值
價值 應該用於此欄位的值。 加密

WorkspaceNoPublicIPBooleanParameter

名字 描述 價值
價值 應該用於此欄位的值。 布林 （必要）

WorkspaceProperties

名字 描述 價值
accessConnector 存取即將與 Databricks 工作區相關聯的連接器資源 WorkspacePropertiesAccessConnector
授權 工作區提供者授權。 WorkspaceProviderAuthorization[]
createdBy 指出建立工作區之實體的物件標識碼、PUID 和應用程式識別碼。 CreatedBy
defaultCatalog 工作區建立期間的預設目錄組態屬性。 DefaultCatalogProperties
defaultStorageFirewall 取得或設定預設記憶體防火牆組態資訊 'Disabled'
'Enabled'
加密 databricks 工作區的加密屬性 WorkspacePropertiesEncryption
enhancedSecurityCompliance 包含與增強式安全性與合規性附加元件相關的設定。 EnhancedSecurityComplianceDefinition
managedDiskIdentity 用於受控磁碟加密之磁碟加密集的受控識別詳細數據 ManagedIdentityConfiguration
managedResourceGroupId 受控資源群組標識碼。 字串 （必要）
參數 工作區的自定義參數。 WorkspaceCustomParameters
publicNetworkAccess 用於存取工作區的網路存取類型。 將值設定為停用，以僅透過私人連結存取工作區。 'Disabled'
'Enabled'
requiredNsgRules 取得或設定值，指出是否透過私人端點控制平面通訊的數據平面（叢集）。 支援的值為 'AllRules' 和 'NoAzureDatabricksRules'。 'NoAzureServiceRules' 值僅供內部使用。 'AllRules'
'NoAzureDatabricksRules'
'NoAzureServiceRules'
storageAccountIdentity 記憶體帳戶受控識別的詳細數據 ManagedIdentityConfiguration
uiDefinitionUri UI 定義檔案所在的 Blob URI。 字串
updatedBy 指出上次更新工作區之實體的物件標識碼、PUID 和應用程式識別碼。 CreatedBy

WorkspacePropertiesAccessConnector

名字 描述 價值
id Azure Databricks Access Connector 資源的資源標識符。 字串 （必要）
identityType Access Connector 資源的識別類型。 'SystemAssigned'
'UserAssigned' （必要）
userAssignedIdentityId 與 Access Connector 資源相關聯的使用者指派身分識別的資源識別碼。 類型 '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 All-in-one Templat 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 		此範本可讓您使用虛擬網路和系統指派的存取連接器，建立網路安全組、虛擬網路、私人端點，以及啟用預設記憶體防火牆的預設記憶體防火牆。
使用 NAT 閘道進行 VNet 插入的 AzureDatabricks 樣本

部署至 Azure 		此範本可讓您使用虛擬網路建立 NAT 閘道、網路安全組、虛擬網路和 Azure Databricks 工作區。
適用於 VNetInjection 和 Load Balancer 的 AzureDatabricks 範本

部署至 Azure 		此範本可讓您使用虛擬網路建立負載平衡器、網路安全組、虛擬網路和 Azure Databricks 工作區。
具有預設記憶體防火牆的 AzureDatabricks 範本

部署至 Azure 		此範本可讓您建立已啟用預設記憶體防火牆的 Azure Databricks 工作區，其中包含 Privateendpoint、這三種形式的 CMK，以及 User-Assigned Access Connector。
部署 Azure Databricks 工作區

部署至 Azure 		此範本可讓您建立 Azure Databricks 工作區。
部署所有 3 種 CMK 形式的 Azure Databricks 工作區

部署至 Azure 		此範本可讓您使用受控服務和具有 DBFS 加密的 CMK 來建立 Azure Databricks 工作區。
部署具有受控磁碟的 Azure Databricks 工作區 CMK

部署至 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 Data Factory 實例（如果已部署的 Azure SQL Database），以及 Azure Databricks 實例。 部署範本和 ADF 實例受控識別的使用者 AAD 身分識別，將會在記憶體帳戶上授與記憶體 Blob 數據參與者角色。 還有一個選項可用來部署 Azure Key Vault 實例、Azure SQL Database 和 Azure 事件中樞（適用於串流使用案例）。 部署 Azure Key Vault 時，部署範本之使用者的 Data Factory 受控識別和 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 金鑰的名稱。 字串 （必要）
keyVaultUri KeyVault 的 URI。 字串 （必要）
keyVersion KeyVault 金鑰的版本。 字串 （必要）

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 金鑰的名稱。 字串 （必要）
keyVaultUri KeyVault 的 URI。 字串 （必要）
keyVersion KeyVault 金鑰的版本。 字串 （必要）

ManagedIdentityConfiguration

名字 描述 價值

Microsoft.Databricks/workspaces

名字 描述 價值
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串

約束：
最小長度 = 3
最大長度 = 3 （必要）
性能 工作區屬性。 WorkspaceProperties （必要）
sku 資源的 SKU。 Sku
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.Databricks/workspaces@2024-09-01-preview”

Sku

名字 描述 價值
名字 SKU 名稱。 字串 （必要）
層 SKU 層。 字串

TrackedResourceTags

名字 描述 價值

WorkspaceCustomBooleanParameter

名字 描述 價值
價值 應該用於此欄位的值。 布林 （必要）

WorkspaceCustomParameters

名字 描述 價值
amlWorkspaceId 要與 Databricks 工作區連結的 Azure Machine Learning 工作區標識符 WorkspaceCustomStringParameter
customPrivateSubnetName 虛擬網路內私人子網的名稱 WorkspaceCustomStringParameter
customPublicSubnetName 虛擬網路內公用子網的名稱 WorkspaceCustomStringParameter
customVirtualNetworkId 應該建立此 Databricks 叢集之虛擬網路的標識碼 WorkspaceCustomStringParameter
enableNoPublicIp 布爾值，指出是否應該停用公用IP。 默認值為 true WorkspaceNoPublicIPBooleanParameter
加密 包含已啟用 Customer-Managed 金鑰 （CMK） 工作區的加密詳細資料。 WorkspaceEncryptionParameter
loadBalancerBackendPoolName 安全叢集聯機的輸出Load Balancer後端集區名稱（無公用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

名字 描述 價值
價值 應該用於此欄位的值。 字串 （必要）

WorkspaceEncryptionParameter

名字 描述 價值
價值 應該用於此欄位的值。 加密

WorkspaceNoPublicIPBooleanParameter

名字 描述 價值
價值 應該用於此欄位的值。 布林 （必要）

WorkspaceProperties

名字 描述 價值
accessConnector 存取即將與 Databricks 工作區相關聯的連接器資源 WorkspacePropertiesAccessConnector
授權 工作區提供者授權。 WorkspaceProviderAuthorization[]
createdBy 指出建立工作區之實體的物件標識碼、PUID 和應用程式識別碼。 CreatedBy
defaultCatalog 工作區建立期間的預設目錄組態屬性。 DefaultCatalogProperties
defaultStorageFirewall 取得或設定預設記憶體防火牆組態資訊 'Disabled'
'Enabled'
加密 databricks 工作區的加密屬性 WorkspacePropertiesEncryption
enhancedSecurityCompliance 包含與增強式安全性與合規性附加元件相關的設定。 EnhancedSecurityComplianceDefinition
managedDiskIdentity 用於受控磁碟加密之磁碟加密集的受控識別詳細數據 ManagedIdentityConfiguration
managedResourceGroupId 受控資源群組標識碼。 字串 （必要）
參數 工作區的自定義參數。 WorkspaceCustomParameters
publicNetworkAccess 用於存取工作區的網路存取類型。 將值設定為停用，以僅透過私人連結存取工作區。 'Disabled'
'Enabled'
requiredNsgRules 取得或設定值，指出是否透過私人端點控制平面通訊的數據平面（叢集）。 支援的值為 'AllRules' 和 'NoAzureDatabricksRules'。 'NoAzureServiceRules' 值僅供內部使用。 'AllRules'
'NoAzureDatabricksRules'
'NoAzureServiceRules'
storageAccountIdentity 記憶體帳戶受控識別的詳細數據 ManagedIdentityConfiguration
uiDefinitionUri UI 定義檔案所在的 Blob URI。 字串
updatedBy 指出上次更新工作區之實體的物件標識碼、PUID 和應用程式識別碼。 CreatedBy

WorkspacePropertiesAccessConnector

名字 描述 價值
id Azure Databricks Access Connector 資源的資源標識符。 字串 （必要）
identityType Access Connector 資源的識別類型。 'SystemAssigned'
'UserAssigned' （必要）
userAssignedIdentityId 與 Access Connector 資源相關聯的使用者指派身分識別的資源識別碼。 類型 '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}$ （必要）