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

Integration Runtimes - List

列出集成运行时

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

URI 参数

Name In Required Type Description
endpoint
path True
  • string
uri

工作区开发终结点,例如 https://myworkspace.dev.azuresynapse.net

api-version
query True
  • string

Synapse 客户端 API 版本。

响应

Name Type Description
200 OK

成功响应。

Other Status Codes

描述操作失败的原因的错误响应。

示例

List Integration Runtimes

Sample Request

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

Sample Response

{
  "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"
    }
  ]
}
{
  "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

目录数据库的定价层。 The valid values could be found in 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

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

Name Type Description
ComputeOptimized
  • string
General
  • string
MemoryOptimized
  • string

EntityReference

实体引用。

Name Type Description
referenceName
  • string

此引用实体的名称。

type

此引用实体的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorContract

错误详细信息。

Name Type Description
error

错误响应
错误详细信息。

ErrorResponse

错误响应

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

IntegrationRuntimeComputeProperties

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

Name Type Description
dataFlowProperties

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

location
  • string

托管集成运行时的位置。 可以在 上找到受支持的区域 https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities

maxParallelExecutionsPerNode
  • integer

托管集成运行时每个节点的最大并行执行计数。

nodeSize
  • string

托管集成运行时的节点大小要求。

numberOfNodes
  • integer

托管集成运行时所需的节点数。

vNetProperties

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

IntegrationRuntimeCustomSetupScriptProperties

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

Name Type Description
blobContainerUri
  • string

包含自定义安装脚本的 Azure Blob 容器的 URI。

sasToken

Azure Blob 容器的 SAS 令牌。

IntegrationRuntimeDataFlowProperties

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

Name Type Description
cleanup
  • boolean

群集不会回收,并且将在下一个数据流活动运行中使用它,直到 TTL (生存时间达到) (如果设置为 false)。 默认为 true。

computeType

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

coreCount
  • integer

将执行数据流作业的群集的核心计数。 支持的值为:8、16、32、48、80、144 和 272。

timeToLive
  • integer

) 将执行数据流作业的群集设置 (生存时间(以分钟为单位)。

IntegrationRuntimeDataProxyProperties

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

Name Type Description
connectVia

自承载集成运行时参考。

path
  • string

包含 Blob 存储中暂存数据的路径。

stagingLinkedService

暂存链接服务引用。

IntegrationRuntimeEdition

SSIS Integration Runtime的版本

Name Type Description
Enterprise
  • string
Standard
  • string

IntegrationRuntimeEntityReferenceType

此引用实体的类型。

Name Type Description
IntegrationRuntimeReference
  • string
LinkedServiceReference
  • string

IntegrationRuntimeLicenseType

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

Name Type Description
BasePrice
  • string
LicenseIncluded
  • string

IntegrationRuntimeListResponse

集成运行时资源的列表。

Name Type Description
nextLink
  • string

指向下一页结果的链接(如果存在任何剩余的结果)。

value

集成运行时列表。

IntegrationRuntimeResource

集成运行时资源类型。

Name Type Description
etag
  • string

资源 Etag。

id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties IntegrationRuntime:

集成运行时属性。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

IntegrationRuntimeSsisCatalogInfo

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

Name Type Description
catalogAdminPassword

目录数据库的管理员用户帐户的密码。

catalogAdminUserName
  • string

目录数据库的管理员用户名。

catalogPricingTier

目录数据库的定价层。 The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/

catalogServerEndpoint
  • string

目录数据库服务器 URL。

IntegrationRuntimeSsisCatalogPricingTier

目录数据库的定价层。 The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/

Name Type Description
Basic
  • string
Premium
  • string
PremiumRS
  • string
Standard
  • string

IntegrationRuntimeSsisProperties

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

Name Type Description
catalogInfo

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

customSetupScriptProperties

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

dataProxyProperties

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

edition

SSIS Integration Runtime的版本

expressCustomSetupProperties
  • CustomSetupBase[]

没有 SSIS 集成运行时脚本属性的自定义设置。

licenseType

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

IntegrationRuntimeState

集成运行时的状态。

Name Type Description
AccessDenied
  • string
Initial
  • string
Limited
  • string
NeedRegistration
  • string
Offline
  • string
Online
  • string
Started
  • string
Starting
  • string
Stopped
  • string
Stopping
  • string

IntegrationRuntimeType

集成运行时的类型。

Name Type Description
Managed
  • string
SelfHosted
  • string

IntegrationRuntimeVNetProperties

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

Name Type Description
publicIPs
  • string[]

此集成运行时将使用的公共 IP 地址的资源 ID。

subnet
  • string

此集成运行时将加入的子网的名称。

vNetId
  • string

此集成运行时将加入的 VNet 的 ID。

LinkedIntegrationRuntimeKeyAuthorization

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

Name Type Description
authorizationType string:
  • Key

集成运行时共享的授权类型。

key

用于授权的密钥。

LinkedIntegrationRuntimeRbacAuthorization

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

Name Type Description
authorizationType string:
  • RBAC

集成运行时共享的授权类型。

resourceId
  • string

要共享的集成运行时的资源标识符。

ManagedIntegrationRuntime

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

Name Type Description
description
  • string

集成运行时说明。

managedVirtualNetwork

托管虚拟网络参考。

state

集成运行时状态,仅适用于托管专用集成运行时。

type string:
  • Managed

集成运行时的类型。

typeProperties.computeProperties

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

typeProperties.ssisProperties

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

ManagedVirtualNetworkReference

托管虚拟网络引用类型。

Name Type Description
referenceName
  • string

引用 ManagedVirtualNetwork 名称。

type enum:

托管虚拟网络引用类型。

SecureString

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

Name Type Description
type string:

机密的类型。

value
  • string

安全字符串的值。

SelfHostedIntegrationRuntime

自承载集成运行时。

Name Type Description
description
  • string

集成运行时说明。

type string:
  • SelfHosted

集成运行时的类型。

typeProperties.linkedInfo LinkedIntegrationRuntimeType:

来自数据工厂的链接集成运行时类型