你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
workspaceName	path	True	string	工作区的名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
If-None-Match		string	集成运行时实体的 ETag。应仅指定 get。如果 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 Integration Runtime 的版本
IntegrationRuntimeEntityReferenceType	此引用实体的类型。
IntegrationRuntimeLicenseType	用于自带许可证方案的许可证类型。
IntegrationRuntimeResource	集成运行时资源类型。
IntegrationRuntimeSsisCatalogInfo	托管专用集成运行时的目录信息。
IntegrationRuntimeSsisCatalogPricingTier	目录数据库的定价层。可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值
IntegrationRuntimeSsisProperties	托管集成运行时的 SSIS 属性。
IntegrationRuntimeState	集成运行时的状态。
IntegrationRuntimeType	集成运行时的类型。
IntegrationRuntimeVNetProperties	托管集成运行时的 VNet 属性。
LinkedIntegrationRuntimeKeyAuthorization	密钥授权类型集成运行时。
LinkedIntegrationRuntimeRbacAuthorization	基于角色的访问控制（RBAC）授权类型集成运行时。
ManagedIntegrationRuntime	托管集成运行时，包括托管的弹性和托管的专用集成运行时。
SecureString	Azure Synapse 安全字符串定义。在获取或列出 API 调用期间，字符串值将用星号“*”屏蔽。
SelfHostedIntegrationRuntime	自承载集成运行时。

DataFlowComputeType

枚举

将执行数据流作业的群集的计算类型。

值	说明
General
MemoryOptimized
ComputeOptimized

EntityReference

Object

实体引用。

名称	类型	说明
referenceName	string	此引用实体的名称。
type	IntegrationRuntimeEntityReferenceType	此引用实体的类型。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

IntegrationRuntimeComputeProperties

Object

托管集成运行时的计算资源属性。

名称	类型	说明
dataFlowProperties	IntegrationRuntimeDataFlowProperties	托管集成运行时的数据流属性。
location	string	托管集成运行时的位置。可在 https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities 找到支持的区域
maxParallelExecutionsPerNode	integer (int32) minimum: 1	托管集成运行时每个节点的最大并行执行计数。
nodeSize	string	托管集成运行时的节点大小要求。
numberOfNodes	integer (int32) minimum: 1	托管集成运行时所需的节点数。
vNetProperties	IntegrationRuntimeVNetProperties	托管集成运行时的 VNet 属性。

IntegrationRuntimeCustomerVirtualNetwork

Object

Azure-SSIS 集成运行时要加入的虚拟网络的定义和属性。

名称	类型	说明
subnetId	string	Azure-SSIS 集成运行时要加入的子网的 ID。

IntegrationRuntimeCustomSetupScriptProperties

Object

托管专用集成运行时的自定义设置脚本属性。

名称	类型	说明
blobContainerUri	string	包含自定义安装脚本的 Azure Blob 容器的 URI。
sasToken	SecureString	Azure Blob 容器的 SAS 令牌。

IntegrationRuntimeDataFlowProperties

Object

托管集成运行时的数据流属性。

名称	类型	说明
computeType	DataFlowComputeType	将执行数据流作业的群集的计算类型。
coreCount	integer (int32)	将执行数据流作业的群集的核心计数。支持的值为：8、16、32、48、80、144 和 272。
timeToLive	integer (int32) minimum: 0	将执行数据流作业的群集生存时间（以分钟为单位）。

IntegrationRuntimeDataProxyProperties

Object

托管专用集成运行时的数据代理属性。

名称	类型	说明
connectVia	EntityReference	自承载集成运行时参考。
path	string	包含 Blob 存储中暂存数据的路径。
stagingLinkedService	EntityReference	暂存链接服务引用。

IntegrationRuntimeEdition

枚举

SSIS Integration Runtime 的版本

值	说明
Standard
Enterprise

IntegrationRuntimeEntityReferenceType

枚举

此引用实体的类型。

值	说明
IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

枚举

用于自带许可证方案的许可证类型。

值	说明
BasePrice
LicenseIncluded

IntegrationRuntimeResource

Object

集成运行时资源类型。

名称	类型	说明
etag	string	资源 Etag。
id	string	资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	集成运行时属性。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

IntegrationRuntimeSsisCatalogInfo

Object

托管专用集成运行时的目录信息。

名称	类型	说明
catalogAdminPassword	SecureString	目录数据库的管理员用户帐户的密码。
catalogAdminUserName	string minLength: 1 maxLength: 128	目录数据库的管理员用户名。
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
Standard
Premium
PremiumRS

IntegrationRuntimeSsisProperties

Object

托管集成运行时的 SSIS 属性。

名称	类型	说明
catalogInfo	IntegrationRuntimeSsisCatalogInfo	托管专用集成运行时的目录信息。
customSetupScriptProperties	IntegrationRuntimeCustomSetupScriptProperties	托管专用集成运行时的自定义设置脚本属性。
dataProxyProperties	IntegrationRuntimeDataProxyProperties	托管专用集成运行时的数据代理属性。
edition	IntegrationRuntimeEdition	SSIS Integration Runtime 的版本
expressCustomSetupProperties	CustomSetupBase[]	没有 SSIS 集成运行时的脚本属性的自定义设置。
licenseType	IntegrationRuntimeLicenseType	用于自带许可证方案的许可证类型。

IntegrationRuntimeState

枚举

集成运行时的状态。

值	说明
Initial
Stopped
Started
Starting
Stopping
NeedRegistration
Online
Limited
Offline
AccessDenied

IntegrationRuntimeType

枚举

集成运行时的类型。

值	说明
Managed
SelfHosted

IntegrationRuntimeVNetProperties

Object

托管集成运行时的 VNet 属性。

名称	类型	说明
publicIPs	string[]	此集成运行时将使用的公共 IP 地址的资源 ID。
subnet	string	此集成运行时将加入的子网的名称。
subnetId	string	要加入此 Azure-SSIS 集成运行时的子网 ID。
vNetId	string	此集成运行时将加入的 VNet 的 ID。

LinkedIntegrationRuntimeKeyAuthorization

Object

密钥授权类型集成运行时。

名称	类型	说明
authorizationType	string: Key	集成运行时共享的授权类型。
key	SecureString	用于授权的密钥。

LinkedIntegrationRuntimeRbacAuthorization

Object

基于角色的访问控制（RBAC）授权类型集成运行时。

名称	类型	说明
authorizationType	string: RBAC	集成运行时共享的授权类型。
resourceId	string	要共享的集成运行时的资源标识符。

ManagedIntegrationRuntime

Object

托管集成运行时，包括托管的弹性和托管的专用集成运行时。

名称	类型	说明
description	string	集成运行时说明。
managedVirtualNetwork.id	string	托管虚拟网络的 ID。
managedVirtualNetwork.referenceName	string	托管虚拟网络的引用名称
managedVirtualNetwork.type	string	托管虚拟网络的类型。
provisioningState	IntegrationRuntimeState	集成运行时状态，仅适用于托管专用集成运行时。
type	string: Managed	集成运行时的类型。
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	托管集成运行时的计算资源。
typeProperties.customerVirtualNetwork	IntegrationRuntimeCustomerVirtualNetwork	Azure-SSIS 集成运行时要加入的虚拟网络的名称
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	托管集成运行时的 SSIS 属性。

SecureString

Object

Azure Synapse 安全字符串定义。在获取或列出 API 调用期间，字符串值将用星号“*”屏蔽。

名称	类型	说明
type	string: SecureString	机密的类型。
value	string	安全字符串的值。

SelfHostedIntegrationRuntime

Object

自承载集成运行时。

名称	类型	说明
description	string	集成运行时说明。
type	string: SelfHosted	集成运行时的类型。
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	数据工厂中的链接集成运行时类型

通过

Integration Runtimes - Get

URI 参数

请求头

响应

示例

Get integration runtime

示例请求

示例响应

定义

DataFlowComputeType

EntityReference

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IntegrationRuntimeComputeProperties

IntegrationRuntimeCustomerVirtualNetwork

IntegrationRuntimeCustomSetupScriptProperties

IntegrationRuntimeDataFlowProperties

IntegrationRuntimeDataProxyProperties

IntegrationRuntimeEdition

IntegrationRuntimeEntityReferenceType

IntegrationRuntimeLicenseType

IntegrationRuntimeResource

IntegrationRuntimeSsisCatalogInfo

IntegrationRuntimeSsisCatalogPricingTier

IntegrationRuntimeSsisProperties

IntegrationRuntimeState

IntegrationRuntimeType

IntegrationRuntimeVNetProperties

LinkedIntegrationRuntimeKeyAuthorization

LinkedIntegrationRuntimeRbacAuthorization

ManagedIntegrationRuntime

SecureString

SelfHostedIntegrationRuntime