Рабочие области Microsoft.Synapse 2020-12-01

Статья
07/01/2023

Определение ресурса Bicep

Тип ресурса workspaces можно развернуть с помощью операций, предназначенных для:

Группы ресурсов — см. команды развертывания групп ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Synapse/workspaces, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Synapse/workspaces@2020-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    connectivityEndpoints: {}
    defaultDataLakeStorage: {
      accountUrl: 'string'
      filesystem: 'string'
    }
    encryption: {
      cmk: {
        key: {
          keyVaultUrl: 'string'
          name: 'string'
        }
      }
    }
    managedResourceGroupName: 'string'
    managedVirtualNetwork: 'string'
    managedVirtualNetworkSettings: {
      allowedAadTenantIdsForLinking: [
        'string'
      ]
      linkedAccessCheckOnTargetResource: bool
      preventDataExfiltration: bool
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            description: 'string'
            status: '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	имя ресурса.	string (обязательно) Ограничение символов: 1-50 Допустимые символы: Строчные буквы, дефисы и цифры. Начинается и заканчивается буквой или цифрой. Не может содержать `-ondemand` Имя ресурса должно быть уникальным в Azure.
location	Географическое расположение, в котором находится ресурс	string (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение	Удостоверение рабочей области	ManagedIdentity
properties	Свойства ресурса рабочей области	Свойства рабочей области

ManagedIdentity

Имя	Описание	Значение
тип	Тип управляемого удостоверения для рабочей области	"Нет" SystemAssigned

Свойства рабочей области

Имя	Описание	Значение
connectivityEndpoints	Конечные точки подключения	object
defaultDataLakeStorage	Сведения об учетной записи хранения data lake data lake по умолчанию для рабочей области	DataLakeStorageAccountDetails
шифрование	Сведения о шифровании рабочей области	EncryptionDetails
managedResourceGroupName	Управляемая группа ресурсов рабочей области. Имя группы ресурсов однозначно идентифицирует группу ресурсов в идентификаторе подписки пользователя. Имя группы ресурсов должно содержать не более 90 символов и буквенно-цифровые символы (Char.IsLetterOrDigit()) и "-", "_", "(", ")" и ".". Обратите внимание, что имя не может заканчиваться на ".	строка
managedVirtualNetwork	Если задать для этого параметра значение по умолчанию, все вычислительные ресурсы для этой рабочей области будут находиться в виртуальной сети, управляемой от имени пользователя.	строка
managedVirtualNetworkSettings	Параметры управляемого виртуальная сеть	ManagedVirtualNetworkSettings
privateEndpointConnections	Подключения частной конечной точки к рабочей области	PrivateEndpointConnection[]
purviewConfiguration	Конфигурация Purview	PurviewConfiguration
sqlAdministratorLogin	Вход в рабочую область администратора Active Directory SQL	строка
sqlAdministratorLoginPassword	Пароль для входа администратора SQL	строка
virtualNetworkProfile	профиль виртуальная сеть	VirtualNetworkProfile
workspaceRepositoryConfiguration	Параметры интеграции Git	WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Имя	Описание	Значение
accountUrl	URL-адрес учетной записи	строка
filesystem	Имя файловой системы	строка

EncryptionDetails

Имя	Описание	Значение
Cmk	Сведения о ключе, управляемом клиентом	CustomerManagedKeyDetails

CustomerManagedKeyDetails

Имя	Описание	Значение
key	Ключевой объект рабочей области	WorkspaceKeyDetails

WorkspaceKeyDetails

Имя	Описание	Значение
keyVaultUrl	URL-адрес хранилища ключей подресурсов рабочей области	строка
name	Имя подресурса ключа рабочей области	строка

ManagedVirtualNetworkSettings

Имя	Описание	Значение
allowedAadTenantIdsForLinking	Разрешенные идентификаторы клиента Aad для связывания	string[]
linkedAccessCheckOnTargetResource	Проверка связанного доступа к целевому ресурсу	bool
preventDataExfiltration	Предотвращение кражи данных	bool

PrivateEndpointConnection

Имя	Описание	Значение
properties	Свойства подключения к частной конечной точке.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Имя	Описание	Значение
privateEndpoint	Частная конечная точка, к которой принадлежит подключение.	PrivateEndpoint
privateLinkServiceConnectionState	Состояние подключения к частной конечной точке.	PrivateLinkServiceConnectionState

PrivateEndpoint

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

PrivateLinkServiceConnectionState

Имя	Описание	Значение
description	Описание подключения к службе приватного канала.	строка
status	Состояние подключения службы приватного канала.	строка

PurviewConfiguration

Имя	Описание	Значение
purviewResourceId	Идентификатор ресурса Purview	строка

VirtualNetworkProfile

Имя	Описание	Значение
computeSubnetId	Идентификатор подсети, используемый для вычислений в рабочей области	строка

WorkspaceRepositoryConfiguration

Имя	Описание	Значение
accountName	Имя учетной записи	строка
collaborationBranch	Ветвь совместной работы	строка
hostName	Имя узла GitHub Enterprise. Например: `https://github.mydomain.com`	строка
lastCommitId	Последний ИД фиксации	строка
projectName	Имя проекта VSTS	строка
repositoryName	Имя репозитория	строка
rootFolder	Корневая папка для использования в репозитории	строка
tenantId	Идентификатор клиента VSTS	строка
type	Тип конфигурации репозитория рабочей области. Пример WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration	строка

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Azure Synapse подтверждение концепции	Этот шаблон создает среду подтверждения концепции для Azure Synapse, включая пулы SQL и необязательные пулы Apache Spark.

Определение ресурса шаблона ARM

Тип ресурса workspaces можно развернуть с помощью операций, предназначенных для:

Группы ресурсов — см. команды развертывания групп ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Synapse/workspaces, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "connectivityEndpoints": {},
    "defaultDataLakeStorage": {
      "accountUrl": "string",
      "filesystem": "string"
    },
    "encryption": {
      "cmk": {
        "key": {
          "keyVaultUrl": "string",
          "name": "string"
        }
      }
    },
    "managedResourceGroupName": "string",
    "managedVirtualNetwork": "string",
    "managedVirtualNetworkSettings": {
      "allowedAadTenantIdsForLinking": [ "string" ],
      "linkedAccessCheckOnTargetResource": "bool",
      "preventDataExfiltration": "bool"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "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
версия_API	Версия API ресурсов	'2020-12-01'
name	имя ресурса.	string (обязательно) Ограничение символов: 1-50 Допустимые символы: Строчные буквы, дефисы и цифры. Начинается и заканчивается буквой или цифрой. Не может содержать `-ondemand` Имя ресурса должно быть уникальным в Azure.
location	Географическое расположение, в котором находится ресурс	string (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение	Удостоверение рабочей области	ManagedIdentity
properties	Свойства ресурса рабочей области	Свойства рабочей области

ManagedIdentity

Имя	Описание	Значение
тип	Тип управляемого удостоверения для рабочей области	"Нет" SystemAssigned

Свойства рабочей области

Имя	Описание	Значение
connectivityEndpoints	Конечные точки подключения	object
defaultDataLakeStorage	Сведения об учетной записи хранения data lake data lake по умолчанию для рабочей области	DataLakeStorageAccountDetails
шифрование	Сведения о шифровании рабочей области	EncryptionDetails
managedResourceGroupName	Управляемая группа ресурсов рабочей области. Имя группы ресурсов однозначно идентифицирует группу ресурсов в идентификаторе подписки пользователя. Имя группы ресурсов должно содержать не более 90 символов и буквенно-цифровые символы (Char.IsLetterOrDigit()) и "-", "_", "(", ")" и ".". Обратите внимание, что имя не может заканчиваться на ".	строка
managedVirtualNetwork	Если задать для этого параметра значение по умолчанию, все вычислительные ресурсы для этой рабочей области будут находиться в виртуальной сети, управляемой от имени пользователя.	строка
managedVirtualNetworkSettings	Параметры управляемого виртуальная сеть	ManagedVirtualNetworkSettings
privateEndpointConnections	Подключения частной конечной точки к рабочей области	PrivateEndpointConnection[]
purviewConfiguration	Конфигурация Purview	PurviewConfiguration
sqlAdministratorLogin	Вход в рабочую область администратора Active Directory SQL	строка
sqlAdministratorLoginPassword	Пароль для входа администратора SQL	строка
virtualNetworkProfile	профиль виртуальная сеть	VirtualNetworkProfile
workspaceRepositoryConfiguration	Параметры интеграции Git	WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Имя	Описание	Значение
accountUrl	URL-адрес учетной записи	строка
filesystem	Имя файловой системы	строка

EncryptionDetails

Имя	Описание	Значение
Cmk	Сведения о ключе, управляемом клиентом	CustomerManagedKeyDetails

CustomerManagedKeyDetails

Имя	Описание	Значение
key	Ключевой объект рабочей области	WorkspaceKeyDetails

WorkspaceKeyDetails

Имя	Описание	Значение
keyVaultUrl	URL-адрес хранилища ключей подресурсов ключа рабочей области	строка
name	Имя подресурса ключа рабочей области	строка

ManagedVirtualNetworkSettings

Имя	Описание	Значение
allowedAadTenantIdsForLinking	Разрешенные идентификаторы клиента Aad для связывания	string[]
linkedAccessCheckOnTargetResource	Проверка связанного доступа на целевом ресурсе	bool
preventDataExfiltration	Предотвращение кражи данных	bool

PrivateEndpointConnection

Имя	Описание	Значение
properties	Свойства подключения к частной конечной точке.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Имя	Описание	Значение
privateEndpoint	Частная конечная точка, к которой принадлежит подключение.	PrivateEndpoint
privateLinkServiceConnectionState	Состояние подключения к частной конечной точке.	PrivateLinkServiceConnectionState

PrivateEndpoint

PrivateLinkServiceConnectionState

Имя	Описание	Значение
description	Описание подключения службы приватного канала.	строка
status	Состояние подключения службы приватного канала.	строка

PurviewConfiguration

Имя	Описание	Значение
purviewResourceId	Идентификатор ресурса Purview	строка

VirtualNetworkProfile

Имя	Описание	Значение
computeSubnetId	Идентификатор подсети, используемый для вычислений в рабочей области	строка

WorkspaceRepositoryConfiguration

Имя	Описание	Значение
accountName	Имя учетной записи	строка
collaborationBranch	Ветвь совместной работы	строка
hostName	Имя узла GitHub Enterprise. Например: `https://github.mydomain.com`	строка
lastCommitId	Последняя ИД фиксации	строка
projectName	Имя проекта VSTS	строка
repositoryName	Имя репозитория	строка
rootFolder	Корневая папка для использования в репозитории	строка
tenantId	Идентификатор клиента VSTS	строка
type	Тип конфигурации репозитория рабочей области. Пример WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration	строка

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Azure Synapse подтверждение концепции	Этот шаблон создает среду подтверждения концепции для Azure Synapse, включая пулы SQL и необязательные пулы Apache Spark.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса workspaces можно развернуть с помощью операций, предназначенных для:

Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Synapse/workspaces, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2020-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      connectivityEndpoints = {}
      defaultDataLakeStorage = {
        accountUrl = "string"
        filesystem = "string"
      }
      encryption = {
        cmk = {
          key = {
            keyVaultUrl = "string"
            name = "string"
          }
        }
      }
      managedResourceGroupName = "string"
      managedVirtualNetwork = "string"
      managedVirtualNetworkSettings = {
        allowedAadTenantIdsForLinking = [
          "string"
        ]
        linkedAccessCheckOnTargetResource = bool
        preventDataExfiltration = bool
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              description = "string"
              status = "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@2020-12-01"
name	имя ресурса.	строка (обязательно) Ограничение символов: 1–50 Допустимые символы: Строчные буквы, дефисы и цифры. Начинается и заканчивается буквой или цифрой. Не может содержать `-ondemand` Имя ресурса должно быть уникальным в Azure.
location	Географическое расположение, в котором находится ресурс	строка (обязательно)
parent_id	Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов.	строка (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов.
удостоверение	Удостоверение рабочей области	ManagedIdentity
properties	Свойства ресурса рабочей области	Свойства рабочей области

ManagedIdentity

Имя	Описание	Значение
тип	Тип управляемого удостоверения для рабочей области	"SystemAssigned"

Свойства рабочей области

Имя	Описание	Значение
connectivityEndpoints	Конечные точки подключения	object
defaultDataLakeStorage	Сведения об учетной записи хранения data lake по умолчанию для рабочей области	DataLakeStorageAccountDetails
шифрование	Сведения о шифровании рабочей области	EncryptionDetails
managedResourceGroupName	Управляемая группа ресурсов рабочей области. Имя группы ресурсов однозначно идентифицирует группу ресурсов в идентификаторе подписки пользователя. Имя группы ресурсов должно содержать не более 90 символов, а также буквенно-цифровые символы (Char.IsLetterOrDigit()) и "-", "_", "(", ")" и ".". Обратите внимание, что имя не может заканчиваться на "".	строка
managedVirtualNetwork	Если задать значение по умолчанию, все вычислительные ресурсы для этой рабочей области будут находиться в виртуальной сети, управляемой от имени пользователя.	строка
managedVirtualNetworkSettings	Параметры управляемого виртуальная сеть	ManagedVirtualNetworkSettings
privateEndpointConnections	Подключения частной конечной точки к рабочей области	PrivateEndpointConnection[]
purviewConfiguration	Конфигурация Purview	PurviewConfiguration
sqlAdministratorLogin	Вход для администратора SQL Active Directory рабочей области	строка
sqlAdministratorLoginPassword	Пароль для входа администратора SQL	строка
virtualNetworkProfile	профиль виртуальная сеть	VirtualNetworkProfile
workspaceRepositoryConfiguration	Параметры интеграции Git	WorkspaceRepositoryConfiguration

DataLakeStorageAccountDetails

Имя	Описание	Значение
accountUrl	URL-адрес учетной записи	строка
filesystem	Имя файловой системы	строка

EncryptionDetails

Имя	Описание	Значение
Cmk	Сведения о ключе, управляемом клиентом	CustomerManagedKeyDetails

CustomerManagedKeyDetails

Имя	Описание	Значение
key	Ключевой объект рабочей области	WorkspaceKeyDetails

WorkspaceKeyDetails

Имя	Описание	Значение
keyVaultUrl	URL-адрес хранилища ключей подресурсов рабочей области	строка
name	Имя подресурса ключа рабочей области	строка

ManagedVirtualNetworkSettings

Имя	Описание	Значение
allowedAadTenantIdsForLinking	Разрешенные идентификаторы клиента Aad для связывания	string[]
linkedAccessCheckOnTargetResource	Проверка связанного доступа к целевому ресурсу	bool
preventDataExfiltration	Предотвращение кражи данных	bool

PrivateEndpointConnection

Имя	Описание	Значение
properties	Свойства подключения к частной конечной точке.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Имя	Описание	Значение
privateEndpoint	Частная конечная точка, к которой принадлежит подключение.	PrivateEndpoint
privateLinkServiceConnectionState	Состояние подключения к частной конечной точке.	PrivateLinkServiceConnectionState

PrivateEndpoint

PrivateLinkServiceConnectionState

Имя	Описание	Значение
description	Описание подключения к службе приватного канала.	строка
status	Состояние подключения службы приватного канала.	строка

PurviewConfiguration

Имя	Описание	Значение
purviewResourceId	Идентификатор ресурса Purview	строка

VirtualNetworkProfile

Имя	Описание	Значение
computeSubnetId	Идентификатор подсети, используемый для вычислений в рабочей области	строка

WorkspaceRepositoryConfiguration

Имя	Описание	Значение
accountName	Имя учетной записи	строка
collaborationBranch	Ветвь совместной работы	строка
hostName	Имя узла GitHub Enterprise. Например: `https://github.mydomain.com`	строка
lastCommitId	Последняя ИД фиксации	строка
projectName	Имя проекта VSTS	строка
repositoryName	Имя репозитория	строка
rootFolder	Корневая папка для использования в репозитории	строка
tenantId	Идентификатор клиента VSTS	строка
type	Тип конфигурации репозитория рабочей области. Пример WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration	строка

Рабочие области Microsoft.Synapse 2020-12-01

Определение ресурса Bicep

Формат ресурсов

Значения свойств

workspaces

ManagedIdentity

Свойства рабочей области

DataLakeStorageAccountDetails

EncryptionDetails

CustomerManagedKeyDetails

WorkspaceKeyDetails

ManagedVirtualNetworkSettings

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

PurviewConfiguration

VirtualNetworkProfile

WorkspaceRepositoryConfiguration

Шаблоны быстрого запуска

Определение ресурса шаблона ARM

Формат ресурсов

Значения свойств

workspaces

ManagedIdentity

Свойства рабочей области

DataLakeStorageAccountDetails

EncryptionDetails

CustomerManagedKeyDetails

WorkspaceKeyDetails

ManagedVirtualNetworkSettings

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

PurviewConfiguration

VirtualNetworkProfile

WorkspaceRepositoryConfiguration

Шаблоны быстрого запуска

Определение ресурса Terraform (поставщик AzAPI)

Формат ресурсов

Значения свойств

workspaces

ManagedIdentity

Свойства рабочей области

DataLakeStorageAccountDetails

EncryptionDetails

CustomerManagedKeyDetails

WorkspaceKeyDetails

ManagedVirtualNetworkSettings

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

PurviewConfiguration

VirtualNetworkProfile

WorkspaceRepositoryConfiguration

Обратная связь

Обратная связь

Дополнительные ресурсы