你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Synapse 工作区
Bicep 资源定义
可以使用面向以下操作部署工作区资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.Synapse/workspaces 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Synapse/workspaces@2021-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
azureADOnlyAuthentication: bool
cspWorkspaceAdminProperties: {
initialWorkspaceAdminObjectId: 'string'
}
defaultDataLakeStorage: {
accountUrl: 'string'
createManagedPrivateEndpoint: bool
filesystem: 'string'
resourceId: 'string'
}
encryption: {
cmk: {
kekIdentity: {
userAssignedIdentity: 'string'
useSystemAssignedIdentity: any()
}
key: {
keyVaultUrl: 'string'
name: 'string'
}
}
}
managedResourceGroupName: 'string'
managedVirtualNetwork: 'string'
managedVirtualNetworkSettings: {
allowedAadTenantIdsForLinking: [
'string'
]
linkedAccessCheckOnTargetResource: bool
preventDataExfiltration: bool
}
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
purviewConfiguration: {
purviewResourceId: 'string'
}
sqlAdministratorLogin: 'string'
sqlAdministratorLoginPassword: 'string'
trustedServiceBypassEnabled: bool
virtualNetworkProfile: {
computeSubnetId: 'string'
}
workspaceRepositoryConfiguration: {
accountName: 'string'
collaborationBranch: 'string'
hostName: 'string'
lastCommitId: 'string'
projectName: 'string'
repositoryName: 'string'
rootFolder: 'string'
tenantId: 'string'
type: 'string'
}
}
}
属性值
workspaces
名称 |
说明 |
值 |
name |
资源名称 |
字符串 (必需)
字符限制:1-50
有效字符: 小写字母、连字符和数字。
以字母或数字开头和结尾。
不能包含 -ondemand
资源名称在 Azure 中必须是唯一的。 |
location |
资源所在的地理位置 |
字符串 (必需) |
标记 |
资源标记。 |
标记名称和值的字典。 请参阅 模板中的标记 |
标识 |
工作区的标识 |
ManagedIdentity |
properties |
工作区资源属性 |
WorkspaceProperties |
ManagedIdentity
名称 |
说明 |
Value |
type |
工作区的托管标识类型 |
“None” “SystemAssigned” “SystemAssigned,UserAssigned” |
userAssignedIdentities |
用户分配的托管标识。 |
object |
WorkspaceProperties
名称 |
说明 |
值 |
azureADOnlyAuthentication |
在所有工作区子资源上启用或禁用 AzureADOnlyAuthentication |
bool |
cspWorkspaceAdminProperties |
CSP 订阅的初始工作区 AAD 管理员属性 |
CspWorkspaceAdminProperties |
defaultDataLakeStorage |
工作区默认 Data Lake 存储帐户详细信息 |
DataLakeStorageAccountDetails |
加密 |
工作区的加密详细信息 |
EncryptionDetails |
managedResourceGroupName |
工作区托管资源组。 资源组名称唯一标识用户 subscriptionId 中的资源组。 资源组名称的长度不能超过 90 个字符,并且必须是字符 (Char.IsLetterOrDigit () ) 和“-”、“_”、“ (”、“) ”和“.”的字母数字字符。 请注意,名称不能以“.”结尾。 |
string |
managedVirtualNetwork |
将其设置为“default”将确保此工作区的所有计算都位于代表用户管理的虚拟网络中。 |
字符串 |
managedVirtualNetworkSettings |
托管虚拟网络设置 |
ManagedVirtualNetworkSettings |
专用终结点 |
与工作区的专用终结点连接 |
PrivateEndpointConnection[] |
publicNetworkAccess |
启用或禁用对工作区的公共网络访问 |
'Disabled' 'Enabled' |
purviewConfiguration |
Purview 配置 |
PurviewConfiguration |
sqlAdministratorLogin |
工作区 SQL Active Directory 管理员的登录名 |
字符串 |
sqlAdministratorLoginPassword |
SQL 管理员登录密码 |
string |
trustedServiceBypassEnabled |
工作区的 trustedServiceBypassEnabled |
bool |
virtualNetworkProfile |
虚拟网络配置文件 |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Git 集成设置 |
WorkspaceRepositoryConfiguration |
CspWorkspaceAdminProperties
名称 |
说明 |
值 |
initialWorkspaceAdminObjectId |
初始工作区管理员的 AAD 对象 ID |
string |
DataLakeStorageAccountDetails
名称 |
说明 |
值 |
accountUrl |
帐户 URL |
string |
createManagedPrivateEndpoint |
是否为此存储帐户创建托管专用终结点 |
bool |
filesystem |
文件系统名称 |
string |
ResourceId |
此存储帐户的 ARM 资源 ID |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
名称 |
说明 |
值 |
userAssignedIdentity |
用户分配的标识资源 ID |
string |
useSystemAssignedIdentity |
指定是否使用系统分配的标识的布尔值 |
对于 Bicep,可以使用 any () 函数。 |
WorkspaceKeyDetails
名称 |
说明 |
值 |
keyVaultUrl |
工作区密钥子资源密钥保管库 URL |
string |
name |
工作区密钥子资源名称 |
string |
ManagedVirtualNetworkSettings
名称 |
说明 |
值 |
allowedAadTenantIdsForLinking |
允许链接的 Aad 租户 ID |
string[] |
linkedAccessCheckOnTargetResource |
对目标资源进行链接访问检查 |
bool |
preventDataExfiltration |
防止数据外泄 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
PrivateLinkServiceConnectionState
名称 |
说明 |
值 |
description |
专用链接服务连接说明。 |
字符串 |
status |
专用链接服务连接状态。 |
字符串 |
PurviewConfiguration
名称 |
说明 |
值 |
purviewResourceId |
Purview 资源 ID |
字符串 |
VirtualNetworkProfile
名称 |
说明 |
值 |
computeSubnetId |
用于工作区中计算的子网 ID |
字符串 |
WorkspaceRepositoryConfiguration
名称 |
说明 |
值 |
accountName |
帐户名 |
字符串 |
collaborationBranch |
协作分支 |
string |
hostName |
GitHub Enterprise 主机名。 例如:https://github.mydomain.com |
字符串 |
lastCommitId |
最后一个提交 ID |
字符串 |
projectName |
VSTS 项目名称 |
string |
repositoryName |
存储库名称 |
string |
rootFolder |
在存储库中使用的根文件夹 |
字符串 |
tenantId |
VSTS 租户 ID |
字符串 |
type |
工作区存储库 ID 配置的类型。 示例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration |
字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
ARM 模板资源定义
可以使用针对以下操作部署工作区资源类型:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
若要创建 Microsoft.Synapse/workspaces 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Synapse/workspaces",
"apiVersion": "2021-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"azureADOnlyAuthentication": "bool",
"cspWorkspaceAdminProperties": {
"initialWorkspaceAdminObjectId": "string"
},
"defaultDataLakeStorage": {
"accountUrl": "string",
"createManagedPrivateEndpoint": "bool",
"filesystem": "string",
"resourceId": "string"
},
"encryption": {
"cmk": {
"kekIdentity": {
"userAssignedIdentity": "string",
"useSystemAssignedIdentity": {}
},
"key": {
"keyVaultUrl": "string",
"name": "string"
}
}
},
"managedResourceGroupName": "string",
"managedVirtualNetwork": "string",
"managedVirtualNetworkSettings": {
"allowedAadTenantIdsForLinking": [ "string" ],
"linkedAccessCheckOnTargetResource": "bool",
"preventDataExfiltration": "bool"
},
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"purviewConfiguration": {
"purviewResourceId": "string"
},
"sqlAdministratorLogin": "string",
"sqlAdministratorLoginPassword": "string",
"trustedServiceBypassEnabled": "bool",
"virtualNetworkProfile": {
"computeSubnetId": "string"
},
"workspaceRepositoryConfiguration": {
"accountName": "string",
"collaborationBranch": "string",
"hostName": "string",
"lastCommitId": "string",
"projectName": "string",
"repositoryName": "string",
"rootFolder": "string",
"tenantId": "string",
"type": "string"
}
}
}
属性值
workspaces
名称 |
说明 |
Value |
type |
资源类型 |
“Microsoft.Synapse/workspaces” |
apiVersion |
资源 API 版本 |
'2021-06-01' |
name |
资源名称 |
字符串 (必需)
字符限制:1-50
有效字符: 小写字母、连字符和数字。
以字母或数字开头和结尾。
不能包含 -ondemand
资源名称在 Azure 中必须是唯一的。 |
location |
资源所在的地理位置 |
字符串 (必需) |
标记 |
资源标记。 |
标记名称和值的字典。 请参阅 模板中的标记 |
标识 |
工作区的标识 |
ManagedIdentity |
properties |
工作区资源属性 |
WorkspaceProperties |
ManagedIdentity
名称 |
说明 |
Value |
type |
工作区的托管标识类型 |
“None” “SystemAssigned” “SystemAssigned,UserAssigned” |
userAssignedIdentities |
用户分配的托管标识。 |
对象 |
WorkspaceProperties
名称 |
说明 |
值 |
azureADOnlyAuthentication |
在所有工作区子资源上启用或禁用 AzureADOnlyAuthentication |
bool |
cspWorkspaceAdminProperties |
CSP 订阅的初始工作区 AAD 管理员属性 |
CspWorkspaceAdminProperties |
defaultDataLakeStorage |
工作区默认 Data Lake 存储帐户详细信息 |
DataLakeStorageAccountDetails |
加密 |
工作区的加密详细信息 |
EncryptionDetails |
managedResourceGroupName |
工作区托管资源组。 资源组名称唯一标识用户 subscriptionId 中的资源组。 资源组名称的长度不能超过 90 个字符,并且必须是 (char.IsLetterOrDigit () ) 和“-”、“_”、“ (”、“) ”和“.”的字母数字字符。 请注意,名称不能以“.”结尾。 |
字符串 |
managedVirtualNetwork |
将此设置为“default”将确保此工作区的所有计算都位于代表用户管理的虚拟网络中。 |
字符串 |
managedVirtualNetworkSettings |
托管虚拟网络设置 |
ManagedVirtualNetworkSettings |
专用终结点 |
与工作区的专用终结点连接 |
PrivateEndpointConnection[] |
publicNetworkAccess |
启用或禁用对工作区的公共网络访问 |
“Disabled” “已启用” |
purviewConfiguration |
Purview 配置 |
PurviewConfiguration |
sqlAdministratorLogin |
工作区 SQL Active Directory 管理员的登录名 |
字符串 |
sqlAdministratorLoginPassword |
SQL 管理员登录密码 |
字符串 |
trustedServiceBypassEnabled |
工作区的 trustedServiceBypassEnabled |
bool |
virtualNetworkProfile |
虚拟网络配置文件 |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Git 集成设置 |
WorkspaceRepositoryConfiguration |
CspWorkspaceAdminProperties
名称 |
说明 |
值 |
initialWorkspaceAdminObjectId |
初始工作区管理员的 AAD 对象 ID |
字符串 |
DataLakeStorageAccountDetails
名称 |
说明 |
值 |
accountUrl |
帐户 URL |
字符串 |
createManagedPrivateEndpoint |
是否为此存储帐户创建托管专用终结点 |
bool |
filesystem |
文件系统名称 |
string |
ResourceId |
此存储帐户的 ARM 资源 ID |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
名称 |
说明 |
值 |
userAssignedIdentity |
用户分配的标识资源 ID |
string |
useSystemAssignedIdentity |
指定是否使用系统分配的标识的布尔值 |
|
WorkspaceKeyDetails
名称 |
说明 |
值 |
keyVaultUrl |
工作区密钥子资源密钥保管库 URL |
string |
name |
工作区密钥子资源名称 |
string |
ManagedVirtualNetworkSettings
名称 |
说明 |
值 |
allowedAadTenantIdsForLinking |
允许链接的 Aad 租户 ID |
string[] |
linkedAccessCheckOnTargetResource |
目标资源的链接访问检查 |
bool |
preventDataExfiltration |
防止数据外泄 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
PrivateLinkServiceConnectionState
名称 |
说明 |
值 |
description |
专用链接服务连接说明。 |
string |
status |
专用链接服务连接状态。 |
string |
PurviewConfiguration
名称 |
说明 |
值 |
purviewResourceId |
Purview 资源 ID |
string |
VirtualNetworkProfile
名称 |
说明 |
值 |
computeSubnetId |
用于工作区中计算的子网 ID |
string |
WorkspaceRepositoryConfiguration
名称 |
说明 |
值 |
accountName |
帐户名 |
string |
collaborationBranch |
协作分支 |
string |
hostName |
GitHub Enterprise 主机名。 例如:https://github.mydomain.com |
字符串 |
lastCommitId |
最后一个提交 ID |
字符串 |
projectName |
VSTS 项目名称 |
string |
repositoryName |
存储库名称 |
字符串 |
rootFolder |
在存储库中使用的根文件夹 |
字符串 |
tenantId |
VSTS 租户 ID |
字符串 |
type |
工作区存储库的类型ID 配置。 示例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration |
字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
可以使用面向以下操作部署工作区资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.Synapse/workspaces 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces@2021-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
azureADOnlyAuthentication = bool
cspWorkspaceAdminProperties = {
initialWorkspaceAdminObjectId = "string"
}
defaultDataLakeStorage = {
accountUrl = "string"
createManagedPrivateEndpoint = bool
filesystem = "string"
resourceId = "string"
}
encryption = {
cmk = {
kekIdentity = {
userAssignedIdentity = "string"
}
key = {
keyVaultUrl = "string"
name = "string"
}
}
}
managedResourceGroupName = "string"
managedVirtualNetwork = "string"
managedVirtualNetworkSettings = {
allowedAadTenantIdsForLinking = [
"string"
]
linkedAccessCheckOnTargetResource = bool
preventDataExfiltration = bool
}
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
purviewConfiguration = {
purviewResourceId = "string"
}
sqlAdministratorLogin = "string"
sqlAdministratorLoginPassword = "string"
trustedServiceBypassEnabled = bool
virtualNetworkProfile = {
computeSubnetId = "string"
}
workspaceRepositoryConfiguration = {
accountName = "string"
collaborationBranch = "string"
hostName = "string"
lastCommitId = "string"
projectName = "string"
repositoryName = "string"
rootFolder = "string"
tenantId = "string"
type = "string"
}
}
})
}
属性值
workspaces
名称 |
说明 |
Value |
type |
资源类型 |
“Microsoft.Synapse/workspaces@2021-06-01” |
name |
资源名称 |
字符串 (必需)
字符限制:1-50
有效字符: 小写字母、连字符和数字。
以字母或数字开头和结尾。
不能包含 -ondemand
资源名称在 Azure 中必须是唯一的。 |
location |
资源所在的地理位置 |
字符串 (必需) |
parent_id |
若要部署到资源组,请使用该资源组的 ID。 |
字符串 (必需) |
标记 |
资源标记。 |
标记名称和值的字典。 |
标识 |
工作区的标识 |
ManagedIdentity |
properties |
工作区资源属性 |
WorkspaceProperties |
ManagedIdentity
名称 |
说明 |
Value |
type |
工作区的托管标识类型 |
“SystemAssigned” “SystemAssigned,UserAssigned” |
identity_ids |
用户分配的托管标识。 |
用户标识 ID 的数组。 |
WorkspaceProperties
名称 |
说明 |
值 |
azureADOnlyAuthentication |
在所有工作区子资源上启用或禁用 AzureADOnlyAuthentication |
bool |
cspWorkspaceAdminProperties |
CSP 订阅的初始工作区 AAD 管理员属性 |
CspWorkspaceAdminProperties |
defaultDataLakeStorage |
工作区默认 Data Lake 存储帐户详细信息 |
DataLakeStorageAccountDetails |
加密 |
工作区的加密详细信息 |
EncryptionDetails |
managedResourceGroupName |
工作区托管资源组。 资源组名称唯一标识用户 subscriptionId 中的资源组。 资源组名称的长度不能超过 90 个字符,并且必须是字符 (Char.IsLetterOrDigit () ) 和“-”、“_”、“ (”、“) ”和“.”的字母数字字符。 请注意,名称不能以“.”结尾。 |
字符串 |
managedVirtualNetwork |
将其设置为“default”将确保此工作区的所有计算都位于代表用户管理的虚拟网络中。 |
字符串 |
managedVirtualNetworkSettings |
托管虚拟网络设置 |
ManagedVirtualNetworkSettings |
专用终结点 |
与工作区的专用终结点连接 |
PrivateEndpointConnection[] |
publicNetworkAccess |
启用或禁用对工作区的公共网络访问 |
“Disabled” “Enabled” |
purviewConfiguration |
Purview 配置 |
PurviewConfiguration |
sqlAdministratorLogin |
工作区 SQL Active Directory 管理员的登录名 |
字符串 |
sqlAdministratorLoginPassword |
SQL 管理员登录密码 |
字符串 |
trustedServiceBypassEnabled |
工作区的 trustedServiceBypassEnabled |
bool |
virtualNetworkProfile |
虚拟网络配置文件 |
VirtualNetworkProfile |
workspaceRepositoryConfiguration |
Git 集成设置 |
WorkspaceRepositoryConfiguration |
CspWorkspaceAdminProperties
名称 |
说明 |
值 |
initialWorkspaceAdminObjectId |
初始工作区管理员的 AAD 对象 ID |
字符串 |
DataLakeStorageAccountDetails
名称 |
说明 |
值 |
accountUrl |
帐户 URL |
string |
createManagedPrivateEndpoint |
是否为此存储帐户创建托管专用终结点 |
bool |
filesystem |
文件系统名称 |
string |
ResourceId |
此存储帐户的 ARM 资源 ID |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
名称 |
说明 |
值 |
userAssignedIdentity |
用户分配的标识资源 ID |
字符串 |
useSystemAssignedIdentity |
指定是否使用系统分配的标识的布尔值 |
|
WorkspaceKeyDetails
名称 |
说明 |
值 |
keyVaultUrl |
工作区密钥子资源密钥保管库 URL |
字符串 |
name |
工作区密钥子资源名称 |
字符串 |
ManagedVirtualNetworkSettings
名称 |
说明 |
值 |
allowedAadTenantIdsForLinking |
允许链接的 Aad 租户 ID |
string[] |
linkedAccessCheckOnTargetResource |
目标资源的链接访问检查 |
bool |
preventDataExfiltration |
防止数据外泄 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
PrivateEndpoint
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
PrivateLinkServiceConnectionState
名称 |
说明 |
值 |
description |
专用链接服务连接说明。 |
字符串 |
status |
专用链接服务连接状态。 |
string |
PurviewConfiguration
名称 |
说明 |
值 |
purviewResourceId |
Purview 资源 ID |
字符串 |
VirtualNetworkProfile
名称 |
说明 |
值 |
computeSubnetId |
用于工作区中计算的子网 ID |
字符串 |
WorkspaceRepositoryConfiguration
名称 |
说明 |
值 |
accountName |
帐户名 |
字符串 |
collaborationBranch |
协作分支 |
字符串 |
hostName |
GitHub Enterprise 主机名。 例如:https://github.mydomain.com |
字符串 |
lastCommitId |
最后一个提交 ID |
字符串 |
projectName |
VSTS 项目名称 |
string |
repositoryName |
存储库名称 |
字符串 |
rootFolder |
在存储库中使用的根文件夹 |
字符串 |
tenantId |
VSTS 租户 ID |
字符串 |
type |
工作区存储库的类型ID 配置。 示例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration |
字符串 |