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

Integration Runtimes - Get Status

服务:: Data Factory

API 版本:: 2018-06-01

获取集成运行时的详细状态信息。

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

URI 参数

名称	在	必需	类型	说明
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	工厂名称。
integrationRuntimeName	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	IntegrationRuntimeStatusResponse	还行。
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_GetStatus

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

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/DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.json
// this example is just showing the usage of "IntegrationRuntimes_GetStatus" 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 = "exampleIntegrationRuntime";
ResourceIdentifier dataFactoryIntegrationRuntimeResourceId = DataFactoryIntegrationRuntimeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, integrationRuntimeName);
DataFactoryIntegrationRuntimeResource dataFactoryIntegrationRuntime = client.GetDataFactoryIntegrationRuntimeResource(dataFactoryIntegrationRuntimeResourceId);

// invoke the operation
DataFactoryIntegrationRuntimeStatusResult result = await dataFactoryIntegrationRuntime.GetStatusAsync();

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

示例响应

状态代码:: 200

Date: Thu, 14 Jun 2018 14:53:22 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14997
x-ms-request-id: 19efe790-074f-4241-ae94-0422935d0f46
x-ms-correlation-request-id: 19efe790-074f-4241-ae94-0422935d0f46

{
  "name": "exampleIntegrationRuntime",
  "properties": {
    "state": "Online",
    "type": "SelfHosted",
    "typeProperties": {
      "autoUpdate": "Off",
      "taskQueueId": "1a6296ab-423c-4346-9bcc-85a78c2c0582",
      "version": "3.8.6730.2",
      "nodes": [
        {
          "nodeName": "Node_1",
          "machineName": "YANZHANG-DT",
          "hostServiceUri": "https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/",
          "status": "Online",
          "capabilities": {
            "serviceBusConnected": "True",
            "httpsPortEnabled": "True",
            "credentialInSync": "True",
            "connectedToResourceManager": "True",
            "nodeEnabled": "True"
          },
          "versionStatus": "UpToDate",
          "version": "3.8.6730.2",
          "registerTime": "2018-06-14T14:51:44.9237069Z",
          "lastConnectTime": "2018-06-14T14:52:59.8933313Z",
          "lastStartTime": "2018-06-14T14:52:59.8933313Z",
          "lastUpdateResult": "None",
          "isActiveDispatcher": true,
          "maxConcurrentJobs": 56
        }
      ],
      "updateDelayOffset": "PT3H",
      "localTimeZoneOffset": "PT8H",
      "serviceUrls": [
        "wu.frontend.int.clouddatahub-int.net",
        "*.servicebus.windows.net"
      ],
      "versionStatus": "UpToDate",
      "capabilities": {
        "serviceBusConnected": "True",
        "httpsPortEnabled": "True",
        "credentialInSync": "True",
        "connectedToResourceManager": "True",
        "nodeEnabled": "True"
      },
      "latestVersion": "3.7.6711.1",
      "createTime": "2018-06-14T09:17:45.1839685Z"
    }
  }
}

定义

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

枚举

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

值	说明
On
Off

IntegrationRuntimeInternalChannelEncryptionMode

枚举

它用于为节点节点通信通道设置加密模式（当存在 2 个以上的自承载集成运行时节点时）。

值	说明
NotSet
SslEncrypted
NotEncrypted

IntegrationRuntimeState

枚举

集成运行时的状态。

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

IntegrationRuntimeStatusResponse

对象

集成运行时状态响应。

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

IntegrationRuntimeType

枚举

集成运行时的类型。

值	说明
Managed
SelfHosted

IntegrationRuntimeUpdateResult

枚举

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

值	说明
None
Succeed
Fail

LinkedIntegrationRuntime

对象

链接的集成运行时信息。

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

ManagedIntegrationRuntimeError

对象

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

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

ManagedIntegrationRuntimeNode

对象

集成运行时节点的属性。

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

ManagedIntegrationRuntimeNodeStatus

枚举

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

值	说明
Starting
Available
Recycling
Unavailable

ManagedIntegrationRuntimeOperationResult

对象

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

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

ManagedIntegrationRuntimeStatus

对象

托管集成运行时状态。

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

SelfHostedIntegrationRuntimeNode

对象

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

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

SelfHostedIntegrationRuntimeNodeStatus

枚举

集成运行时节点的状态。

值	说明
NeedRegistration
Online
Limited
Offline
Upgrading
Initializing
InitializeFailed

SelfHostedIntegrationRuntimeStatus

对象

自承载集成运行时状态。

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

通过