通过

你当前正在访问 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' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    azureADOnlyAuthentication: bool
    cspWorkspaceAdminProperties: {
      initialWorkspaceAdminObjectId: 'string'
    }
    defaultDataLakeStorage: {
      accountUrl: 'string'
      createManagedPrivateEndpoint: bool
      filesystem: 'string'
      resourceId: 'string'
    }
    encryption: {
      cmk: {
        kekIdentity: {
          userAssignedIdentity: 'string'
          useSystemAssignedIdentity: any(Azure.Bicep.Types.Concrete.AnyType)
        }
        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'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

CspWorkspaceAdminProperties

名字 描述 价值
initialWorkspaceAdminObjectId 初始工作区管理员的 AAD 对象 ID 字符串

CustomerManagedKeyDetails

名字 描述 价值
kekIdentity 密钥加密密钥 KekIdentityProperties
钥匙 工作区的键对象 WorkspaceKeyDetails

DataLakeStorageAccountDetails

名字 描述 价值
accountUrl 帐户 URL 字符串
createManagedPrivateEndpoint 创建此存储帐户的托管专用终结点 bool
filesystem 文件系统名称 字符串
resourceId 此存储帐户的 ARM 资源 ID 字符串

EncryptionDetails

名字 描述 价值
cmk 客户管理的密钥详细信息 CustomerManagedKeyDetails

KekIdentityProperties

名字 描述 价值
userAssignedIdentity 用户分配的标识资源 ID 字符串
useSystemAssignedIdentity 指定是否使用系统分配标识的布尔值 任何

ManagedIdentity

名字 描述 价值
类型 工作区的托管标识类型 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
userAssignedIdentities 用户分配的托管标识。 UserAssignedManagedIdentities

ManagedVirtualNetworkSettings

名字 描述 价值
allowedAadTenantIdsForLinking 允许链接的 Aad 租户 ID string[]
linkedAccessCheckOnTargetResource 目标资源上的链接访问检查 bool
preventDataExfiltration 防止数据外泄 bool

Microsoft.Synapse/workspaces

名字 描述 价值
身份 工作区的标识 ManagedIdentity
位置 资源所在的地理位置 string （必需）
名字 资源名称 string （必需）
性能 工作区资源属性 WorkspaceProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

PrivateEndpoint

名字 描述 价值

PrivateEndpointConnection

名字 描述 价值
性能 专用终结点连接属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字 描述 价值
privateEndpoint 连接所属的专用终结点。 PrivateEndpoint
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

名字 描述 价值
描述 专用链接服务连接说明。 字符串
地位 专用链接服务连接状态。 字符串

PurviewConfiguration

名字 描述 价值
purviewResourceId Purview 资源 ID 字符串

TrackedResourceTags

名字 描述 价值

UserAssignedManagedIdentities

名字 描述 价值

UserAssignedManagedIdentity

名字 描述 价值

VirtualNetworkProfile

名字 描述 价值
computeSubnetId 用于工作区中计算的子网 ID 字符串

WorkspaceKeyDetails

名字 描述 价值
keyVaultUrl 工作区密钥子资源密钥保管库 URL 字符串
名字 工作区密钥子资源名称 字符串

WorkspaceProperties

名字 描述 价值
azureADOnlyAuthentication 在所有工作区子资源上启用或禁用 AzureADOnlyAuthentication bool
cspWorkspaceAdminProperties CSP 订阅的初始工作区 AAD 管理员属性 CspWorkspaceAdminProperties
defaultDataLakeStorage 工作区默认 Data Lake 存储帐户详细信息 DataLakeStorageAccountDetails
加密 工作区的加密详细信息 EncryptionDetails
managedResourceGroupName 工作区托管资源组。 资源组名称唯一标识用户 subscriptionId 中的资源组。 资源组名称长度不得超过 90 个字符，并且必须是字母数字字符（Char.IsLetterOrDigit（）和“-”、“_”、“（”、“）”和“。。 请注意，名称不能以“.”结尾。 字符串
managedVirtualNetwork 将此工作区设置为“default”可确保此工作区的所有计算都代表用户托管在虚拟网络中。 字符串
managedVirtualNetworkSettings 托管虚拟网络设置 ManagedVirtualNetworkSettings
privateEndpointConnections 与工作区的专用终结点连接 PrivateEndpointConnection[]
publicNetworkAccess 启用或禁用对工作区的公共网络访问 “Disabled”
“Enabled”
purviewConfiguration Purview 配置 PurviewConfiguration
sqlAdministratorLogin 工作区 SQL Active Directory 管理员登录 字符串
sqlAdministratorLoginPassword SQL 管理员登录密码 字符串
trustedServiceBypassEnabled 工作区的 trustedServiceBypassEnabled bool
virtualNetworkProfile 虚拟网络配置文件 VirtualNetworkProfile
workspaceRepositoryConfiguration Git 集成设置 WorkspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

名字 描述 价值
accountName 帐户名称 字符串
collaborationBranch 协作分支 字符串
hostName GitHub Enterprise 主机名。 例如：https://github.mydomain.com 字符串
lastCommitId 上次提交 ID 字符串
projectName VSTS 项目名称 字符串
repositoryName 存储库名称 字符串
rootFolder 要用于存储库的根文件夹 字符串
tenantId VSTS 租户 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
类型 工作区 repositoryID 配置的类型。 示例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration 字符串

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2021-06-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

CspWorkspaceAdminProperties

名字 描述 价值
initialWorkspaceAdminObjectId 初始工作区管理员的 AAD 对象 ID 字符串

CustomerManagedKeyDetails

名字 描述 价值
kekIdentity 密钥加密密钥 KekIdentityProperties
钥匙 工作区的键对象 WorkspaceKeyDetails

DataLakeStorageAccountDetails

名字 描述 价值
accountUrl 帐户 URL 字符串
createManagedPrivateEndpoint 创建此存储帐户的托管专用终结点 bool
filesystem 文件系统名称 字符串
resourceId 此存储帐户的 ARM 资源 ID 字符串

EncryptionDetails

名字 描述 价值
cmk 客户管理的密钥详细信息 CustomerManagedKeyDetails

KekIdentityProperties

名字 描述 价值
userAssignedIdentity 用户分配的标识资源 ID 字符串
useSystemAssignedIdentity 指定是否使用系统分配标识的布尔值 任何

ManagedIdentity

名字 描述 价值
类型 工作区的托管标识类型 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
userAssignedIdentities 用户分配的托管标识。 UserAssignedManagedIdentities

ManagedVirtualNetworkSettings

名字 描述 价值
allowedAadTenantIdsForLinking 允许链接的 Aad 租户 ID string[]
linkedAccessCheckOnTargetResource 目标资源上的链接访问检查 bool
preventDataExfiltration 防止数据外泄 bool

Microsoft.Synapse/workspaces

名字 描述 价值
apiVersion API 版本 '2021-06-01'
身份 工作区的标识 ManagedIdentity
位置 资源所在的地理位置 string （必需）
名字 资源名称 string （必需）
性能 工作区资源属性 WorkspaceProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Synapse/workspaces”

PrivateEndpoint

名字 描述 价值

PrivateEndpointConnection

名字 描述 价值
性能 专用终结点连接属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字 描述 价值
privateEndpoint 连接所属的专用终结点。 PrivateEndpoint
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

名字 描述 价值
描述 专用链接服务连接说明。 字符串
地位 专用链接服务连接状态。 字符串

PurviewConfiguration

名字 描述 价值
purviewResourceId Purview 资源 ID 字符串

TrackedResourceTags

名字 描述 价值

UserAssignedManagedIdentities

名字 描述 价值

UserAssignedManagedIdentity

名字 描述 价值

VirtualNetworkProfile

名字 描述 价值
computeSubnetId 用于工作区中计算的子网 ID 字符串

WorkspaceKeyDetails

名字 描述 价值
keyVaultUrl 工作区密钥子资源密钥保管库 URL 字符串
名字 工作区密钥子资源名称 字符串

WorkspaceProperties

名字 描述 价值
azureADOnlyAuthentication 在所有工作区子资源上启用或禁用 AzureADOnlyAuthentication bool
cspWorkspaceAdminProperties CSP 订阅的初始工作区 AAD 管理员属性 CspWorkspaceAdminProperties
defaultDataLakeStorage 工作区默认 Data Lake 存储帐户详细信息 DataLakeStorageAccountDetails
加密 工作区的加密详细信息 EncryptionDetails
managedResourceGroupName 工作区托管资源组。 资源组名称唯一标识用户 subscriptionId 中的资源组。 资源组名称长度不得超过 90 个字符，并且必须是字母数字字符（Char.IsLetterOrDigit（）和“-”、“_”、“（”、“）”和“。。 请注意，名称不能以“.”结尾。 字符串
managedVirtualNetwork 将此工作区设置为“default”可确保此工作区的所有计算都代表用户托管在虚拟网络中。 字符串
managedVirtualNetworkSettings 托管虚拟网络设置 ManagedVirtualNetworkSettings
privateEndpointConnections 与工作区的专用终结点连接 PrivateEndpointConnection[]
publicNetworkAccess 启用或禁用对工作区的公共网络访问 “Disabled”
“Enabled”
purviewConfiguration Purview 配置 PurviewConfiguration
sqlAdministratorLogin 工作区 SQL Active Directory 管理员登录 字符串
sqlAdministratorLoginPassword SQL 管理员登录密码 字符串
trustedServiceBypassEnabled 工作区的 trustedServiceBypassEnabled bool
virtualNetworkProfile 虚拟网络配置文件 VirtualNetworkProfile
workspaceRepositoryConfiguration Git 集成设置 WorkspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

名字 描述 价值
accountName 帐户名称 字符串
collaborationBranch 协作分支 字符串
hostName GitHub Enterprise 主机名。 例如：https://github.mydomain.com 字符串
lastCommitId 上次提交 ID 字符串
projectName VSTS 项目名称 字符串
repositoryName 存储库名称 字符串
rootFolder 要用于存储库的根文件夹 字符串
tenantId VSTS 租户 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
类型 工作区 repositoryID 配置的类型。 示例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration 字符串

快速入门模板

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

模板 描述
Azure Synapse 概念证明

部署到 Azure 		此模板为 Azure Synapse 创建概念证明环境，包括 SQL 池和可选的 Apache Spark 池

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2021-06-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    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"
      }
    }
  })
}

属性值

CspWorkspaceAdminProperties

名字 描述 价值
initialWorkspaceAdminObjectId 初始工作区管理员的 AAD 对象 ID 字符串

CustomerManagedKeyDetails

名字 描述 价值
kekIdentity 密钥加密密钥 KekIdentityProperties
钥匙 工作区的键对象 WorkspaceKeyDetails

DataLakeStorageAccountDetails

名字 描述 价值
accountUrl 帐户 URL 字符串
createManagedPrivateEndpoint 创建此存储帐户的托管专用终结点 bool
filesystem 文件系统名称 字符串
resourceId 此存储帐户的 ARM 资源 ID 字符串

EncryptionDetails

名字 描述 价值
cmk 客户管理的密钥详细信息 CustomerManagedKeyDetails

KekIdentityProperties

名字 描述 价值
userAssignedIdentity 用户分配的标识资源 ID 字符串
useSystemAssignedIdentity 指定是否使用系统分配标识的布尔值 任何

ManagedIdentity

名字 描述 价值
类型 工作区的托管标识类型 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
userAssignedIdentities 用户分配的托管标识。 UserAssignedManagedIdentities

ManagedVirtualNetworkSettings

名字 描述 价值
allowedAadTenantIdsForLinking 允许链接的 Aad 租户 ID string[]
linkedAccessCheckOnTargetResource 目标资源上的链接访问检查 bool
preventDataExfiltration 防止数据外泄 bool

Microsoft.Synapse/workspaces

名字 描述 价值
身份 工作区的标识 ManagedIdentity
位置 资源所在的地理位置 string （必需）
名字 资源名称 string （必需）
性能 工作区资源属性 WorkspaceProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Synapse/workspaces@2021-06-01”

PrivateEndpoint

名字 描述 价值

PrivateEndpointConnection

名字 描述 价值
性能 专用终结点连接属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字 描述 价值
privateEndpoint 连接所属的专用终结点。 PrivateEndpoint
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

名字 描述 价值
描述 专用链接服务连接说明。 字符串
地位 专用链接服务连接状态。 字符串

PurviewConfiguration

名字 描述 价值
purviewResourceId Purview 资源 ID 字符串

TrackedResourceTags

名字 描述 价值

UserAssignedManagedIdentities

名字 描述 价值

UserAssignedManagedIdentity

名字 描述 价值

VirtualNetworkProfile

名字 描述 价值
computeSubnetId 用于工作区中计算的子网 ID 字符串

WorkspaceKeyDetails

名字 描述 价值
keyVaultUrl 工作区密钥子资源密钥保管库 URL 字符串
名字 工作区密钥子资源名称 字符串

WorkspaceProperties

名字 描述 价值
azureADOnlyAuthentication 在所有工作区子资源上启用或禁用 AzureADOnlyAuthentication bool
cspWorkspaceAdminProperties CSP 订阅的初始工作区 AAD 管理员属性 CspWorkspaceAdminProperties
defaultDataLakeStorage 工作区默认 Data Lake 存储帐户详细信息 DataLakeStorageAccountDetails
加密 工作区的加密详细信息 EncryptionDetails
managedResourceGroupName 工作区托管资源组。 资源组名称唯一标识用户 subscriptionId 中的资源组。 资源组名称长度不得超过 90 个字符，并且必须是字母数字字符（Char.IsLetterOrDigit（）和“-”、“_”、“（”、“）”和“。。 请注意，名称不能以“.”结尾。 字符串
managedVirtualNetwork 将此工作区设置为“default”可确保此工作区的所有计算都代表用户托管在虚拟网络中。 字符串
managedVirtualNetworkSettings 托管虚拟网络设置 ManagedVirtualNetworkSettings
privateEndpointConnections 与工作区的专用终结点连接 PrivateEndpointConnection[]
publicNetworkAccess 启用或禁用对工作区的公共网络访问 “Disabled”
“Enabled”
purviewConfiguration Purview 配置 PurviewConfiguration
sqlAdministratorLogin 工作区 SQL Active Directory 管理员登录 字符串
sqlAdministratorLoginPassword SQL 管理员登录密码 字符串
trustedServiceBypassEnabled 工作区的 trustedServiceBypassEnabled bool
virtualNetworkProfile 虚拟网络配置文件 VirtualNetworkProfile
workspaceRepositoryConfiguration Git 集成设置 WorkspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

名字 描述 价值
accountName 帐户名称 字符串
collaborationBranch 协作分支 字符串
hostName GitHub Enterprise 主机名。 例如：https://github.mydomain.com 字符串
lastCommitId 上次提交 ID 字符串
projectName VSTS 项目名称 字符串
repositoryName 存储库名称 字符串
rootFolder 要用于存储库的根文件夹 字符串
tenantId VSTS 租户 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
类型 工作区 repositoryID 配置的类型。 示例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration 字符串