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

Integration Runtimes - Start

参考

服务:: Data Factory

API 版本:: 2018-06-01

启动 ManagedReserved 类型集成运行时。

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

URI 参数

名称	在	必需	类型	说明
factoryName	path	True	string	工厂名称。正则表达式模式: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
integrationRuntimeName	path	True	string	集成运行时名称。正则表达式模式: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	资源组名称。正则表达式模式: `^[-\w\._\(\)]+$`
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 版本。

响应

名称	类型	说明
200 OK	IntegrationRuntimeStatusResponse	没问题。
202 Accepted		已接受。
Other Status Codes	CloudError	从Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

IntegrationRuntimes_Start

示例请求

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


/**
 * Samples for IntegrationRuntimes Start.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_Start.json
     */
    /**
     * Sample code: IntegrationRuntimes_Start.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void integrationRuntimesStart(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().start("exampleResourceGroup", "exampleFactoryName",
            "exampleManagedIntegrationRuntime", 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

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_start.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.begin_start(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="exampleManagedIntegrationRuntime",
    ).result()
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.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

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/v9"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json
func ExampleIntegrationRuntimesClient_BeginStart() {
	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)
	}
	poller, err := clientFactory.NewIntegrationRuntimesClient().BeginStart(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleManagedIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeStatusResponse = armdatafactory.IntegrationRuntimeStatusResponse{
	// 	Name: to.Ptr("exampleManagedIntegrationRuntime"),
	// 	Properties: &armdatafactory.ManagedIntegrationRuntimeStatus{
	// 		Type: to.Ptr(armdatafactory.IntegrationRuntimeTypeManaged),
	// 		DataFactoryName: to.Ptr("exampleFactoryName"),
	// 		State: to.Ptr(armdatafactory.IntegrationRuntimeStateStarted),
	// 		TypeProperties: &armdatafactory.ManagedIntegrationRuntimeStatusTypeProperties{
	// 			CreateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-13T21:11:01.869Z"); return t}()),
	// 			Nodes: []*armdatafactory.ManagedIntegrationRuntimeNode{
	// 			},
	// 			OtherErrors: []*armdatafactory.ManagedIntegrationRuntimeError{
	// 			},
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Starts a ManagedReserved type integration runtime.
 *
 * @summary Starts a ManagedReserved type integration runtime.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_Start.json
 */
async function integrationRuntimesStart() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const integrationRuntimeName = "exampleManagedIntegrationRuntime";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.beginStartAndWait(
    resourceGroupName,
    factoryName,
    integrationRuntimeName,
  );
  console.log(result);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
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_Start.json
// this example is just showing the usage of "IntegrationRuntimes_Start" 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 DataFactoryIntegrationRuntimeResource created on azure
// for more information of creating DataFactoryIntegrationRuntimeResource, please refer to the document of DataFactoryIntegrationRuntimeResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string integrationRuntimeName = "exampleManagedIntegrationRuntime";
ResourceIdentifier dataFactoryIntegrationRuntimeResourceId = DataFactoryIntegrationRuntimeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, integrationRuntimeName);
DataFactoryIntegrationRuntimeResource dataFactoryIntegrationRuntime = client.GetDataFactoryIntegrationRuntimeResource(dataFactoryIntegrationRuntimeResourceId);

// invoke the operation
ArmOperation<DataFactoryIntegrationRuntimeStatusResult> lro = await dataFactoryIntegrationRuntime.StartAsync(WaitUntil.Completed);
DataFactoryIntegrationRuntimeStatusResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:: 202

状态代码:: 200

Date: Wed, 13 Jun 2018 21:33:00 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14912
x-ms-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677
x-ms-correlation-request-id: 2af47f9f-5625-4b01-a3a5-bccb576a4677

{
  "name": "exampleManagedIntegrationRuntime",
  "properties": {
    "dataFactoryName": "exampleFactoryName",
    "type": "Managed",
    "state": "Started",
    "typeProperties": {
      "nodes": [],
      "otherErrors": [],
      "createTime": "2018-06-13T21:11:01.8695494Z"
    }
  }
}

定义

名称	说明
CloudError	定义Azure 数据工厂错误响应结构的对象。
IntegrationRuntimeAutoUpdate	集成运行时自动更新的状态。
IntegrationRuntimeInternalChannelEncryptionMode	当) 存在 2 个以上的自承载集成运行时节点时，它用于设置节点-节点信道 (的加密模式。
IntegrationRuntimeState	集成运行时的状态。
IntegrationRuntimeStatusResponse	集成运行时状态响应。
IntegrationRuntimeType	集成运行时的类型。
IntegrationRuntimeUpdateResult	上次集成运行时节点更新的结果。
LinkedIntegrationRuntime	链接的集成运行时信息。
ManagedIntegrationRuntimeError	托管集成运行时的错误定义。
ManagedIntegrationRuntimeNode	集成运行时节点的属性。
ManagedIntegrationRuntimeNodeStatus	托管集成运行时节点状态。
ManagedIntegrationRuntimeOperationResult	托管集成运行时操作结果的属性。
ManagedIntegrationRuntimeStatus	托管集成运行时状态。
SelfHostedIntegrationRuntimeNode	自承载集成运行时节点的属性。
SelfHostedIntegrationRuntimeNodeStatus	集成运行时节点的状态。
SelfHostedIntegrationRuntimeStatus	自承载集成运行时状态。

CloudError

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

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

IntegrationRuntimeAutoUpdate

集成运行时自动更新的状态。

名称	类型	说明
Off	string
On	string

IntegrationRuntimeInternalChannelEncryptionMode

当) 存在 2 个以上的自承载集成运行时节点时，它用于设置节点-节点信道 (的加密模式。

名称	类型	说明
NotEncrypted	string
NotSet	string
SslEncrypted	string

IntegrationRuntimeState

集成运行时的状态。

名称	类型	说明
AccessDenied	string
Initial	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Started	string
Starting	string
Stopped	string
Stopping	string

IntegrationRuntimeStatusResponse

集成运行时状态响应。

名称	类型	说明
name	string	集成运行时名称。
properties	IntegrationRuntimeStatus: ManagedIntegrationRuntimeStatus SelfHostedIntegrationRuntimeStatus	集成运行时属性。

IntegrationRuntimeType

集成运行时的类型。

名称	类型	说明
Managed	string
SelfHosted	string

IntegrationRuntimeUpdateResult

上次集成运行时节点更新的结果。

名称	类型	说明
Fail	string
None	string
Succeed	string

LinkedIntegrationRuntime

链接的集成运行时信息。

名称	类型	说明
createTime	string	链接集成运行时的创建时间。
dataFactoryLocation	string	链接集成运行时所属的数据工厂的位置。
dataFactoryName	string	链接集成运行时所属的数据工厂的名称。
name	string	链接集成运行时的名称。
subscriptionId	string	链接集成运行时所属的订阅 ID。

ManagedIntegrationRuntimeError

托管集成运行时的错误定义。

名称	类型	说明
code	string	错误代码。
message	string	错误消息。
parameters	string[]	托管集成运行时错误参数。
time	string	发生错误的时间。

ManagedIntegrationRuntimeNode

集成运行时节点的属性。

名称	类型	说明
errors	ManagedIntegrationRuntimeError[]	此集成运行时节点上发生的错误。
nodeId	string	托管集成运行时节点 ID。
status	ManagedIntegrationRuntimeNodeStatus	托管集成运行时节点状态。

ManagedIntegrationRuntimeNodeStatus

托管集成运行时节点状态。

名称	类型	说明
Available	string
Recycling	string
Starting	string
Unavailable	string

ManagedIntegrationRuntimeOperationResult

托管集成运行时操作结果的属性。

名称	类型	说明
activityId	string	操作请求的活动 ID。
errorCode	string	错误代码。
parameters	string[]	托管集成运行时错误参数。
result	string	操作结果。
startTime	string	操作的开始时间。
type	string	运算类型。可以是启动或停止。

ManagedIntegrationRuntimeStatus

托管集成运行时状态。

名称	类型	说明
dataFactoryName	string	集成运行时所属的数据工厂名称。
state	IntegrationRuntimeState	集成运行时的状态。
type	string: Managed	集成运行时的类型。
typeProperties.createTime	string	创建集成运行时的时间，采用ISO8601格式。
typeProperties.lastOperation	ManagedIntegrationRuntimeOperationResult	此集成运行时上发生的最后一个操作结果。
typeProperties.nodes	ManagedIntegrationRuntimeNode[]	托管集成运行时的节点列表。
typeProperties.otherErrors	ManagedIntegrationRuntimeError[]	此集成运行时上发生的错误。

SelfHostedIntegrationRuntimeNode

自承载集成运行时节点的属性。

名称	类型	说明
capabilities	object	集成运行时功能字典
concurrentJobsLimit	integer	集成运行时节点上的最大并发作业数。
expiryTime	string	集成运行时以ISO8601格式过期的时间。
hostServiceUri	string	集成运行时主机的 URI。
isActiveDispatcher	boolean	指示此节点是否为集成运行时请求的活动调度程序。
lastConnectTime	string	最近以ISO8601格式连接集成运行时的时间。
lastEndUpdateTime	string	集成运行时节点更新结束的最后时间。
lastStartTime	string	节点上次启动的时间。
lastStartUpdateTime	string	集成运行时节点更新的上次启动时间。
lastStopTime	string	集成运行时节点上次停止时间。
lastUpdateResult	IntegrationRuntimeUpdateResult	上次集成运行时节点更新的结果。
machineName	string	集成运行时节点的计算机名称。
maxConcurrentJobs	integer	此集成运行时中的最大并发作业数。
nodeName	string	集成运行时节点的名称。
registerTime	string	以ISO8601格式注册集成运行时节点的时间。
status	SelfHostedIntegrationRuntimeNodeStatus	集成运行时节点的状态。
version	string	集成运行时节点的版本。
versionStatus	string	集成运行时节点版本的状态。

SelfHostedIntegrationRuntimeNodeStatus

集成运行时节点的状态。

名称	类型	说明
InitializeFailed	string
Initializing	string
Limited	string
NeedRegistration	string
Offline	string
Online	string
Upgrading	string

SelfHostedIntegrationRuntimeStatus

自承载集成运行时状态。

名称	类型	说明
dataFactoryName	string	集成运行时所属的数据工厂名称。
state	IntegrationRuntimeState	集成运行时的状态。
type	string: SelfHosted	集成运行时的类型。
typeProperties.autoUpdate	IntegrationRuntimeAutoUpdate	是否已启用自承载集成运行时自动更新。
typeProperties.autoUpdateETA	string	自承载集成运行时的估计更新时间。
typeProperties.capabilities	object	包含有关集成运行时功能的其他信息的对象。
typeProperties.createTime	string	创建集成运行时的时间，采用ISO8601格式。
typeProperties.internalChannelEncryption	IntegrationRuntimeInternalChannelEncryptionMode	当) 存在 2 个以上的自承载集成运行时节点时，它用于设置节点-节点信道 (的加密模式。
typeProperties.latestVersion	string	下载中心上的最新版本。
typeProperties.links	LinkedIntegrationRuntime[]	创建用于与该集成运行时共享的链接集成运行时的列表。
typeProperties.localTimeZoneOffset	string	以小时为单位的本地时区偏移量。
typeProperties.nodes	SelfHostedIntegrationRuntimeNode[]	此集成运行时的节点列表。
typeProperties.pushedVersion	string	集成运行时要更新到的版本。
typeProperties.scheduledUpdateDate	string	计划更新集成运行时的日期，采用ISO8601格式。
typeProperties.selfContainedInteractiveAuthoringEnabled	boolean	当自承载集成运行时无法与 Azure 中继建立连接时，确保交互式创作功能的另一个选项。
typeProperties.serviceUrls	string[]	集成运行时后端服务中使用的服务的 URL。
typeProperties.taskQueueId	string	集成运行时的任务队列 ID。
typeProperties.updateDelayOffset	string	服务计划更新集成运行时的日期中的时间，例如 PT03H 为 3 小时
typeProperties.version	string	集成运行时的版本。
typeProperties.versionStatus	string	集成运行时版本的状态。