Рабочие области Microsoft.Synapse 2021-04-01-preview

Статья
12/20/2024

Определение ресурсов Bicep

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

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

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

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

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

resource symbolicname 'Microsoft.Synapse/workspaces@2021-04-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    connectivityEndpoints: {
      {customized property}: 'string'
    }
    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'
          }
        }
      }
    ]
    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'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

CustomerManagedKeyDetails

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

DataLakeStorageAccountDetails

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

EncryptionDetails

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

ManagedIdentity

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

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

Имя	Описание	Ценность

VirtualNetworkProfile

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

WorkspaceKeyDetails

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

WorkspaceProperties

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

WorkspacePropertiesConnectivityEndpoints

Имя	Описание	Ценность

WorkspaceRepositoryConfiguration

Имя	Описание	Ценность
accountName	Имя учетной записи	струна
совместная работаBranch	Ветвь совместной работы	струна
hostName	Имя узла GitHub Enterprise. Например, `https://github.mydomain.com`	струна
lastCommitId	Последний идентификатор фиксации	струна
имя проекта	Имя проекта VSTS	струна
имя репозитория	Имя репозитория	струна
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-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "connectivityEndpoints": {
      "{customized property}": "string"
    },
    "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"
          }
        }
      }
    ],
    "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"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

CustomerManagedKeyDetails

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

DataLakeStorageAccountDetails

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

EncryptionDetails

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

ManagedIdentity

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

ManagedVirtualNetworkSettings

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

Microsoft.Synapse/workspaces

Имя	Описание	Ценность
apiVersion	Версия API	'2021-04-01-preview'
тождество	Удостоверение рабочей области	ManagedIdentity
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	строка (обязательно)
свойства	Свойства ресурса рабочей области	WorkspaceProperties
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
тип	Тип ресурса	"Microsoft.Synapse/workspaces"

PrivateEndpoint

Имя	Описание	Ценность

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

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

PurviewConfiguration

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

TrackedResourceTags

Имя	Описание	Ценность

VirtualNetworkProfile

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

WorkspaceKeyDetails

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

WorkspaceProperties

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

WorkspacePropertiesConnectivityEndpoints

Имя	Описание	Ценность

WorkspaceRepositoryConfiguration

Имя	Описание	Ценность
accountName	Имя учетной записи	струна
совместная работаBranch	Ветвь совместной работы	струна
hostName	Имя узла GitHub Enterprise. Например, `https://github.mydomain.com`	струна
lastCommitId	Последний идентификатор фиксации	струна
имя проекта	Имя проекта VSTS	струна
имя репозитория	Имя репозитория	струна
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 Proof-of-Concept развертывание	Этот шаблон создает подтверждение концепции среды для Azure Synapse, включая пулы SQL и необязательные пулы Apache Spark.

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

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

групп ресурсов

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

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

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

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

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

CustomerManagedKeyDetails

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

DataLakeStorageAccountDetails

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

EncryptionDetails

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

ManagedIdentity

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

ManagedVirtualNetworkSettings

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

Microsoft.Synapse/workspaces

Имя	Описание	Ценность
тождество	Удостоверение рабочей области	ManagedIdentity
местоположение	Географическое расположение, в котором находится ресурс	строка (обязательно)
имя	Имя ресурса	строка (обязательно)
свойства	Свойства ресурса рабочей области	WorkspaceProperties
Теги	Теги ресурсов	Словарь имен и значений тегов.
тип	Тип ресурса	"Microsoft.Synapse/workspaces@2021-04-01-preview"

PrivateEndpoint

Имя	Описание	Ценность

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

PrivateLinkServiceConnectionState

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

PurviewConfiguration

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

TrackedResourceTags

Имя	Описание	Ценность

VirtualNetworkProfile

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

WorkspaceKeyDetails

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

WorkspaceProperties

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

WorkspacePropertiesConnectivityEndpoints

Имя	Описание	Ценность

WorkspaceRepositoryConfiguration

Имя	Описание	Ценность
accountName	Имя учетной записи	струна
совместная работаBranch	Ветвь совместной работы	струна
hostName	Имя узла GitHub Enterprise. Например, `https://github.mydomain.com`	струна
lastCommitId	Последний идентификатор фиксации	струна
имя проекта	Имя проекта VSTS	струна
имя репозитория	Имя репозитория	струна
rootFolder	Корневая папка для использования в репозитории	струна
tenantId	Идентификатор клиента VSTS	струна Ограничения целостности: Минимальная длина = 36 Максимальная длина = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
тип	Тип конфигурации репозитория рабочей области. Пример WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration	струна

Поделиться через

Рабочие области Microsoft.Synapse 2021-04-01-preview

Определение ресурсов Bicep

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

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

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ManagedIdentity

ManagedVirtualNetworkSettings

Microsoft.Synapse/workspaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PurviewConfiguration

TrackedResourceTags

VirtualNetworkProfile

WorkspaceKeyDetails

WorkspaceProperties

WorkspacePropertiesConnectivityEndpoints

WorkspaceRepositoryConfiguration

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

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

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

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ManagedIdentity

ManagedVirtualNetworkSettings

Microsoft.Synapse/workspaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PurviewConfiguration

TrackedResourceTags

VirtualNetworkProfile

WorkspaceKeyDetails

WorkspaceProperties

WorkspacePropertiesConnectivityEndpoints

WorkspaceRepositoryConfiguration

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

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

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

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

CustomerManagedKeyDetails

DataLakeStorageAccountDetails

EncryptionDetails

ManagedIdentity

ManagedVirtualNetworkSettings

Microsoft.Synapse/workspaces

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

PurviewConfiguration

TrackedResourceTags

VirtualNetworkProfile

WorkspaceKeyDetails

WorkspaceProperties

WorkspacePropertiesConnectivityEndpoints

WorkspaceRepositoryConfiguration

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

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