共用方式為

Microsoft.Synapse 工作區 2021-06-01

  • 發行項

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 物件識別碼 字串

CustomerManagedKeyDetails

名字 描述 價值
kekIdentity 金鑰加密金鑰 KekIdentityProperties
鑰匙 工作區的索引鍵物件 WorkspaceKeyDetails

DataLakeStorageAccountDetails

名字 描述 價值
accountUrl 帳戶 URL 字串
createManagedPrivateEndpoint 建立此記憶體帳戶的受控私人端點 bool
filesystem 檔案系統名稱 字串
resourceId 此記憶體帳戶的 ARM 資源識別碼 字串

EncryptionDetails

名字 描述 價值
cmk 客戶管理的金鑰詳細數據 CustomerManagedKeyDetails

KekIdentityProperties

名字 描述 價值
userAssignedIdentity 使用者指派的身分識別資源標識碼 字串
useSystemAssignedIdentity 布爾值，指定是否要使用系統指派的身分識別 任何

ManagedIdentity

名字 描述 價值
類型 工作區的受控識別類型 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
userAssignedIdentities 使用者指派的受控識別。 UserAssignedManagedIdentities

ManagedVirtualNetworkSettings

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

Microsoft.Synapse/workspaces

名字 描述 價值
身份 工作區的身分識別 ManagedIdentity
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串 （必要）
性能 工作區資源屬性 WorkspaceProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

PrivateEndpoint

名字 描述 價值

PrivateEndpointConnection

名字 描述 價值
性能 私人端點連線屬性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

名字 描述 價值
描述 私人鏈接服務連線描述。 字串
地位 私人鏈接服務連線狀態。 字串

PurviewConfiguration

名字 描述 價值
purviewResourceId Purview 資源標識碼 字串

TrackedResourceTags

名字 描述 價值

UserAssignedManagedIdentities

名字 描述 價值

UserAssignedManagedIdentity

名字 描述 價值

VirtualNetworkProfile

名字 描述 價值
computeSubnetId 工作區中用於計算的子網標識碼 字串

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 最後一個認可標識碼 字串
projectName VSTS 項目名稱 字串
repositoryName 存放庫名稱 字串
rootFolder 存放庫中要使用的根資料夾 字串
tenantId VSTS 租使用者標識碼 字串

約束：
最小長度 = 36
最大長度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
類型 工作區存放庫標識碼組態的類型。 範例 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 物件識別碼 字串

CustomerManagedKeyDetails

名字 描述 價值
kekIdentity 金鑰加密金鑰 KekIdentityProperties
鑰匙 工作區的索引鍵物件 WorkspaceKeyDetails

DataLakeStorageAccountDetails

名字 描述 價值
accountUrl 帳戶 URL 字串
createManagedPrivateEndpoint 建立此記憶體帳戶的受控私人端點 bool
filesystem 檔案系統名稱 字串
resourceId 此記憶體帳戶的 ARM 資源識別碼 字串

EncryptionDetails

名字 描述 價值
cmk 客戶管理的金鑰詳細數據 CustomerManagedKeyDetails

KekIdentityProperties

名字 描述 價值
userAssignedIdentity 使用者指派的身分識別資源標識碼 字串
useSystemAssignedIdentity 布爾值，指定是否要使用系統指派的身分識別 任何

ManagedIdentity

名字 描述 價值
類型 工作區的受控識別類型 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
userAssignedIdentities 使用者指派的受控識別。 UserAssignedManagedIdentities

ManagedVirtualNetworkSettings

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

Microsoft.Synapse/workspaces

名字 描述 價值
apiVersion API 版本 '2021-06-01'
身份 工作區的身分識別 ManagedIdentity
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串 （必要）
性能 工作區資源屬性 WorkspaceProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.Synapse/workspaces'

PrivateEndpoint

名字 描述 價值

PrivateEndpointConnection

名字 描述 價值
性能 私人端點連線屬性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

名字 描述 價值
描述 私人鏈接服務連線描述。 字串
地位 私人鏈接服務連線狀態。 字串

PurviewConfiguration

名字 描述 價值
purviewResourceId Purview 資源標識碼 字串

TrackedResourceTags

名字 描述 價值

UserAssignedManagedIdentities

名字 描述 價值

UserAssignedManagedIdentity

名字 描述 價值

VirtualNetworkProfile

名字 描述 價值
computeSubnetId 工作區中用於計算的子網標識碼 字串

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 最後一個認可標識碼 字串
projectName VSTS 項目名稱 字串
repositoryName 存放庫名稱 字串
rootFolder 存放庫中要使用的根資料夾 字串
tenantId VSTS 租使用者標識碼 字串

約束：
最小長度 = 36
最大長度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
類型 工作區存放庫標識碼組態的類型。 範例 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 物件識別碼 字串

CustomerManagedKeyDetails

名字 描述 價值
kekIdentity 金鑰加密金鑰 KekIdentityProperties
鑰匙 工作區的索引鍵物件 WorkspaceKeyDetails

DataLakeStorageAccountDetails

名字 描述 價值
accountUrl 帳戶 URL 字串
createManagedPrivateEndpoint 建立此記憶體帳戶的受控私人端點 bool
filesystem 檔案系統名稱 字串
resourceId 此記憶體帳戶的 ARM 資源識別碼 字串

EncryptionDetails

名字 描述 價值
cmk 客戶管理的金鑰詳細數據 CustomerManagedKeyDetails

KekIdentityProperties

名字 描述 價值
userAssignedIdentity 使用者指派的身分識別資源標識碼 字串
useSystemAssignedIdentity 布爾值，指定是否要使用系統指派的身分識別 任何

ManagedIdentity

名字 描述 價值
類型 工作區的受控識別類型 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
userAssignedIdentities 使用者指派的受控識別。 UserAssignedManagedIdentities

ManagedVirtualNetworkSettings

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

Microsoft.Synapse/workspaces

名字 描述 價值
身份 工作區的身分識別 ManagedIdentity
位置 資源所在的地理位置 字串 （必要）
名字 資源名稱 字串 （必要）
性能 工作區資源屬性 WorkspaceProperties
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.Synapse/workspaces@2021-06-01”

PrivateEndpoint

名字 描述 價值

PrivateEndpointConnection

名字 描述 價值
性能 私人端點連線屬性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

名字 描述 價值
描述 私人鏈接服務連線描述。 字串
地位 私人鏈接服務連線狀態。 字串

PurviewConfiguration

名字 描述 價值
purviewResourceId Purview 資源標識碼 字串

TrackedResourceTags

名字 描述 價值

UserAssignedManagedIdentities

名字 描述 價值

UserAssignedManagedIdentity

名字 描述 價值

VirtualNetworkProfile

名字 描述 價值
computeSubnetId 工作區中用於計算的子網標識碼 字串

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 最後一個認可標識碼 字串
projectName VSTS 項目名稱 字串
repositoryName 存放庫名稱 字串
rootFolder 存放庫中要使用的根資料夾 字串
tenantId VSTS 租使用者標識碼 字串

約束：
最小長度 = 36
最大長度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
類型 工作區存放庫標識碼組態的類型。 範例 WorkspaceVSTSConfiguration、WorkspaceGitHubConfiguration 字串