Integration Runtimes - Get

Ссылка

Служба:: Synapse

Версия API:: 2021-06-01

Получение среды выполнения интеграции
Получение среды выполнения интеграции

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}?api-version=2021-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
integrationRuntimeName	path	True	string	Имя среды выполнения интеграции
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Идентификатор целевой подписки.
workspaceName	path	True	string	Имя рабочей области.
api-version	query	True	string	Версия API, используемая для этой операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-None-Match		string	ETag сущности среды выполнения интеграции. Необходимо указать только для получения. Если ETag соответствует существующему тегу сущности или если * предоставлено, содержимое не будет возвращено.

Ответы

Имя	Тип	Описание
200 OK	IntegrationRuntimeResource	ХОРОШО.
Other Status Codes		Не изменено.
Other Status Codes	ErrorResponse	Ответ об ошибке, полученный из операции среды выполнения интеграции GET.

Примеры

Get integration runtime

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleIntegrationRuntime?api-version=2021-06-01

Пример ответа

Код состояния:: 200

Date: Mon, 22 Apr 2019 18:33:47 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11997
x-ms-request-id: ad824326-e577-4a47-a092-2e621c4d59d9
x-ms-correlation-request-id: ad824326-e577-4a47-a092-2e621c4d59d9

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/integrationruntimes/exampleIntegrationRuntime",
  "name": "exampleIntegrationRuntime",
  "type": "Microsoft.Synapse/workspaces/integrationruntimes",
  "properties": {
    "type": "SelfHosted",
    "description": "A selfhosted integration runtime"
  },
  "etag": "15003c4f-0000-0200-0000-5cbe090b0000"
}

Код состояния:: 304

Код состояния:: default

{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Определения

Имя	Описание
DataFlowComputeType	Тип вычислений кластера, который будет выполнять задание потока данных.
EntityReference	Ссылка на сущность.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
IntegrationRuntimeComputeProperties	Свойства вычислительных ресурсов для управляемой среды выполнения интеграции.
IntegrationRuntimeCustomerVirtualNetwork	Определение и свойства виртуальной сети, к которой присоединятся среда выполнения интеграции Azure-SSIS.
IntegrationRuntimeCustomSetupScriptProperties	Настраиваемые свойства скрипта установки для управляемой выделенной среды выполнения интеграции.
IntegrationRuntimeDataFlowProperties	Свойства потока данных для управляемой среды выполнения интеграции.
IntegrationRuntimeDataProxyProperties	Свойства прокси-сервера данных для управляемой выделенной среды выполнения интеграции.
IntegrationRuntimeEdition	Выпуск среды выполнения интеграции SSIS
IntegrationRuntimeEntityReferenceType	Тип указанной сущности.
IntegrationRuntimeLicenseType	Тип лицензии для создания собственного сценария лицензии.
IntegrationRuntimeResource	Тип ресурса среды выполнения интеграции.
IntegrationRuntimeSsisCatalogInfo	Сведения о каталоге для управляемой выделенной среды выполнения интеграции.
IntegrationRuntimeSsisCatalogPricingTier	Ценовая категория для базы данных каталога. Допустимые значения можно найти в https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	Свойства служб SSIS для управляемой среды выполнения интеграции.
IntegrationRuntimeState	Состояние среды выполнения интеграции.
IntegrationRuntimeType	Тип среды выполнения интеграции.
IntegrationRuntimeVNetProperties	Свойства виртуальной сети для управляемой среды выполнения интеграции.
LinkedIntegrationRuntimeKeyAuthorization	Среда выполнения интеграции типа авторизации ключа.
LinkedIntegrationRuntimeRbacAuthorization	Среда выполнения интеграции типа авторизации на основе ролей (RBAC).
ManagedIntegrationRuntime	Управляемая среда выполнения интеграции, включая управляемые эластичные и управляемые выделенные среды выполнения интеграции.
SecureString	Определение защищенной строки Azure Synapse. Строковое значение будет маскировано звездочками "*" во время вызовов API Get или List.
SelfHostedIntegrationRuntime	Локальная среда выполнения интеграции.

DataFlowComputeType

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

Имя	Тип	Описание
ComputeOptimized	string
General	string
MemoryOptimized	string

EntityReference

Ссылка на сущность.

Имя	Тип	Описание
referenceName	string	Имя указанной сущности.
type	IntegrationRuntimeEntityReferenceType	Тип указанной сущности.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

IntegrationRuntimeComputeProperties

Свойства вычислительных ресурсов для управляемой среды выполнения интеграции.

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

IntegrationRuntimeCustomerVirtualNetwork

Определение и свойства виртуальной сети, к которой присоединятся среда выполнения интеграции Azure-SSIS.

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

IntegrationRuntimeCustomSetupScriptProperties

Настраиваемые свойства скрипта установки для управляемой выделенной среды выполнения интеграции.

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

IntegrationRuntimeDataFlowProperties

Свойства потока данных для управляемой среды выполнения интеграции.

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

IntegrationRuntimeDataProxyProperties

Свойства прокси-сервера данных для управляемой выделенной среды выполнения интеграции.

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

IntegrationRuntimeEdition

Выпуск среды выполнения интеграции SSIS

Имя	Тип	Описание
Enterprise	string
Standard	string

IntegrationRuntimeEntityReferenceType

Тип указанной сущности.

Имя	Тип	Описание
IntegrationRuntimeReference	string
LinkedServiceReference	string

IntegrationRuntimeLicenseType

Тип лицензии для создания собственного сценария лицензии.

Имя	Тип	Описание
BasePrice	string
LicenseIncluded	string

IntegrationRuntimeResource

Тип ресурса среды выполнения интеграции.

Имя	Тип	Описание
etag	string	Etag ресурса.
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	Свойства среды выполнения интеграции.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

IntegrationRuntimeSsisCatalogInfo

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

Имя	Тип	Описание
catalogAdminPassword	SecureString	Пароль учетной записи администратора базы данных каталога.
catalogAdminUserName	string	Имя пользователя администратора базы данных каталога.
catalogPricingTier	IntegrationRuntimeSsisCatalogPricingTier	Ценовая категория для базы данных каталога. Допустимые значения можно найти в https://azure.microsoft.com/en-us/pricing/details/sql-database/
catalogServerEndpoint	string	URL-адрес сервера базы данных каталога.

IntegrationRuntimeSsisCatalogPricingTier

Ценовая категория для базы данных каталога. Допустимые значения можно найти в https://azure.microsoft.com/en-us/pricing/details/sql-database/

Имя	Тип	Описание
Basic	string
Premium	string
PremiumRS	string
Standard	string

IntegrationRuntimeSsisProperties

Свойства служб SSIS для управляемой среды выполнения интеграции.

Имя	Тип	Описание
catalogInfo	IntegrationRuntimeSsisCatalogInfo	Сведения о каталоге для управляемой выделенной среды выполнения интеграции.
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	Настраиваемые свойства скрипта установки для управляемой выделенной среды выполнения интеграции.
dataProxyProperties	IntegrationRuntimeDataProxyProperties	Свойства прокси-сервера данных для управляемой выделенной среды выполнения интеграции.
edition	IntegrationRuntimeEdition	Выпуск среды выполнения интеграции SSIS
expressCustomSetupProperties	CustomSetupBase[]	Настраиваемая настройка без свойств скрипта для среды выполнения интеграции SSIS.
licenseType	IntegrationRuntimeLicenseType	Тип лицензии для создания собственного сценария лицензии.

IntegrationRuntimeState

Состояние среды выполнения интеграции.

Имя	Тип	Описание
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeType

Тип среды выполнения интеграции.

Имя	Тип	Описание
Managed	string
SelfHosted	string

IntegrationRuntimeVNetProperties

Свойства виртуальной сети для управляемой среды выполнения интеграции.

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

LinkedIntegrationRuntimeKeyAuthorization

Среда выполнения интеграции типа авторизации ключа.

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

LinkedIntegrationRuntimeRbacAuthorization

Среда выполнения интеграции типа авторизации на основе ролей (RBAC).

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

ManagedIntegrationRuntime

Управляемая среда выполнения интеграции, включая управляемые эластичные и управляемые выделенные среды выполнения интеграции.

Имя	Тип	Описание
description	string	Описание среды выполнения интеграции.
managedVirtualNetwork.id	string	Идентификатор управляемой виртуальной сети.
managedVirtualNetwork.referenceName	string	Имя ссылки управляемой виртуальной сети
managedVirtualNetwork.type	string	Тип управляемой виртуальной сети.
provisioningState	IntegrationRuntimeState	Состояние среды выполнения интеграции, допустимое только для управляемой выделенной среды выполнения интеграции.
type	string: Managed	Тип среды выполнения интеграции.
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	Вычислительный ресурс для управляемой среды выполнения интеграции.
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	Имя виртуальной сети, к которой будет присоединена среда выполнения интеграции Azure-SSIS
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	Свойства служб SSIS для управляемой среды выполнения интеграции.

SecureString

Определение защищенной строки Azure Synapse. Строковое значение будет маскировано звездочками "*" во время вызовов API Get или List.

Имя	Тип	Описание
type	string: SecureString	Тип секрета.
value	string	Значение безопасной строки.

SelfHostedIntegrationRuntime

Локальная среда выполнения интеграции.

Имя	Тип	Описание
description	string	Описание среды выполнения интеграции.
type	string: SelfHosted	Тип среды выполнения интеграции.
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	Связанный тип среды выполнения интеграции из фабрики данных

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