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 資源所在的地理位置 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
身分識別 工作區的身分識別 ManagedIdentity
properties 工作區資源屬性 WorkspaceProperties

ManagedIdentity

名稱 描述
類型 工作區的受控識別類型 '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' 可確保此工作區的所有計算都位於代表使用者管理的虛擬網路中。 string
managedVirtualNetworkSettings 受控虛擬網路設定 ManagedVirtualNetworkSettings
privateEndpointConnections 工作區的私人端點連線 PrivateEndpointConnection[]
publicNetworkAccess 啟用或停用工作區的公用網路存取 'Disabled'
'Enabled'
purviewConfiguration Purview 組態 PurviewConfiguration
sqlAdministratorLogin 工作區 SQL Active Directory 系統管理員的登入 string
sqlAdministratorLoginPassword SQL 系統管理員登入密碼 string
trustedServiceBypassEnabled 為工作區的 trustedServiceBypassEnabled bool
virtualNetworkProfile 虛擬網路設定檔 VirtualNetworkProfile
workspaceRepositoryConfiguration Git 整合設定 WorkspaceRepositoryConfiguration

CspWorkspaceAdminProperties

名稱 描述
initialWorkspaceAdminObjectId 初始工作區管理員的 AAD 物件識別碼 string

DataLakeStorageAccountDetails

名稱 描述
accountUrl 帳戶 URL string
createManagedPrivateEndpoint 建立此儲存體帳戶的受控私人端點 bool
filesystem 檔案系統名稱 string
resourceId 此儲存體帳戶的 ARM 資源識別碼 string

EncryptionDetails

名稱 描述
cmk 客戶管理的金鑰詳細資料 CustomerManagedKeyDetails

CustomerManagedKeyDetails

名稱 描述
kekIdentity 金鑰加密金鑰 KekIdentityProperties
索引鍵 工作區的索引鍵物件 WorkspaceKeyDetails

KekIdentityProperties

名稱 描述
userAssignedIdentity 使用者指派的身分識別資源識別碼 string
useSystemAssignedIdentity 布林值,指定是否要使用系統指派的身分識別 針對 Bicep,您可以使用 any () 函式。

WorkspaceKeyDetails

名稱 描述
keyVaultUrl 工作區金鑰子資源金鑰保存庫 URL 字串
NAME 工作區金鑰子資源名稱 string

ManagedVirtualNetworkSettings

名稱 描述
allowedAadTenantIdsForLinking 允許連結的 Aad 租使用者識別碼 string[]
linkedAccessCheckOnTargetResource 目標資源的連結存取檢查 bool
preventDataExfiltration 防止資料外流 bool

PrivateEndpointConnection

名稱 描述
properties 私人端點連線屬性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名稱 描述
privateEndpoint 連線所屬的私人端點。 PrivateEndpoint
privateLinkServiceConnectionState 私人端點連線的連接狀態。 PrivateLinkServiceConnectionState

PrivateEndpoint

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

PrivateLinkServiceConnectionState

名稱 描述
description 私人連結服務連線描述。 string
status 私人連結服務線上狀態。 string

PurviewConfiguration

名稱 描述
purviewResourceId Purview 資源識別碼 string

VirtualNetworkProfile

名稱 描述
computeSubnetId 工作區中用於計算的子網識別碼 string

WorkspaceRepositoryConfiguration

名稱 描述
accountName 帳戶名稱 string
collaborationBranch 共同作業分支 string
hostName GitHub Enterprise 主機名稱。 例如:https://github.mydomain.com 字串
lastCommitId 最後一個認可識別碼 string
projectName VSTS 專案名稱 string
repositoryName 儲存機制名稱 string
rootFolder 存放庫中要使用的根資料夾 string
tenantId VSTS 租使用者識別碼 字串
type 工作區存放庫識別碼組態的類型。 範例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration string

快速入門範本

下列快速入門範本會部署此資源類型。

[範本] 描述
Azure Synapse概念證明

部署至 Azure
此範本會建立Azure Synapse的概念證明環境,包括 SQL 集區和選擇性的 Apache Spark 集區

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

名稱 描述
類型 資源類型 'Microsoft.Synapse/workspaces'
apiVersion 資源 API 版本 '2021-06-01'
NAME 資源名稱 字串 (必要)

字元限制:1-50

有效字元:
小寫字母、連字號和數字。

以字母或數字開頭及結尾。

不可包含 -ondemand

資源名稱在 Azure 中必須是唯一的。
location 資源所在的地理位置 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
身分識別 工作區的身分識別 ManagedIdentity
properties 工作區資源屬性 WorkspaceProperties

ManagedIdentity

名稱 描述
類型 工作區的受控識別類型 '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' 可確保此工作區的所有計算都位於代表使用者管理的虛擬網路中。 string
managedVirtualNetworkSettings 受控虛擬網路設定 ManagedVirtualNetworkSettings
privateEndpointConnections 工作區的私人端點連線 PrivateEndpointConnection[]
publicNetworkAccess 啟用或停用工作區的公用網路存取 'Disabled'
'Enabled'
purviewConfiguration Purview 組態 PurviewConfiguration
sqlAdministratorLogin 工作區 SQL Active Directory 系統管理員的登入 string
sqlAdministratorLoginPassword SQL 系統管理員登入密碼 string
trustedServiceBypassEnabled 為工作區的 trustedServiceBypassEnabled bool
virtualNetworkProfile 虛擬網路設定檔 VirtualNetworkProfile
workspaceRepositoryConfiguration Git 整合設定 WorkspaceRepositoryConfiguration

CspWorkspaceAdminProperties

名稱 描述
initialWorkspaceAdminObjectId 初始工作區管理員的 AAD 物件識別碼 string

DataLakeStorageAccountDetails

名稱 描述
accountUrl 帳戶 URL string
createManagedPrivateEndpoint 建立此儲存體帳戶的受控私人端點 bool
filesystem 檔案系統名稱 string
resourceId 此儲存體帳戶的 ARM 資源識別碼 string

EncryptionDetails

名稱 描述
cmk 客戶管理的金鑰詳細資料 CustomerManagedKeyDetails

CustomerManagedKeyDetails

名稱 描述
kekIdentity 金鑰加密金鑰 KekIdentityProperties
索引鍵 工作區的索引鍵物件 WorkspaceKeyDetails

KekIdentityProperties

名稱 描述
userAssignedIdentity 使用者指派的身分識別資源識別碼 string
useSystemAssignedIdentity 布林值,指定是否要使用系統指派的身分識別

WorkspaceKeyDetails

名稱 描述
keyVaultUrl 工作區金鑰子資源金鑰保存庫 URL 字串
NAME 工作區金鑰子資源名稱 string

ManagedVirtualNetworkSettings

名稱 描述
allowedAadTenantIdsForLinking 允許連結的 Aad 租使用者識別碼 string[]
linkedAccessCheckOnTargetResource 目標資源的連結存取檢查 bool
preventDataExfiltration 防止資料外流 bool

PrivateEndpointConnection

名稱 描述
properties 私人端點連線屬性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名稱 描述
privateEndpoint 連線所屬的私人端點。 PrivateEndpoint
privateLinkServiceConnectionState 私人端點連線的連接狀態。 PrivateLinkServiceConnectionState

PrivateEndpoint

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

PrivateLinkServiceConnectionState

名稱 描述
description 私人連結服務連線描述。 string
status 私人連結服務線上狀態。 string

PurviewConfiguration

名稱 描述
purviewResourceId Purview 資源識別碼 string

VirtualNetworkProfile

名稱 描述
computeSubnetId 工作區中用於計算的子網識別碼 string

WorkspaceRepositoryConfiguration

名稱 描述
accountName 帳戶名稱 string
collaborationBranch 共同作業分支 string
hostName GitHub Enterprise 主機名稱。 例如:https://github.mydomain.com 字串
lastCommitId 最後一個認可識別碼 string
projectName VSTS 專案名稱 string
repositoryName 儲存機制名稱 string
rootFolder 存放庫中要使用的根資料夾 string
tenantId VSTS 租使用者識別碼 字串
type 工作區存放庫識別碼組態的類型。 範例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration string

快速入門範本

下列快速入門範本會部署此資源類型。

[範本] 描述
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"
  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

名稱 描述
類型 資源類型 「Microsoft.Synapse/workspaces@2021-06-01」
NAME 資源名稱 需要字串 ()

字元限制:1-50

有效字元:
小寫字母、連字號和數字。

以字母或數字開頭及結尾。

不可包含 -ondemand

資源名稱在整個 Azure 中必須是唯一的。
location 資源所在的地理位置 需要字串 ()
parent_id 若要部署至資源群組,請使用該資源群組的識別碼。 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。
身分識別 工作區的身分識別 ManagedIdentity
properties 工作區資源屬性 WorkspaceProperties

ManagedIdentity

名稱 描述
類型 工作區的受控識別類型 「SystemAssigned」
「SystemAssigned,UserAssigned」
identity_ids 使用者指派的受控識別。 使用者身分識別識別碼的陣列。

WorkspaceProperties

名稱 描述
azureADOnlyAuthentication 在所有工作區子資源上啟用或停用 AzureADOnlyAuthentication bool
cspWorkspaceAdminProperties CSP 訂用帳戶的初始工作區 AAD 管理員屬性 CspWorkspaceAdminProperties
defaultDataLakeStorage 工作區預設 Data Lake 儲存體帳戶詳細資料 DataLakeStorageAccountDetails
加密 工作區的加密詳細資料 EncryptionDetails
managedResourceGroupName 工作區受控資源群組。 資源組名可唯一識別使用者 subscriptionId 內的資源群組。 資源組名長度不能超過 90 個字元,而且必須是英數位元, (Char.IsLetterOrDigit () ) 和 '-'、'_'、' ('、') ' 和'.'。 請注意,名稱結尾不能是 '.' string
managedVirtualNetwork 將此設定為 'default' 可確保此工作區的所有計算都位於代表使用者管理的虛擬網路中。 string
managedVirtualNetworkSettings 受控虛擬網路設定 ManagedVirtualNetworkSettings
privateEndpointConnections 工作區的私人端點連線 PrivateEndpointConnection[]
publicNetworkAccess 啟用或停用工作區的公用網路存取 「Disabled」
「Enabled」
purviewConfiguration Purview 組態 PurviewConfiguration
sqlAdministratorLogin 工作區 SQL Active Directory 系統管理員的登入 string
sqlAdministratorLoginPassword SQL 系統管理員登入密碼 string
trustedServiceBypassEnabled 為工作區的 trustedServiceBypassEnabled bool
virtualNetworkProfile 虛擬網路設定檔 VirtualNetworkProfile
workspaceRepositoryConfiguration Git 整合設定 WorkspaceRepositoryConfiguration

CspWorkspaceAdminProperties

名稱 描述
initialWorkspaceAdminObjectId 初始工作區管理員的 AAD 物件識別碼 string

DataLakeStorageAccountDetails

名稱 描述
accountUrl 帳戶 URL string
createManagedPrivateEndpoint 建立此儲存體帳戶的受控私人端點 bool
filesystem 檔案系統名稱 string
resourceId 此儲存體帳戶的 ARM 資源識別碼 string

EncryptionDetails

名稱 描述
cmk 客戶管理的金鑰詳細資料 CustomerManagedKeyDetails

CustomerManagedKeyDetails

名稱 描述
kekIdentity 金鑰加密金鑰 KekIdentityProperties
索引鍵 工作區的索引鍵物件 WorkspaceKeyDetails

KekIdentityProperties

名稱 描述
userAssignedIdentity 使用者指派的身分識別資源識別碼 string
useSystemAssignedIdentity 布林值,指定是否要使用系統指派的身分識別

WorkspaceKeyDetails

名稱 描述
keyVaultUrl 工作區金鑰子資源金鑰保存庫 URL 字串
NAME 工作區金鑰子資源名稱 string

ManagedVirtualNetworkSettings

名稱 描述
allowedAadTenantIdsForLinking 允許連結的 Aad 租使用者識別碼 string[]
linkedAccessCheckOnTargetResource 目標資源的連結存取檢查 bool
preventDataExfiltration 防止資料外泄 bool

PrivateEndpointConnection

名稱 描述
properties 私人端點連線屬性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名稱 描述
privateEndpoint 連線所屬的私人端點。 PrivateEndpoint
privateLinkServiceConnectionState 私人端點連線的連接狀態。 PrivateLinkServiceConnectionState

PrivateEndpoint

此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。

PrivateLinkServiceConnectionState

名稱 描述
description 私人連結服務連線描述。 string
status 私人連結服務線上狀態。 string

PurviewConfiguration

名稱 描述
purviewResourceId Purview 資源識別碼 string

VirtualNetworkProfile

名稱 描述
computeSubnetId 工作區中用於計算的子網識別碼 string

WorkspaceRepositoryConfiguration

名稱 描述
accountName 帳戶名稱 string
collaborationBranch 共同作業分支 string
hostName GitHub Enterprise 主機名稱。 例如:https://github.mydomain.com 字串
lastCommitId 最後一個認可識別碼 string
projectName VSTS 專案名稱 string
repositoryName 儲存機制名稱 string
rootFolder 存放庫中要使用的根資料夾 string
tenantId VSTS 租使用者識別碼 字串
type 工作區存放庫識別碼組態的類型。 範例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration string