Integration Runtimes - List By Factory

服务:

Data Factory

API 版本:

2018-06-01

列出集成运行时。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes?api-version=2018-06-01

URI 参数

名称	在	必需	类型	说明
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	工厂名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	资源组名称。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 版本。

响应

名称	类型	说明
200 OK	IntegrationRuntimeListResponse	还行。
Other Status Codes	CloudError	从 Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

IntegrationRuntimes_ListByFactory

示例请求

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes?api-version=2018-06-01

Java

/**
 * Samples for IntegrationRuntimes ListByFactory.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_ListByFactory.json
     */
    /**
     * Sample code: IntegrationRuntimes_ListByFactory.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void
        integrationRuntimesListByFactory(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().listByFactory("exampleResourceGroup", "exampleFactoryName",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python integration_runtimes_list_by_factory.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.integration_runtimes.list_by_factory(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListByFactory.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v10"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8eb3f7a4f66d408152c32b9d647e59147172d533/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListByFactory.json
func ExampleIntegrationRuntimesClient_NewListByFactoryPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewIntegrationRuntimesClient().NewListByFactoryPager("exampleResourceGroup", "exampleFactoryName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.IntegrationRuntimeListResponse = armdatafactory.IntegrationRuntimeListResponse{
		// 	Value: []*armdatafactory.IntegrationRuntimeResource{
		// 		{
		// 			Name: to.Ptr("exampleIntegrationRuntime"),
		// 			Type: to.Ptr("Microsoft.DataFactory/factories/integrationruntimes"),
		// 			Etag: to.Ptr("0400f1a1-0000-0000-0000-5b2188640000"),
		// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationruntimes/exampleIntegrationRuntime"),
		// 			Properties: &armdatafactory.SelfHostedIntegrationRuntime{
		// 				Type: to.Ptr(armdatafactory.IntegrationRuntimeTypeSelfHosted),
		// 				Description: to.Ptr("A selfhosted integration runtime"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists integration runtimes.
 *
 * @summary Lists integration runtimes.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListByFactory.json
 */
async function integrationRuntimesListByFactory() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.integrationRuntimes.listByFactory(resourceGroupName, factoryName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListByFactory.json
// this example is just showing the usage of "IntegrationRuntimes_ListByFactory" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// get the collection of this DataFactoryIntegrationRuntimeResource
DataFactoryIntegrationRuntimeCollection collection = dataFactory.GetDataFactoryIntegrationRuntimes();

// invoke the operation and iterate over the result
await foreach (DataFactoryIntegrationRuntimeResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DataFactoryIntegrationRuntimeData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

Date: Wed, 13 Jun 2018 21:33:05 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14909
x-ms-request-id: f632df92-1140-4e19-9e19-0b1c8cbe393b
x-ms-correlation-request-id: f632df92-1140-4e19-9e19-0b1c8cbe393b

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

定义

名称	说明
CloudError	定义 Azure 数据工厂错误响应结构的对象。
CopyComputeScaleProperties	托管集成运行时的 CopyComputeScale 属性。
CredentialReference	凭据引用类型。
CredentialReferenceType	凭据引用类型。
CustomProperties	自定义属性用于优化数据流运行时性能。
DataFlowComputeType	将执行数据流作业的群集的计算类型。
EntityReference	实体引用。
IntegrationRuntimeComputeProperties	托管集成运行时的计算资源属性。
IntegrationRuntimeCustomerVirtualNetwork	Azure-SSIS 集成运行时要加入的虚拟网络的定义和属性。
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	托管虚拟网络引用类型。
ManagedVirtualNetworkReferenceType	托管虚拟网络引用类型。
PackageStore	SSIS 集成运行时的包存储。
PipelineExternalComputeScaleProperties	托管集成运行时的 PipelineExternalComputeScale 属性。
SecureString	Azure 数据工厂安全字符串定义。 在获取或列出 API 调用期间，字符串值将用星号“*”屏蔽。
SelfHostedIntegrationRuntime	自承载集成运行时。

CloudError

Object

定义 Azure 数据工厂错误响应结构的对象。

名称	类型	说明
error.code	string	错误代码。
error.details	CloudError[]	包含其他错误详细信息的数组。
error.message	string	错误信息。
error.target	string	与错误关联的请求中的属性名称/路径。

CopyComputeScaleProperties

Object

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

名称	类型	说明
dataIntegrationUnit	integer (int32) minimum: 4	为复制活动执行保留的 DIU 编号设置。 支持的值是 4-256 范围内的 4 的倍数。
timeToLive	integer (int32) minimum: 5	集成运行时的生存时间（以分钟为单位），该设置将执行复制活动。

CredentialReference

Object

凭据引用类型。

名称	类型	说明
referenceName	string	引用凭据名称。
type	CredentialReferenceType	凭据引用类型。

CredentialReferenceType

枚举

凭据引用类型。

值	说明
CredentialReference

CustomProperties

Object

自定义属性用于优化数据流运行时性能。

名称	类型	说明
name	string	自定义属性的名称。
value	string	自定义属性的值。

DataFlowComputeType

枚举

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

值	说明
ComputeOptimized
General
MemoryOptimized

EntityReference

Object

实体引用。

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

IntegrationRuntimeComputeProperties

Object

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

名称	类型	说明
copyComputeScaleProperties	CopyComputeScaleProperties	托管集成运行时的 CopyComputeScale 属性。
dataFlowProperties	IntegrationRuntimeDataFlowProperties	托管集成运行时的数据流属性。
location	string	托管集成运行时的位置。 可在 https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities 找到支持的区域
maxParallelExecutionsPerNode	integer minimum: 1	托管集成运行时每个节点的最大并行执行计数。
nodeSize	string	托管集成运行时的节点大小要求。
numberOfNodes	integer minimum: 1	托管集成运行时所需的节点数。
pipelineExternalComputeScaleProperties	PipelineExternalComputeScaleProperties	托管集成运行时的 PipelineExternalComputeScale 属性。
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

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

名称	类型	说明
cleanup	boolean	群集不会回收，并且将在下一个数据流活动运行中使用，直到达到 TTL（生存时间）（如果设置为 false）。 默认值为 true。
computeType	DataFlowComputeType	将执行数据流作业的群集的计算类型。
coreCount	integer	将执行数据流作业的群集的核心计数。 支持的值为：8、16、32、48、80、144 和 272。
customProperties	CustomProperties[]	自定义属性用于优化数据流运行时性能。
timeToLive	integer minimum: 0	将执行数据流作业的群集生存时间（以分钟为单位）。

IntegrationRuntimeDataProxyProperties

Object

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

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

IntegrationRuntimeEdition

枚举

SSIS Integration Runtime 的版本

值	说明
Enterprise
Standard

IntegrationRuntimeEntityReferenceType

枚举

此引用实体的类型。

值	说明
IntegrationRuntimeReference
LinkedServiceReference

IntegrationRuntimeLicenseType

枚举

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

值	说明
BasePrice
LicenseIncluded

IntegrationRuntimeListResponse

Object

集成运行时资源的列表。

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

IntegrationRuntimeResource

Object

集成运行时资源类型。

名称	类型	说明
etag	string	Etag 标识资源中的更改。
id	string	资源标识符。
name	string	资源名称。
properties	IntegrationRuntime: ManagedIntegrationRuntime SelfHostedIntegrationRuntime	集成运行时属性。
type	string	资源类型。

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。
dualStandbyPairName	string	用于支持 SSISDB 故障转移的 Azure-SSIS Integration Runtime 的双备用对名称。

IntegrationRuntimeSsisCatalogPricingTier

枚举

目录数据库的定价层。 可以在 https://azure.microsoft.com/en-us/pricing/details/sql-database/ 中找到有效值

值	说明
Basic
Premium
PremiumRS
Standard

IntegrationRuntimeSsisProperties

Object

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

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

IntegrationRuntimeState

枚举

集成运行时的状态。

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

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	集成运行时共享的授权类型。
credential	CredentialReference	包含身份验证信息的凭据引用。
resourceId	string	要共享的集成运行时的资源标识符。

ManagedIntegrationRuntime

Object

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

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

ManagedVirtualNetworkReference

Object

托管虚拟网络引用类型。

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

ManagedVirtualNetworkReferenceType

枚举

托管虚拟网络引用类型。

值	说明
ManagedVirtualNetworkReference

PackageStore

Object

SSIS 集成运行时的包存储。

名称	类型	说明
name	string	包存储的名称
packageStoreLinkedService	EntityReference	包存储链接服务引用。

PipelineExternalComputeScaleProperties

Object

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

名称	类型	说明
numberOfExternalNodes	integer (int32) minimum: 1 maximum: 10	外部节点的数目，应大于 0 且小于 11。
numberOfPipelineNodes	integer (int32) minimum: 1 maximum: 10	管道节点的数目，应大于 0 且小于 11。
timeToLive	integer (int32) minimum: 5	集成运行时的生存时间（以分钟为单位），该设置将执行管道和外部活动。

SecureString

Object

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

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

SelfHostedIntegrationRuntime

Object

自承载集成运行时。

名称	类型	说明
description	string	集成运行时说明。
type	string: SelfHosted	集成运行时的类型。
typeProperties.linkedInfo	LinkedIntegrationRuntimeType: LinkedIntegrationRuntimeKeyAuthorization LinkedIntegrationRuntimeRbacAuthorization	链接集成运行时的基本定义。
typeProperties.selfContainedInteractiveAuthoringEnabled	boolean	当自承载集成运行时无法与 Azure 中继建立连接时，确保交互式创作函数的替代选项。