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


Microsoft.Synapse workspaces/integrationRuntimes

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

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

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

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

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

resource symbolicname 'Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    type: 'string'
    // For remaining properties, see IntegrationRuntime objects
  }
}

Объекты IntegrationRuntime

Задайте свойство type , чтобы указать тип объекта .

Для управляемого используйте:

  type: 'Managed'
  managedVirtualNetwork: {
    id: 'string'
    referenceName: 'string'
    type: 'string'
  }
  typeProperties: {
    computeProperties: {
      dataFlowProperties: {
        computeType: 'string'
        coreCount: int
        timeToLive: int
      }
      location: 'string'
      maxParallelExecutionsPerNode: int
      nodeSize: 'string'
      numberOfNodes: int
      vNetProperties: {
        publicIPs: [
          'string'
        ]
        subnet: 'string'
        subnetId: 'string'
        vNetId: 'string'
      }
    }
    customerVirtualNetwork: {
      subnetId: 'string'
    }
    ssisProperties: {
      catalogInfo: {
        catalogAdminPassword: {
          type: 'string'
          value: 'string'
        }
        catalogAdminUserName: 'string'
        catalogPricingTier: 'string'
        catalogServerEndpoint: 'string'
      }
      customSetupScriptProperties: {
        blobContainerUri: 'string'
        sasToken: {
          type: 'string'
          value: 'string'
        }
      }
      dataProxyProperties: {
        connectVia: {
          referenceName: 'string'
          type: 'string'
        }
        path: 'string'
        stagingLinkedService: {
          referenceName: 'string'
          type: 'string'
        }
      }
      edition: 'string'
      expressCustomSetupProperties: [
        {
          type: 'string'
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType: 'string'
    }
  }

Для SelfHosted используйте:

  type: 'SelfHosted'
  typeProperties: {
    linkedInfo: {
      authorizationType: 'string'
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }

Объекты CustomSetupBase

Задайте свойство type , чтобы указать тип объекта .

Для CmdkeySetup используйте:

  type: 'CmdkeySetup'
  typeProperties: {
    password: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
    targetName: any()
    userName: any()
  }

Для ComponentSetup используйте:

  type: 'ComponentSetup'
  typeProperties: {
    componentName: 'string'
    licenseKey: {
      type: 'string'
      // For remaining properties, see SecretBase objects
    }
  }

Для EnvironmentVariableSetup используйте:

  type: 'EnvironmentVariableSetup'
  typeProperties: {
    variableName: 'string'
    variableValue: 'string'
  }

Объекты SecretBase

Задайте свойство type , чтобы указать тип объекта .

Для SecureString используйте:

  type: 'SecureString'
  value: 'string'

Объекты LinkedIntegrationRuntimeType

Задайте свойство authorizationType , чтобы указать тип объекта.

В разделе Ключ используйте:

  authorizationType: 'Key'
  key: {
    type: 'string'
    value: 'string'
  }

Для RBAC используйте:

  authorizationType: 'RBAC'
  resourceId: 'string'

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

workspaces/integrationRuntimes

Имя Описание Значение
name имя ресурса.

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: workspaces
properties Свойства среды выполнения интеграции. IntegrationRuntime (обязательно)

IntegrationRuntime

Имя Описание Значение
description Описание среды выполнения интеграции. строка
type Установка типа объекта Управляемость
SelfHosted (обязательно)

ManagedIntegrationRuntime

Имя Описание Значение
тип Тип среды выполнения интеграции. Managed (обязательно)
managedVirtualNetwork Управляемая виртуальная сеть среды выполнения интеграции. ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties Свойства управляемой среды выполнения интеграции. ManagedIntegrationRuntimeTypeProperties (обязательно)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

Имя Описание Значение
идентификатор Идентификатор управляемой виртуальной сети. строка
referenceName Имя ссылки для управляемой виртуальной сети строка
type Тип управляемой виртуальной сети. строка

ManagedIntegrationRuntimeTypeProperties

Имя Описание Значение
computeProperties Вычислительный ресурс для управляемой среды выполнения интеграции. IntegrationRuntimeComputeProperties
customerVirtualNetwork Имя виртуальной сети, к которой будет присоединена среда выполнения интеграции Azure-SSIS. IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Свойства служб SSIS для управляемой среды выполнения интеграции. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Имя Описание Значение
dataFlowProperties Свойства потока данных для управляемой среды выполнения интеграции. IntegrationRuntimeDataFlowProperties
location Расположение управляемой среды выполнения интеграции. Поддерживаемые регионы можно найти в /azure/data-factory/data-factory-data-movement-activities. строка
maxParallelExecutionsPerNode Максимальное число параллельных выполнений на узел для управляемой среды выполнения интеграции. INT
nodeSize Требования к размеру узла для управляемой среды выполнения интеграции. строка
numberOfNodes Необходимое количество узлов для управляемой среды выполнения интеграции. INT
Свойства vNetProperties Свойства виртуальной сети для управляемой среды выполнения интеграции. IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

Имя Описание Значение
computeType Тип вычислений кластера, который будет выполнять задание потока данных. ComputeOptimized
"Общие"
MemoryOptimized
coreCount Число ядер кластера, который будет выполнять задание потока данных. Поддерживаемые значения: 8, 16, 32, 48, 80, 144 и 272. INT
timeToLive Время жизни (в минутах) для кластера, который будет выполнять задание потока данных. INT

IntegrationRuntimeVNetProperties

Имя Описание Значение
publicIP Идентификаторы ресурсов общедоступных IP-адресов, которые будет использовать эта среда выполнения интеграции. string[]
подсеть Имя подсети, к ней присоединяется среда выполнения интеграции. строка
subnetId Идентификатор подсети, к которой будет присоединена среда выполнения интеграции Azure-SSIS. строка
vNetId Идентификатор виртуальной сети, к которому присоединится эта среда выполнения интеграции. строка

IntegrationRuntimeCustomerVirtualNetwork

Имя Описание Значение
subnetId Идентификатор подсети, к которой будет присоединена среда выполнения интеграции Azure-SSIS. строка

IntegrationRuntimeSsisProperties

Имя Описание Значение
catalogInfo Сведения о каталоге для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Настраиваемые свойства скрипта установки для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Свойства прокси-сервера данных для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeDataProxyProperties
edition Выпуск для Integration Runtime служб SSIS "Корпоративный"
"Стандартный"
expressCustomSetupProperties Пользовательская настройка без свойств скрипта для среды выполнения интеграции SSIS. CustomSetupBase[]
licenseType Тип лицензии для создания собственного сценария лицензирования. "Базовая цена"
'LicenseIncluded'

IntegrationRuntimeSsisCatalogInfo

Имя Описание Значение
catalogAdminPassword Пароль учетной записи администратора базы данных каталога. Securestring
catalogAdminUserName Имя пользователя администратора базы данных каталога. строка
catalogPricingTier Ценовая категория для базы данных каталога. Допустимые значения можно найти в https://azure.microsoft.com/pricing/details/sql-database/ "Базовый"
"Премиум"
"PremiumRS"
"Стандартный"
catalogServerEndpoint URL-адрес сервера базы данных каталога. строка

SecureString

Имя Описание Значение
тип Тип секрета. string (обязательно)
значение Значение защищенной строки. string (обязательно)

IntegrationRuntimeCustomSetupScriptProperties

Имя Описание Значение
blobContainerUri Универсальный код ресурса (URI) контейнера BLOB-объектов Azure, содержащего пользовательский скрипт установки. строка
sasToken Маркер SAS контейнера BLOB-объектов Azure. Securestring

IntegrationRuntimeDataProxyProperties

Имя Описание Значение
connectVia Ссылка на локальную среду выполнения интеграции. EntityReference
path Путь для размещения промежуточных данных в хранилище BLOB-объектов. строка
stagingLinkedService Ссылка на промежуточную связанную службу. EntityReference

EntityReference

Имя Описание Значение
referenceName Имя этой сущности, на который ссылается ссылка. строка
type Тип сущности, на который ссылается ссылка. IntegrationRuntimeReference
LinkedServiceReference

CustomSetupBase

Имя Описание Значение
тип Установка типа объекта CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (обязательно)

CmdkeySetup

Имя Описание Значение
тип Тип настраиваемой установки. CmdkeySetup (обязательно)
typeProperties Настраиваемые свойства типа установки команды Cmdkey. CmdkeySetupTypeProperties (обязательно)

CmdkeySetupTypeProperties

Имя Описание Значение
password Пароль для доступа к источнику данных. SecretBase (обязательно)
targetName Имя сервера для доступа к источнику данных. Для Bicep можно использовать функцию any(). (обязательно)
userName Имя пользователя для доступа к источнику данных. Для Bicep можно использовать функцию any(). (обязательно)

Секретная база

Имя Описание Значение
тип Установка типа объекта SecureString (обязательно)

ComponentSetup

Имя Описание Значение
тип Тип настраиваемой установки. ComponentSetup (обязательно)
typeProperties Установите сторонние свойства типа компонента. LicensedComponentSetupTypeProperties (обязательно)

LicensedComponentSetupTypeProperties

Имя Описание Значение
componentName Имя стороннего компонента. строка (обязательно)
licenseKey Лицензионный ключ для активации компонента. SecretBase

EnvironmentVariableSetup

Имя Описание Значение
тип Тип настраиваемой установки. EnvironmentVariableSetup (обязательно)
typeProperties Добавление свойств типа переменной среды. EnvironmentVariableSetupTypeProperties (обязательно)

EnvironmentVariableSetupTypeProperties

Имя Описание Значение
variableName Имя переменной среды. строка (обязательно)
variableValue Значение переменной среды. строка (обязательно)

SelfHostedIntegrationRuntime

Имя Описание Значение
тип Тип среды выполнения интеграции. SelfHosted (обязательно)
typeProperties Если это свойство не равно NULL, это означает, что это связанная среда выполнения интеграции. Свойство используется для доступа к исходной среде выполнения интеграции. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Имя Описание Значение
linkedInfo Связанный тип среды выполнения интеграции из фабрики данных LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

Имя Описание Значение
AuthorizationType Установка типа объекта Key
RBAC (обязательно)

LinkedIntegrationRuntimeKeyAuthorization

Имя Описание Значение
AuthorizationType Тип авторизации для общего доступа к среде выполнения интеграции. "Ключ" (обязательно)
ключ Ключ, используемый для авторизации. SecureString (обязательно)

LinkedIntegrationRuntimeRbacAuthorization

Имя Описание Значение
AuthorizationType Тип авторизации для общего доступа к среде выполнения интеграции. RBAC (обязательно)
resourceId Идентификатор ресурса среды выполнения интеграции, к которой будет предоставлен общий доступ. строка (обязательно)

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

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

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

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

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

{
  "type": "Microsoft.Synapse/workspaces/integrationRuntimes",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "description": "string",
    "type": "string"
    // For remaining properties, see IntegrationRuntime objects
  }
}

Объекты IntegrationRuntime

Задайте свойство type , чтобы указать тип объекта .

Для управляемого используйте:

  "type": "Managed",
  "managedVirtualNetwork": {
    "id": "string",
    "referenceName": "string",
    "type": "string"
  },
  "typeProperties": {
    "computeProperties": {
      "dataFlowProperties": {
        "computeType": "string",
        "coreCount": "int",
        "timeToLive": "int"
      },
      "location": "string",
      "maxParallelExecutionsPerNode": "int",
      "nodeSize": "string",
      "numberOfNodes": "int",
      "vNetProperties": {
        "publicIPs": [ "string" ],
        "subnet": "string",
        "subnetId": "string",
        "vNetId": "string"
      }
    },
    "customerVirtualNetwork": {
      "subnetId": "string"
    },
    "ssisProperties": {
      "catalogInfo": {
        "catalogAdminPassword": {
          "type": "string",
          "value": "string"
        },
        "catalogAdminUserName": "string",
        "catalogPricingTier": "string",
        "catalogServerEndpoint": "string"
      },
      "customSetupScriptProperties": {
        "blobContainerUri": "string",
        "sasToken": {
          "type": "string",
          "value": "string"
        }
      },
      "dataProxyProperties": {
        "connectVia": {
          "referenceName": "string",
          "type": "string"
        },
        "path": "string",
        "stagingLinkedService": {
          "referenceName": "string",
          "type": "string"
        }
      },
      "edition": "string",
      "expressCustomSetupProperties": [
        {
          "type": "string"
          // For remaining properties, see CustomSetupBase objects
        }
      ],
      "licenseType": "string"
    }
  }

Для SelfHosted используйте:

  "type": "SelfHosted",
  "typeProperties": {
    "linkedInfo": {
      "authorizationType": "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }

Объекты CustomSetupBase

Задайте свойство type , чтобы указать тип объекта .

Для CmdkeySetup используйте:

  "type": "CmdkeySetup",
  "typeProperties": {
    "password": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    },
    "targetName": {},
    "userName": {}
  }

Для ComponentSetup используйте:

  "type": "ComponentSetup",
  "typeProperties": {
    "componentName": "string",
    "licenseKey": {
      "type": "string"
      // For remaining properties, see SecretBase objects
    }
  }

Для EnvironmentVariableSetup используйте:

  "type": "EnvironmentVariableSetup",
  "typeProperties": {
    "variableName": "string",
    "variableValue": "string"
  }

Объекты SecretBase

Задайте свойство type , чтобы указать тип объекта .

Для SecureString используйте:

  "type": "SecureString",
  "value": "string"

Объекты LinkedIntegrationRuntimeType

Задайте свойство authorizationType , чтобы указать тип объекта.

В разделе Ключ используйте:

  "authorizationType": "Key",
  "key": {
    "type": "string",
    "value": "string"
  }

Для RBAC используйте:

  "authorizationType": "RBAC",
  "resourceId": "string"

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

workspaces/integrationRuntimes

Имя Описание Значение
тип Тип ресурса Microsoft.Synapse/workspaces/integrationRuntimes
версия_API Версия API ресурсов '2021-06-01'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
string (обязательно)
properties Свойства среды выполнения интеграции. IntegrationRuntime (обязательно)

IntegrationRuntime

Имя Описание Значение
description Описание среды выполнения интеграции. строка
type Установка типа объекта Управляемость
SelfHosted (обязательно)

ManagedIntegrationRuntime

Имя Описание Значение
тип Тип среды выполнения интеграции. "Управляемый" (обязательно)
managedVirtualNetwork Управляемая виртуальная сеть среды выполнения интеграции. ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties Свойства среды выполнения управляемой интеграции. ManagedIntegrationRuntimeTypeProperties (обязательно)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

Имя Описание Значение
идентификатор Идентификатор управляемой виртуальной сети. строка
referenceName Эталонный имя управляемой виртуальной сети строка
type Тип управляемой виртуальной сети. строка

ManagedIntegrationRuntimeTypeProperties

Имя Описание Значение
свойства computeProperties Вычислительный ресурс для управляемой среды выполнения интеграции. IntegrationRuntimeComputeProperties
customerVirtualNetwork Имя виртуальной сети, к которой будет присоединена среда выполнения интеграции Azure-SSIS. IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Свойства служб SSIS для управляемой среды выполнения интеграции. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Имя Описание Значение
dataFlowProperties Свойства потока данных для управляемой среды выполнения интеграции. IntegrationRuntimeDataFlowProperties
location Расположение управляемой среды выполнения интеграции. Поддерживаемые регионы можно найти в /azure/data-factory/data-factory-data-movement-activities. строка
maxParallelExecutionsPerNode Максимальное число параллельных выполнений на узел для управляемой среды выполнения интеграции. INT
nodeSize Требования к размеру узла для управляемой среды выполнения интеграции. строка
numberOfNodes Необходимое количество узлов для управляемой среды выполнения интеграции. INT
Свойства vNetProperties Свойства виртуальной сети для управляемой среды выполнения интеграции. IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

Имя Описание Значение
computeType Тип вычислений кластера, который будет выполнять задание потока данных. ComputeOptimized
"Общие"
MemoryOptimized
coreCount Число ядер кластера, который будет выполнять задание потока данных. Поддерживаемые значения: 8, 16, 32, 48, 80, 144 и 272. INT
timeToLive Параметр времени жизни (в минутах) кластера, который будет выполнять задание потока данных. INT

IntegrationRuntimeVNetProperties

Имя Описание Значение
publicIP Идентификаторы ресурсов общедоступных IP-адресов, которые будет использовать эта среда выполнения интеграции. string[]
подсеть Имя подсети, к ней будет присоединена эта среда выполнения интеграции. строка
subnetId Идентификатор подсети, к которой будет присоединена эта среда выполнения интеграции Azure-SSIS. строка
vNetId Идентификатор виртуальной сети, к которому будет присоединена эта среда выполнения интеграции. строка

IntegrationRuntimeCustomerVirtualNetwork

Имя Описание Значение
subnetId Идентификатор подсети, к которой будет присоединена среда выполнения интеграции Azure-SSIS. строка

IntegrationRuntimeSsisProperties

Имя Описание Значение
catalogInfo Сведения о каталоге для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Свойства скрипта настраиваемой установки для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Свойства прокси-сервера данных для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeDataProxyProperties
edition Выпуск для Integration Runtime служб SSIS "Корпоративный"
"Стандартный"
expressCustomSetupProperties Пользовательская установка без свойств скрипта для среды выполнения интеграции SSIS. CustomSetupBase[]
licenseType Тип лицензии для использования собственного сценария лицензирования. "Базовая цена"
"LicenseIncluded"

IntegrationRuntimeSsisCatalogInfo

Имя Описание Значение
catalogAdminPassword Пароль учетной записи администратора базы данных каталога. Securestring
catalogAdminUserName Имя администратора базы данных каталога. строка
catalogPricingTier Ценовая категория для базы данных каталога. Допустимые значения можно найти в https://azure.microsoft.com/pricing/details/sql-database/ "Базовый"
"Премиум"
PremiumRS
"Стандартный"
catalogServerEndpoint URL-адрес сервера базы данных каталога. строка

SecureString

Имя Описание Значение
тип Тип секрета. строка (обязательно)
значение Значение защищенной строки. строка (обязательно)

IntegrationRuntimeCustomSetupScriptProperties

Имя Описание Значение
blobContainerUri Универсальный код ресурса (URI) контейнера BLOB-объектов Azure, содержащего скрипт пользовательской установки. строка
sasToken Маркер SAS контейнера BLOB-объектов Azure. Securestring

IntegrationRuntimeDataProxyProperties

Имя Описание Значение
connectVia Справочник по локальной среде выполнения интеграции. EntityReference
path Путь к промежуточным данным в хранилище BLOB-объектов. строка
stagingLinkedService Ссылка на промежуточную связанную службу. EntityReference

EntityReference

Имя Описание Значение
referenceName Имя этой упоминаемой сущности. строка
type Тип этой упоминаемой сущности. IntegrationRuntimeReference
LinkedServiceReference

CustomSetupBase

Имя Описание Значение
тип Установка типа объекта CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (обязательно)

CmdkeySetup

Имя Описание Значение
тип Тип настраиваемой установки. CmdkeySetup (обязательно)
typeProperties Свойства настраиваемого типа установки команды Cmdkey. CmdkeySetupTypeProperties (обязательно)

CmdkeySetupTypeProperties

Имя Описание Значение
password Пароль для доступа к источнику данных. SecretBase (обязательно)
targetName Имя сервера для доступа к источнику данных.
userName Имя пользователя для доступа к источнику данных.

SecretBase

Имя Описание Значение
тип Установка типа объекта SecureString (обязательно)

ComponentSetup

Имя Описание Значение
тип Тип настраиваемой установки. ComponentSetup (обязательно)
typeProperties Установите свойства типа сторонних компонентов. LicensedComponentSetupTypeProperties (обязательно)

LicensedComponentSetupTypeProperties

Имя Описание Значение
componentName Имя стороннего компонента. строка (обязательно)
licenseKey Лицензионный ключ для активации компонента. SecretBase

EnvironmentVariableSetup

Имя Описание Значение
тип Тип настраиваемой установки. EnvironmentVariableSetup (обязательно)
typeProperties Добавление свойств типа переменной среды. EnvironmentVariableSetupTypeProperties (обязательно)

EnvironmentVariableSetupTypeProperties

Имя Описание Значение
variableName Имя переменной среды. строка (обязательно)
variableValue Значение переменной среды. строка (обязательно)

SelfHostedIntegrationRuntime

Имя Описание Значение
тип Тип среды выполнения интеграции. SelfHosted (обязательно)
typeProperties Если это свойство не равно NULL, это означает, что это связанная среда выполнения интеграции. Свойство используется для доступа к исходной среде выполнения интеграции. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Имя Описание Значение
linkedInfo Связанный тип среды выполнения интеграции из фабрики данных LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

Имя Описание Значение
authorizationType Установка типа объекта Key
RBAC (обязательно)

LinkedIntegrationRuntimeKeyAuthorization

Имя Описание Значение
authorizationType Тип авторизации для общего доступа к среде выполнения интеграции. "Ключ" (обязательно)
ключ Ключ, используемый для авторизации. SecureString (обязательно)

LinkedIntegrationRuntimeRbacAuthorization

Имя Описание Значение
authorizationType Тип авторизации для общего доступа к среде выполнения интеграции. RBAC (обязательно)
resourceId Идентификатор ресурса среды выполнения интеграции, к которой будет предоставлен общий доступ. string (обязательно)

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      type = "string"
      // For remaining properties, see IntegrationRuntime objects
    }
  })
}

Объекты IntegrationRuntime

Задайте свойство type , чтобы указать тип объекта .

Для управляемого используйте:

  type = "Managed"
  managedVirtualNetwork = {
    id = "string"
    referenceName = "string"
    type = "string"
  }
  typeProperties = {
    computeProperties = {
      dataFlowProperties = {
        computeType = "string"
        coreCount = int
        timeToLive = int
      }
      location = "string"
      maxParallelExecutionsPerNode = int
      nodeSize = "string"
      numberOfNodes = int
      vNetProperties = {
        publicIPs = [
          "string"
        ]
        subnet = "string"
        subnetId = "string"
        vNetId = "string"
      }
    }
    customerVirtualNetwork = {
      subnetId = "string"
    }
    ssisProperties = {
      catalogInfo = {
        catalogAdminPassword = {
          type = "string"
          value = "string"
        }
        catalogAdminUserName = "string"
        catalogPricingTier = "string"
        catalogServerEndpoint = "string"
      }
      customSetupScriptProperties = {
        blobContainerUri = "string"
        sasToken = {
          type = "string"
          value = "string"
        }
      }
      dataProxyProperties = {
        connectVia = {
          referenceName = "string"
          type = "string"
        }
        path = "string"
        stagingLinkedService = {
          referenceName = "string"
          type = "string"
        }
      }
      edition = "string"
      expressCustomSetupProperties = [
        {
          type = "string"
          // For remaining properties, see CustomSetupBase objects
        }
      ]
      licenseType = "string"
    }
  }

Для SelfHosted используйте:

  type = "SelfHosted"
  typeProperties = {
    linkedInfo = {
      authorizationType = "string"
      // For remaining properties, see LinkedIntegrationRuntimeType objects
    }
  }

Объекты CustomSetupBase

Задайте свойство type , чтобы указать тип объекта .

Для CmdkeySetup используйте:

  type = "CmdkeySetup"
  typeProperties = {
    password = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

Для ComponentSetup используйте:

  type = "ComponentSetup"
  typeProperties = {
    componentName = "string"
    licenseKey = {
      type = "string"
      // For remaining properties, see SecretBase objects
    }
  }

Для EnvironmentVariableSetup используйте:

  type = "EnvironmentVariableSetup"
  typeProperties = {
    variableName = "string"
    variableValue = "string"
  }

Объекты SecretBase

Задайте свойство type , чтобы указать тип объекта .

Для SecureString используйте:

  type = "SecureString"
  value = "string"

Объекты LinkedIntegrationRuntimeType

Задайте свойство authorizationType , чтобы указать тип объекта.

Для параметра Key используйте:

  authorizationType = "Key"
  key = {
    type = "string"
    value = "string"
  }

Для RBAC используйте:

  authorizationType = "RBAC"
  resourceId = "string"

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

workspaces/integrationRuntimes

Имя Описание Значение
тип Тип ресурса "Microsoft.Synapse/workspaces/integrationRuntimes@2021-06-01"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: workspaces
properties Свойства среды выполнения интеграции. IntegrationRuntime (обязательно)

IntegrationRuntime

Имя Описание Значение
description Описание среды выполнения интеграции. строка
type Установка типа объекта Управляемость
SelfHosted (обязательно)

ManagedIntegrationRuntime

Имя Описание Значение
тип Тип среды выполнения интеграции. "Управляемый" (обязательно)
managedVirtualNetwork Управляемая виртуальная сеть среды выполнения интеграции. ManagedIntegrationRuntimeManagedVirtualNetworkRefere...
typeProperties Свойства управляемой среды выполнения интеграции. ManagedIntegrationRuntimeTypeProperties (обязательно)

ManagedIntegrationRuntimeManagedVirtualNetworkRefere...

Имя Описание Значение
идентификатор Идентификатор управляемой виртуальной сети. строка
referenceName Имя ссылки для управляемой виртуальной сети строка
type Тип управляемой виртуальной сети. строка

ManagedIntegrationRuntimeTypeProperties

Имя Описание Значение
computeProperties Вычислительный ресурс для управляемой среды выполнения интеграции. IntegrationRuntimeComputeProperties
customerVirtualNetwork Имя виртуальной сети, к которой будет присоединена среда выполнения интеграции Azure-SSIS. IntegrationRuntimeCustomerVirtualNetwork
ssisProperties Свойства служб SSIS для управляемой среды выполнения интеграции. IntegrationRuntimeSsisProperties

IntegrationRuntimeComputeProperties

Имя Описание Значение
dataFlowProperties Свойства потока данных для управляемой среды выполнения интеграции. IntegrationRuntimeDataFlowProperties
location Расположение управляемой среды выполнения интеграции. Поддерживаемые регионы можно найти в /azure/data-factory/data-factory-data-movement-activities. строка
maxParallelExecutionsPerNode Максимальное число параллельных выполнений на узел для управляемой среды выполнения интеграции. INT
nodeSize Требование к размеру узла для управляемой среды выполнения интеграции. строка
numberOfNodes Необходимое количество узлов для управляемой среды выполнения интеграции. INT
свойства vNetProperties Свойства виртуальной сети для управляемой среды выполнения интеграции. IntegrationRuntimeVNetProperties

IntegrationRuntimeDataFlowProperties

Имя Описание Значение
computeType Тип вычислений кластера, который будет выполнять задание потока данных. "ComputeOptimized"
"Общие"
"MemoryOptimized"
coreCount Число ядер кластера, который будет выполнять задание потока данных. Поддерживаемые значения: 8, 16, 32, 48, 80, 144 и 272. INT
timeToLive Параметр времени жизни (в минутах) кластера, который будет выполнять задание потока данных. INT

IntegrationRuntimeVNetProperties

Имя Описание Значение
publicIP Идентификаторы ресурсов общедоступных IP-адресов, которые будет использовать эта среда выполнения интеграции. string[]
подсеть Имя подсети, к ней будет присоединена эта среда выполнения интеграции. строка
subnetId Идентификатор подсети, к которой будет присоединена эта среда выполнения интеграции Azure-SSIS. строка
vNetId Идентификатор виртуальной сети, к которому будет присоединена эта среда выполнения интеграции. строка

IntegrationRuntimeCustomerVirtualNetwork

Имя Описание Значение
subnetId Идентификатор подсети, к которой будет присоединена среда выполнения интеграции Azure-SSIS. строка

IntegrationRuntimeSsisProperties

Имя Описание Значение
catalogInfo Сведения о каталоге для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeSsisCatalogInfo
customSetupScriptProperties Свойства скрипта настраиваемой установки для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeCustomSetupScriptProperties
dataProxyProperties Свойства прокси-сервера данных для управляемой выделенной среды выполнения интеграции. IntegrationRuntimeDataProxyProperties
edition Выпуск для Integration Runtime служб SSIS "Корпоративный"
"Стандартный"
expressCustomSetupProperties Пользовательская настройка без свойств скрипта для среды выполнения интеграции SSIS. CustomSetupBase[]
licenseType Тип лицензии для создания собственного сценария лицензирования. "Базовая цена"
"LicenseIncluded"

IntegrationRuntimeSsisCatalogInfo

Имя Описание Значение
catalogAdminPassword Пароль учетной записи администратора базы данных каталога. Securestring
catalogAdminUserName Имя пользователя администратора базы данных каталога. строка
catalogPricingTier Ценовая категория для базы данных каталога. Допустимые значения можно найти в https://azure.microsoft.com/pricing/details/sql-database/ "Basic"
"Премиум"
"PremiumRS"
"Стандартный"
catalogServerEndpoint URL-адрес сервера базы данных каталога. строка

SecureString

Имя Описание Значение
тип Тип секрета. string (обязательно)
значение Значение защищенной строки. string (обязательно)

IntegrationRuntimeCustomSetupScriptProperties

Имя Описание Значение
blobContainerUri Универсальный код ресурса (URI) контейнера BLOB-объектов Azure, содержащего пользовательский скрипт установки. строка
sasToken Маркер SAS контейнера BLOB-объектов Azure. Securestring

IntegrationRuntimeDataProxyProperties

Имя Описание Значение
connectVia Ссылка на локальную среду выполнения интеграции. EntityReference
path Путь для размещения промежуточных данных в хранилище BLOB-объектов. строка
stagingLinkedService Ссылка на промежуточную связанную службу. EntityReference

EntityReference

Имя Описание Значение
referenceName Имя этой сущности, на который ссылается ссылка. строка
type Тип сущности, на который ссылается ссылка. IntegrationRuntimeReference
"LinkedServiceReference"

CustomSetupBase

Имя Описание Значение
тип Установка типа объекта CmdkeySetup
ComponentSetup
EnvironmentVariableSetup (обязательно)

CmdkeySetup

Имя Описание Значение
тип Тип настраиваемой установки. "CmdkeySetup" (обязательно)
typeProperties Настраиваемые свойства типа установки команды Cmdkey. CmdkeySetupTypeProperties (обязательно)

CmdkeySetupTypeProperties

Имя Описание Значение
password Пароль для доступа к источнику данных. SecretBase (обязательно)
targetName Имя сервера для доступа к источнику данных.
userName Имя пользователя для доступа к источнику данных.

Секретная база

Имя Описание Значение
тип Установка типа объекта SecureString (обязательно)

ComponentSetup

Имя Описание Значение
тип Тип настраиваемой установки. "ComponentSetup" (обязательно)
typeProperties Установите сторонние свойства типа компонента. LicensedComponentSetupTypeProperties (обязательно)

LicensedComponentSetupTypeProperties

Имя Описание Значение
componentName Имя стороннего компонента. string (обязательно)
licenseKey Лицензионный ключ для активации компонента. Секретная база

EnvironmentVariableSetup

Имя Описание Значение
тип Тип настраиваемой установки. "EnvironmentVariableSetup" (обязательно)
typeProperties Добавьте свойства типа переменной среды. EnvironmentVariableSetupTypeProperties (обязательно)

Свойства EnvironmentVariableSetupTypeProperties

Имя Описание Значение
variableName Имя переменной среды. string (обязательно)
variableValue Значение переменной среды. string (обязательно)

SelfHostedIntegrationRuntime

Имя Описание Значение
тип Тип среды выполнения интеграции. "SelfHosted" (обязательно)
typeProperties Если это свойство не равно NULL, это означает, что это связанная среда выполнения интеграции. Свойство используется для доступа к исходной среде выполнения интеграции. SelfHostedIntegrationRuntimeTypeProperties

SelfHostedIntegrationRuntimeTypeProperties

Имя Описание Значение
linkedInfo Связанный тип среды выполнения интеграции из фабрики данных LinkedIntegrationRuntimeType

LinkedIntegrationRuntimeType

Имя Описание Значение
authorizationType Установка типа объекта Key
RBAC (обязательно)

LinkedIntegrationRuntimeKeyAuthorization

Имя Описание Значение
authorizationType Тип авторизации для общего доступа к среде выполнения интеграции. "Ключ" (обязательно)
ключ Ключ, используемый для авторизации. SecureString (обязательно)

LinkedIntegrationRuntimeRbacAuthorization

Имя Описание Значение
authorizationType Тип авторизации для общего доступа к среде выполнения интеграции. "RBAC" (обязательно)
resourceId Идентификатор ресурса среды выполнения интеграции, к которой будет предоставлен общий доступ. string (обязательно)