你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Databricks 工作区 2023-02-01
Bicep 资源定义
可以使用针对以下操作部署工作区资源类型:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
若要创建 Microsoft.Databricks/workspaces 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Databricks/workspaces@2023-02-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
tier: 'string'
}
properties: {
authorizations: [
{
principalId: 'string'
roleDefinitionId: 'string'
}
]
createdBy: {}
encryption: {
entities: {
managedDisk: {
keySource: 'Microsoft.Keyvault'
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
rotationToLatestKeyVersionEnabled: bool
}
managedServices: {
keySource: 'Microsoft.Keyvault'
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: '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: {}
}
}
属性值
workspaces
名称 |
说明 |
值 |
name |
资源名称 |
字符串 (必需)
字符限制:3-64
有效字符: 字母数字、下划线字符和连字符 |
location |
资源所在的地理位置 |
字符串 (必需) |
标记 |
资源标记。 |
标记名称和值的字典。 请参阅 模板中的标记 |
sku |
资源的 SKU。 |
Sku |
properties |
工作区属性。 |
WorkspaceProperties (必需) |
WorkspaceProperties
名称 |
说明 |
值 |
授权 |
工作区提供程序授权。 |
WorkspaceProviderAuthorization[] |
createdBy |
指示创建工作区的实体的对象 ID、PUID 和应用程序 ID。 |
CreatedBy |
加密 |
databricks 工作区的加密属性 |
WorkspacePropertiesEncryption |
managedDiskIdentity |
用于托管磁盘加密的磁盘加密集的托管标识的详细信息 |
ManagedIdentityConfiguration |
managedResourceGroupId |
托管资源组 ID。 |
字符串 (必需) |
parameters |
工作区的自定义参数。 |
WorkspaceCustomParameters |
publicNetworkAccess |
用于访问工作区的网络访问类型。 将值设置为“已禁用”,以便只能通过专用链接访问工作区。 |
“Disabled” “已启用” |
requiredNsgRules |
获取或设置一个值,该值指示数据平面 (群集是否) 通过专用终结点进行控制平面通信。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅供内部使用。 |
“AllRules” “NoAzureDatabricksRules” “NoAzureServiceRules” |
storageAccountIdentity |
存储帐户托管标识的详细信息 |
ManagedIdentityConfiguration |
uiDefinitionUri |
UI 定义文件所在的 Blob URI。 |
字符串 |
updatedBy |
指示上次更新工作区的实体的对象 ID、PUID 和应用程序 ID。 |
CreatedBy |
WorkspaceProviderAuthorization
名称 |
说明 |
值 |
principalId |
提供程序的主体标识符。 这是提供程序将用来调用 ARM 来管理工作区资源的标识。 |
字符串 (必需) |
roleDefinitionId |
提供程序的角色定义标识符。 此角色将定义提供程序必须对工作区的容器资源组拥有的所有权限。 此角色定义不能具有删除资源组的权限。 |
字符串 (必需) |
CreatedBy
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
WorkspacePropertiesEncryption
EncryptionEntitiesDefinition
ManagedDiskEncryption
名称 |
说明 |
值 |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:Microsoft.Keyvault |
“Microsoft.Keyvault” (必需) |
keyVaultProperties |
密钥保管库加密的输入属性。 |
ManagedDiskEncryptionKeyVaultProperties (必需) |
rotationToLatestKeyVersionEnabled |
指示是否应自动将最新密钥版本用于托管磁盘加密。 |
bool |
ManagedDiskEncryptionKeyVaultProperties
名称 |
说明 |
值 |
keyName |
KeyVault 密钥的名称。 |
字符串 (必需) |
keyVaultUri |
KeyVault 的 URI。 |
字符串 (必需) |
keyVersion |
KeyVault 密钥的版本。 |
字符串 (必需) |
EncryptionV2
名称 |
说明 |
值 |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:Microsoft.Keyvault |
“Microsoft.Keyvault” (必需) |
keyVaultProperties |
密钥保管库加密的输入属性。 |
EncryptionV2KeyVaultProperties |
EncryptionV2KeyVaultProperties
名称 |
说明 |
值 |
keyName |
KeyVault 密钥的名称。 |
字符串 (必需) |
keyVaultUri |
KeyVault 的 URI。 |
字符串 (必需) |
keyVersion |
KeyVault 密钥的版本。 |
字符串 (必需) |
ManagedIdentityConfiguration
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
WorkspaceCustomParameters
WorkspaceCustomStringParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
字符串 (必需) |
WorkspaceCustomBooleanParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
需要 bool () |
WorkspaceEncryptionParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
加密 |
Encryption
名称 |
说明 |
值 |
KeyName |
KeyVault 密钥的名称。 |
string |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:Default、Microsoft.Keyvault |
'Default' 'Microsoft.Keyvault' |
keyvaulturi |
KeyVault 的 URI。 |
string |
keyversion |
KeyVault 密钥的版本。 |
字符串 |
SKU
名称 |
说明 |
值 |
name |
SKU 名称。 |
字符串 (必需) |
层 |
SKU 层。 |
string |
快速入门模板
以下快速入门模板部署此资源类型。
ARM 模板资源定义
可以使用针对以下操作部署工作区资源类型:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
若要创建 Microsoft.Databricks/workspaces 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Databricks/workspaces",
"apiVersion": "2023-02-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string",
"tier": "string"
},
"properties": {
"authorizations": [
{
"principalId": "string",
"roleDefinitionId": "string"
}
],
"createdBy": {},
"encryption": {
"entities": {
"managedDisk": {
"keySource": "Microsoft.Keyvault",
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
},
"rotationToLatestKeyVersionEnabled": "bool"
},
"managedServices": {
"keySource": "Microsoft.Keyvault",
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "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": {}
}
}
属性值
workspaces
名称 |
说明 |
Value |
type |
资源类型 |
“Microsoft.Databricks/workspaces” |
apiVersion |
资源 API 版本 |
'2023-02-01' |
name |
资源名称 |
字符串 (必需)
字符限制:3-64
有效字符: 字母数字、下划线字符和连字符 |
location |
资源所在的地理位置 |
字符串 (必需) |
标记 |
资源标记。 |
标记名称和值的字典。 请参阅 模板中的标记 |
sku |
资源的 SKU。 |
Sku |
properties |
工作区属性。 |
WorkspaceProperties (必需) |
WorkspaceProperties
名称 |
说明 |
值 |
授权 |
工作区提供程序授权。 |
WorkspaceProviderAuthorization[] |
createdBy |
指示创建工作区的实体的对象 ID、PUID 和应用程序 ID。 |
CreatedBy |
加密 |
databricks 工作区的加密属性 |
WorkspacePropertiesEncryption |
managedDiskIdentity |
用于托管磁盘加密的磁盘加密集的托管标识的详细信息 |
ManagedIdentityConfiguration |
managedResourceGroupId |
托管资源组 ID。 |
字符串 (必需) |
parameters |
工作区的自定义参数。 |
WorkspaceCustomParameters |
publicNetworkAccess |
用于访问工作区的网络访问类型。 将值设置为“已禁用”,以便只能通过专用链接访问工作区。 |
“Disabled” “已启用” |
requiredNsgRules |
获取或设置一个值,该值指示数据平面 (群集是否) 通过专用终结点进行控制平面通信。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅供内部使用。 |
“AllRules” “NoAzureDatabricksRules” “NoAzureServiceRules” |
storageAccountIdentity |
存储帐户托管标识的详细信息 |
ManagedIdentityConfiguration |
uiDefinitionUri |
UI 定义文件所在的 Blob URI。 |
字符串 |
updatedBy |
指示上次更新工作区的实体的对象 ID、PUID 和应用程序 ID。 |
CreatedBy |
WorkspaceProviderAuthorization
名称 |
说明 |
值 |
principalId |
提供程序的主体标识符。 这是提供程序将用来调用 ARM 来管理工作区资源的标识。 |
字符串 (必需) |
roleDefinitionId |
提供程序的角色定义标识符。 此角色将定义提供程序必须对工作区的容器资源组拥有的所有权限。 此角色定义不能具有删除资源组的权限。 |
字符串 (必需) |
CreatedBy
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
WorkspacePropertiesEncryption
EncryptionEntitiesDefinition
ManagedDiskEncryption
名称 |
说明 |
值 |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:Microsoft.Keyvault |
“Microsoft.Keyvault” (必需) |
keyVaultProperties |
密钥保管库加密的输入属性。 |
ManagedDiskEncryptionKeyVaultProperties (必需) |
rotationToLatestKeyVersionEnabled |
指示是否应自动将最新密钥版本用于托管磁盘加密。 |
bool |
ManagedDiskEncryptionKeyVaultProperties
名称 |
说明 |
值 |
keyName |
KeyVault 密钥的名称。 |
字符串 (必需) |
keyVaultUri |
KeyVault 的 URI。 |
字符串 (必需) |
keyVersion |
KeyVault 密钥的版本。 |
字符串 (必需) |
EncryptionV2
名称 |
说明 |
值 |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:Microsoft.Keyvault |
“Microsoft.Keyvault” (必需) |
keyVaultProperties |
密钥保管库加密的输入属性。 |
EncryptionV2KeyVaultProperties |
EncryptionV2KeyVaultProperties
名称 |
说明 |
值 |
keyName |
KeyVault 密钥的名称。 |
字符串 (必需) |
keyVaultUri |
KeyVault 的 URI。 |
字符串 (必需) |
keyVersion |
KeyVault 密钥的版本。 |
字符串 (必需) |
ManagedIdentityConfiguration
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
WorkspaceCustomParameters
WorkspaceCustomStringParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
字符串 (必需) |
WorkspaceCustomBooleanParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
bool (必需) |
WorkspaceEncryptionParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
加密 |
Encryption
名称 |
说明 |
值 |
KeyName |
KeyVault 密钥的名称。 |
字符串 |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:默认值,Microsoft.Keyvault |
'Default' “Microsoft.Keyvault” |
keyvaulturi |
KeyVault 的 URI。 |
string |
keyversion |
KeyVault 密钥的版本。 |
string |
SKU
名称 |
说明 |
值 |
name |
SKU 名称。 |
字符串 (必需) |
层 |
SKU 层。 |
string |
快速入门模板
以下快速入门模板部署此资源类型。
可以使用面向以下操作部署工作区资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.Databricks/workspaces 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Databricks/workspaces@2023-02-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
authorizations = [
{
principalId = "string"
roleDefinitionId = "string"
}
]
createdBy = {}
encryption = {
entities = {
managedDisk = {
keySource = "Microsoft.Keyvault"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
}
rotationToLatestKeyVersionEnabled = bool
}
managedServices = {
keySource = "Microsoft.Keyvault"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "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"
}
})
}
属性值
workspaces
名称 |
说明 |
Value |
type |
资源类型 |
“Microsoft.Databricks/workspaces@2023-02-01” |
name |
资源名称 |
字符串 (必需)
字符限制:3-64
有效字符: 字母数字、下划线字符和连字符 |
location |
资源所在的地理位置 |
字符串 (必需) |
parent_id |
若要部署到资源组,请使用该资源组的 ID。 |
字符串 (必需) |
标记 |
资源标记。 |
标记名称和值的字典。 |
sku |
资源的 SKU。 |
Sku |
properties |
工作区属性。 |
WorkspaceProperties (必需) |
WorkspaceProperties
名称 |
说明 |
值 |
授权 |
工作区提供程序授权。 |
WorkspaceProviderAuthorization[] |
createdBy |
指示创建工作区的实体的对象 ID、PUID 和应用程序 ID。 |
CreatedBy |
加密 |
databricks 工作区的加密属性 |
WorkspacePropertiesEncryption |
managedDiskIdentity |
用于托管磁盘加密的磁盘加密集的托管标识的详细信息 |
ManagedIdentityConfiguration |
managedResourceGroupId |
托管资源组 ID。 |
字符串 (必需) |
parameters |
工作区的自定义参数。 |
WorkspaceCustomParameters |
publicNetworkAccess |
用于访问工作区的网络访问类型。 将值设置为“已禁用”,以便仅通过专用链接访问工作区。 |
“Disabled” “Enabled” |
requiredNsgRules |
获取或设置一个值,该值指示数据平面 (群集是否) 通过专用终结点进行控制平面通信。 支持的值为“AllRules”和“NoAzureDatabricksRules”。 “NoAzureServiceRules”值仅供内部使用。 |
“AllRules” “NoAzureDatabricksRules” “NoAzureServiceRules” |
storageAccountIdentity |
存储帐户的托管标识的详细信息 |
ManagedIdentityConfiguration |
uiDefinitionUri |
UI 定义文件所在的 Blob URI。 |
字符串 |
updatedBy |
指示上次更新工作区的实体的对象 ID、PUID 和应用程序 ID。 |
CreatedBy |
WorkspaceProviderAuthorization
名称 |
说明 |
值 |
principalId |
提供程序的主体标识符。 这是提供程序将用于调用 ARM 来管理工作区资源的标识。 |
字符串 (必需) |
roleDefinitionId |
提供程序的角色定义标识符。 此角色将定义提供程序必须对工作区的容器资源组拥有的所有权限。 此角色定义不能具有删除资源组的权限。 |
字符串 (必需) |
CreatedBy
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
WorkspacePropertiesEncryption
EncryptionEntitiesDefinition
ManagedDiskEncryption
名称 |
说明 |
值 |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:Microsoft.Keyvault |
需要“Microsoft.Keyvault” () |
keyVaultProperties |
密钥保管库加密的输入属性。 |
ManagedDiskEncryptionKeyVaultProperties (必需) |
rotationToLatestKeyVersionEnabled |
指示是否应自动将最新的密钥版本用于托管磁盘加密。 |
bool |
ManagedDiskEncryptionKeyVaultProperties
名称 |
说明 |
值 |
keyName |
KeyVault 密钥的名称。 |
字符串 (必需) |
keyVaultUri |
KeyVault 的 URI。 |
字符串 (必需) |
keyVersion |
KeyVault 密钥的版本。 |
字符串 (必需) |
EncryptionV2
名称 |
说明 |
值 |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:Microsoft.Keyvault |
需要“Microsoft.Keyvault” () |
keyVaultProperties |
密钥保管库加密的输入属性。 |
EncryptionV2KeyVaultProperties |
EncryptionV2KeyVaultProperties
名称 |
说明 |
值 |
keyName |
KeyVault 密钥的名称。 |
字符串 (必需) |
keyVaultUri |
KeyVault 的 URI。 |
字符串 (必需) |
keyVersion |
KeyVault 密钥的版本。 |
字符串 (必需) |
ManagedIdentityConfiguration
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
WorkspaceCustomParameters
WorkspaceCustomStringParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
字符串 (必需) |
WorkspaceCustomBooleanParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
bool (必需) |
WorkspaceEncryptionParameter
名称 |
说明 |
值 |
value |
应用于此字段的值。 |
加密 |
Encryption
名称 |
说明 |
值 |
KeyName |
KeyVault 密钥的名称。 |
string |
keySource |
加密密钥源 (提供程序) 。 (不区分大小写) 的可能值:默认值,Microsoft.Keyvault |
“Default” “Microsoft.Keyvault” |
keyvaulturi |
KeyVault 的 URI。 |
string |
keyversion |
KeyVault 密钥的版本。 |
字符串 |
SKU
名称 |
说明 |
值 |
name |
SKU 名称。 |
字符串 (必需) |
层 |
SKU 层。 |
字符串 |