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

Integration Runtimes - List

参考

Service:: Synapse

API Version:: 2020-12-01

列出集成运行时

GET {endpoint}/integrationRuntimes?api-version=2020-12-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string uri	工作区开发终结点，例如 `https://myworkspace.dev.azuresynapse.net` 。
api-version	query	True	string	Synapse 客户端 API 版本。

响应

名称	类型	说明
200 OK	IntegrationRuntimeListResponse	成功响应。
Other Status Codes	ErrorContract	描述操作失败原因的错误响应。

示例

List Integration Runtimes

Sample Request

HTTP

GET exampleWorkspace.dev.azuresynapse.net/integrationRuntimes?api-version=2020-12-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationruntimes/exampleIntegrationRuntime",
      "name": "exampleIntegrationRuntime",
      "type": "Microsoft.Synapse/workspaces/integrationruntimes",
      "properties": {
        "type": "SelfHosted",
        "description": "A selfhosted integration runtime"
      },
      "etag": "0400f1a1-0000-0000-0000-5b2188640000"
    }
  ]
}

Status code:: default

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

定义

名称	说明
DataFlowComputeType	将执行数据流作业的群集的计算类型。
EntityReference	实体引用。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorContract	错误详细信息。
ErrorResponse	错误响应
IntegrationRuntimeComputeProperties	托管集成运行时的计算资源属性。
IntegrationRuntimeCustomSetupScriptProperties	托管专用集成运行时的自定义安装脚本属性。
IntegrationRuntimeDataFlowProperties	托管集成运行时的数据流属性。
IntegrationRuntimeDataProxyProperties	托管专用集成运行时的数据代理属性。
IntegrationRuntimeEdition	SSIS Integration Runtime的版本
IntegrationRuntimeEntityReferenceType	此引用实体的类型。
IntegrationRuntimeLicenseType	用于自带许可证方案的许可证类型。
IntegrationRuntimeListResponse	集成运行时资源的列表。
IntegrationRuntimeResource	集成运行时资源类型。
IntegrationRuntimeSsisCatalogInfo	托管专用集成运行时的目录信息。
IntegrationRuntimeSsisCatalogPricingTier	目录数据库的定价层。有效值可在 https://azure.microsoft.com/en-us/pricing/details/sql-database/
IntegrationRuntimeSsisProperties	托管集成运行时的 SSIS 属性。
IntegrationRuntimeState	集成运行时的状态。
IntegrationRuntimeType	集成运行时的类型。
IntegrationRuntimeVNetProperties	托管集成运行时的 VNet 属性。
LinkedIntegrationRuntimeKeyAuthorization	密钥授权类型集成运行时。
LinkedIntegrationRuntimeRbacAuthorization	基于角色的访问控制 (RBAC) 授权类型集成运行时。
ManagedIntegrationRuntime	托管集成运行时，包括托管弹性和托管专用集成运行时。
ManagedVirtualNetworkReference	托管虚拟网络引用类型。
SecureString	Azure Synapse安全字符串定义。在 Get 或 List API 调用期间，字符串值将屏蔽星号“*”。
SelfHostedIntegrationRuntime	自承载集成运行时。

DataFlowComputeType

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

名称	类型	说明
ComputeOptimized	string
General	string
MemoryOptimized	string

EntityReference

实体引用。

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

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorContract

错误详细信息。

名称	类型	说明
error	ErrorResponse	错误响应错误详细信息。

ErrorResponse

错误响应

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

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	托管集成运行时的 VNet 属性。

IntegrationRuntimeCustomSetupScriptProperties

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

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

IntegrationRuntimeDataFlowProperties

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

名称	类型	说明
cleanup	boolean	群集不会被回收，并且将用于下一个数据流活动运行，直到 TTL (生存时间达到，) 如果设置为 false，则群集将达到生存时间。默认为 true。
computeType	DataFlowComputeType	将执行数据流作业的群集的计算类型。
coreCount	integer	将执行数据流作业的群集的核心计数。支持的值包括：8、16、32、48、80、144 和 272。
timeToLive	integer	执行数据流作业的群集) 设置 (生存时间（以分钟为单位）。

IntegrationRuntimeDataProxyProperties

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

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

IntegrationRuntimeEdition

SSIS Integration Runtime的版本

名称	类型	说明
Enterprise	string
Standard	string

IntegrationRuntimeEntityReferenceType

此引用实体的类型。

名称	类型	说明
IntegrationRuntimeReference	string
LinkedServiceReference	string

IntegrationRuntimeLicenseType

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

名称	类型	说明
BasePrice	string
LicenseIncluded	string

IntegrationRuntimeListResponse

集成运行时资源的列表。

名称	类型	说明
nextLink	string	指向下一页结果的链接（如果存在任何剩余结果）。
value	IntegrationRuntimeResource[]	集成运行时的列表。

IntegrationRuntimeResource

集成运行时资源类型。

名称	类型	说明
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

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

名称	类型	说明
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 Integration Runtime的版本
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

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

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

LinkedIntegrationRuntimeKeyAuthorization

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

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

LinkedIntegrationRuntimeRbacAuthorization

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

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

ManagedIntegrationRuntime

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

名称	类型	说明
description	string	集成运行时说明。
managedVirtualNetwork	ManagedVirtualNetworkReference	托管虚拟网络参考。
state	IntegrationRuntimeState	集成运行时状态，仅对托管专用集成运行时有效。
type	string: Managed	集成运行时的类型。
typeProperties.computeProperties	IntegrationRuntimeComputeProperties	托管集成运行时的计算资源。
typeProperties.ssisProperties	IntegrationRuntimeSsisProperties	托管集成运行时的 SSIS 属性。

ManagedVirtualNetworkReference

托管虚拟网络引用类型。

名称	类型	说明
referenceName	string	引用 ManagedVirtualNetwork 名称。
type	enum: ManagedVirtualNetworkReference	托管虚拟网络引用类型。

SecureString

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

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

SelfHostedIntegrationRuntime

自承载集成运行时。

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