Microsoft.Synapse 工作區 2021-05-01
Bicep 資源定義
工作區資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.Synapse/workspaces 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.Synapse/workspaces@2021-05-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
connectivityEndpoints: {}
cspWorkspaceAdminProperties: {
initialWorkspaceAdminObjectId: 'string'
}
defaultDataLakeStorage: {
accountUrl: 'string'
filesystem: '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'
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
CspWorkspaceAdminProperties
| 名稱 |
描述 |
值 |
| initialWorkspaceAdminObjectId |
初始工作區管理員的 AAD 物件識別碼 |
string |
DataLakeStorageAccountDetails
| 名稱 |
描述 |
值 |
| accountUrl |
帳戶 URL |
string |
| filesystem |
檔案系統名稱 |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
| 名稱 |
描述 |
值 |
| userAssignedIdentity |
使用者指派的身分識別資源識別碼 |
string |
| useSystemAssignedIdentity |
布林值，指定是否要使用系統指派的身分識別 |
針對 Bicep，您可以使用 any () 函式。 |
WorkspaceKeyDetails
| 名稱 |
描述 |
值 |
| keyVaultUrl |
工作區金鑰子資源金鑰保存庫 URL |
字串 |
| NAME |
工作區金鑰子資源名稱 |
string |
ManagedVirtualNetworkSettings
| 名稱 |
描述 |
值 |
| allowedAadTenantIdsForLinking |
允許連結的 Aad 租使用者識別碼 |
string[] |
| linkedAccessCheckOnTargetResource |
目標資源的連結存取檢查 |
bool |
| preventDataExfiltration |
防止資料外泄 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
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 Synapse的概念證明環境，包括 SQL 集區和選擇性 Apache Spark 集區 |
ARM 範本資源定義
工作區資源類型可以使用目標作業進行部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立 Microsoft.Synapse/workspaces 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Synapse/workspaces",
"apiVersion": "2021-05-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"connectivityEndpoints": {},
"cspWorkspaceAdminProperties": {
"initialWorkspaceAdminObjectId": "string"
},
"defaultDataLakeStorage": {
"accountUrl": "string",
"filesystem": "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",
"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-05-01' |
| NAME |
資源名稱 |
需要字串 ()
字元限制：1-50
有效字元：
小寫字母、連字號和數字。
以字母或數字開頭及結尾。
不可包含 -ondemand
資源名稱在整個 Azure 中必須是唯一的。 |
| location |
資源所在的地理位置 |
需要字串 () |
| tags |
資源標籤。 |
標記名稱和值的字典。 請參閱 範本中的標籤 |
|
身分識別
|
工作區的身分識別 |
ManagedIdentity |
| properties |
工作區資源屬性 |
WorkspaceProperties |
ManagedIdentity
| 名稱 |
描述 |
值 |
| 類型 |
工作區的受控識別類型 |
'None'
'SystemAssigned'
'SystemAssigned，UserAssigned' |
| userAssignedIdentities |
使用者指派的受控識別。 |
object |
WorkspaceProperties
CspWorkspaceAdminProperties
| 名稱 |
描述 |
值 |
| initialWorkspaceAdminObjectId |
初始工作區管理員的 AAD 物件識別碼 |
string |
DataLakeStorageAccountDetails
| 名稱 |
描述 |
值 |
| accountUrl |
帳戶 URL |
string |
| filesystem |
檔案系統名稱 |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
| 名稱 |
描述 |
值 |
| userAssignedIdentity |
使用者指派的身分識別資源識別碼 |
string |
| useSystemAssignedIdentity |
布林值，指定是否要使用系統指派的身分識別 |
|
WorkspaceKeyDetails
| 名稱 |
描述 |
值 |
| keyVaultUrl |
工作區金鑰子資源金鑰保存庫 URL |
字串 |
| NAME |
工作區金鑰子資源名稱 |
string |
ManagedVirtualNetworkSettings
| 名稱 |
描述 |
值 |
| allowedAadTenantIdsForLinking |
允許連結的 Aad 租使用者識別碼 |
string[] |
| linkedAccessCheckOnTargetResource |
目標資源的連結存取檢查 |
bool |
| preventDataExfiltration |
防止資料外流 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
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 |
快速入門範本
下列快速入門範本會部署此資源類型。
工作區資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.Synapse/workspaces 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces@2021-05-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
connectivityEndpoints = {}
cspWorkspaceAdminProperties = {
initialWorkspaceAdminObjectId = "string"
}
defaultDataLakeStorage = {
accountUrl = "string"
filesystem = "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"
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-05-01」 |
| NAME |
資源名稱 |
字串 (必要)
字元限制：1-50
有效字元：
小寫字母、連字號和數字。
以字母或數字開頭及結尾。
不可包含 -ondemand
資源名稱在 Azure 中必須是唯一的。 |
| location |
資源所在的地理位置 |
字串 (必要) |
| parent_id |
若要部署至資源群組，請使用該資源群組的識別碼。 |
字串 (必要) |
| tags |
資源標籤。 |
標記名稱和值的字典。 |
|
身分識別
|
工作區的身分識別 |
ManagedIdentity |
| properties |
工作區資源屬性 |
WorkspaceProperties |
ManagedIdentity
| 名稱 |
描述 |
值 |
| 類型 |
工作區的受控識別類型 |
「SystemAssigned」
「SystemAssigned，UserAssigned」 |
| identity_ids |
使用者指派的受控識別。 |
使用者身分識別識別碼的陣列。 |
WorkspaceProperties
CspWorkspaceAdminProperties
| 名稱 |
描述 |
值 |
| initialWorkspaceAdminObjectId |
初始工作區管理員的 AAD 物件識別碼 |
string |
DataLakeStorageAccountDetails
| 名稱 |
描述 |
值 |
| accountUrl |
帳戶 URL |
string |
| filesystem |
檔案系統名稱 |
string |
EncryptionDetails
CustomerManagedKeyDetails
KekIdentityProperties
| 名稱 |
描述 |
值 |
| userAssignedIdentity |
使用者指派的身分識別資源識別碼 |
string |
| useSystemAssignedIdentity |
布林值，指定是否要使用系統指派的身分識別 |
|
WorkspaceKeyDetails
| 名稱 |
描述 |
值 |
| keyVaultUrl |
工作區金鑰子資源金鑰保存庫 URL |
字串 |
| NAME |
工作區金鑰子資源名稱 |
string |
ManagedVirtualNetworkSettings
| 名稱 |
描述 |
值 |
| allowedAadTenantIdsForLinking |
允許連結的 Aad 租使用者識別碼 |
string[] |
| linkedAccessCheckOnTargetResource |
目標資源的連結存取檢查 |
bool |
| preventDataExfiltration |
防止資料外泄 |
bool |
PrivateEndpointConnection
PrivateEndpointConnectionProperties
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 |