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	ファクトリ名。正規表現パターン: `^[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	OK です。
Other Status Codes	CloudError	Azure Data Factory サービスから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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


/**
 * Samples for IntegrationRuntimes GetStatus.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_GetStatus.json
     */
    /**
     * Sample code: IntegrationRuntimes_GetStatus.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void integrationRuntimesGetStatus(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().getStatusWithResponse("exampleResourceGroup", "exampleFactoryName",
            "exampleIntegrationRuntime", 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_get_status.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.get_status(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="exampleIntegrationRuntime",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.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_GetStatus.json
func ExampleIntegrationRuntimesClient_GetStatus() {
	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)
	}
	res, err := clientFactory.NewIntegrationRuntimesClient().GetStatus(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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("exampleIntegrationRuntime"),
	// 	Properties: &armdatafactory.SelfHostedIntegrationRuntimeStatus{
	// 		Type: to.Ptr(armdatafactory.IntegrationRuntimeTypeSelfHosted),
	// 		State: to.Ptr(armdatafactory.IntegrationRuntimeStateOnline),
	// 		TypeProperties: &armdatafactory.SelfHostedIntegrationRuntimeStatusTypeProperties{
	// 			AutoUpdate: to.Ptr(armdatafactory.IntegrationRuntimeAutoUpdateOff),
	// 			Capabilities: map[string]*string{
	// 				"connectedToResourceManager": to.Ptr("True"),
	// 				"credentialInSync": to.Ptr("True"),
	// 				"httpsPortEnabled": to.Ptr("True"),
	// 				"nodeEnabled": to.Ptr("True"),
	// 				"serviceBusConnected": to.Ptr("True"),
	// 			},
	// 			CreateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T09:17:45.183Z"); return t}()),
	// 			LatestVersion: to.Ptr("3.7.6711.1"),
	// 			LocalTimeZoneOffset: to.Ptr("PT8H"),
	// 			Nodes: []*armdatafactory.SelfHostedIntegrationRuntimeNode{
	// 				{
	// 					Capabilities: map[string]*string{
	// 						"connectedToResourceManager": to.Ptr("True"),
	// 						"credentialInSync": to.Ptr("True"),
	// 						"httpsPortEnabled": to.Ptr("True"),
	// 						"nodeEnabled": to.Ptr("True"),
	// 						"serviceBusConnected": to.Ptr("True"),
	// 					},
	// 					HostServiceURI: to.Ptr("https://yanzhang-dt.fareast.corp.microsoft.com:8050/HostServiceRemote.svc/"),
	// 					IsActiveDispatcher: to.Ptr(true),
	// 					LastConnectTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:52:59.893Z"); return t}()),
	// 					LastStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:52:59.893Z"); return t}()),
	// 					LastUpdateResult: to.Ptr(armdatafactory.IntegrationRuntimeUpdateResultNone),
	// 					MachineName: to.Ptr("YANZHANG-DT"),
	// 					MaxConcurrentJobs: to.Ptr[int32](56),
	// 					NodeName: to.Ptr("Node_1"),
	// 					RegisterTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-14T14:51:44.923Z"); return t}()),
	// 					Status: to.Ptr(armdatafactory.SelfHostedIntegrationRuntimeNodeStatusOnline),
	// 					Version: to.Ptr("3.8.6730.2"),
	// 					VersionStatus: to.Ptr("UpToDate"),
	// 			}},
	// 			ServiceUrls: []*string{
	// 				to.Ptr("wu.frontend.int.clouddatahub-int.net"),
	// 				to.Ptr("*.servicebus.windows.net")},
	// 				TaskQueueID: to.Ptr("1a6296ab-423c-4346-9bcc-85a78c2c0582"),
	// 				UpdateDelayOffset: to.Ptr("PT3H"),
	// 				Version: to.Ptr("3.8.6730.2"),
	// 				VersionStatus: to.Ptr("UpToDate"),
	// 			},
	// 		},
	// 	}
}

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 Gets detailed status information for an integration runtime.
 *
 * @summary Gets detailed status information for an integration runtime.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_GetStatus.json
 */
async function integrationRuntimesGetStatus() {
  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 = "exampleIntegrationRuntime";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.getStatus(
    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_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 Data Factoryエラー応答の構造を定義するオブジェクト。
IntegrationRuntimeAutoUpdate	統合ランタイムの自動更新の状態。
IntegrationRuntimeInternalChannelEncryptionMode	ノードノード通信チャネルの暗号化モードを設定するために使用されます (2 つ以上のセルフホステッド統合ランタイムノードが存在する場合)。
IntegrationRuntimeState	統合ランタイムの状態。
IntegrationRuntimeStatusResponse	統合ランタイムの状態の応答。
IntegrationRuntimeType	統合ランタイムの種類。
IntegrationRuntimeUpdateResult	最後の統合ランタイムノード更新の結果。
LinkedIntegrationRuntime	リンクされた統合ランタイム情報。
ManagedIntegrationRuntimeError	マネージド統合ランタイムのエラー定義。
ManagedIntegrationRuntimeNode	統合ランタイムノードのプロパティ。
ManagedIntegrationRuntimeNodeStatus	マネージド統合ランタイムノードの状態。
ManagedIntegrationRuntimeOperationResult	マネージド統合ランタイム操作の結果のプロパティ。
ManagedIntegrationRuntimeStatus	マネージド統合ランタイムの状態。
SelfHostedIntegrationRuntimeNode	セルフホステッド統合ランタイムノードのプロパティ。
SelfHostedIntegrationRuntimeNodeStatus	統合ランタイムノードの状態。
SelfHostedIntegrationRuntimeStatus	セルフホステッド統合ランタイムの状態。

CloudError

Azure Data Factoryエラー応答の構造を定義するオブジェクト。

名前	型	説明
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 Relay との接続を確立できない場合に対話型の作成機能を確保する別のオプション。
typeProperties.serviceUrls	string[]	統合ランタイムバックエンドサービスで使用されるサービスの URL。
typeProperties.taskQueueId	string	統合ランタイムのタスクキュー ID。
typeProperties.updateDelayOffset	string	統合ランタイムを更新するためにサービスによってスケジュールされた日付の時刻 (PT03H は 3 時間など)
typeProperties.version	string	統合ランタイムのバージョン。
typeProperties.versionStatus	string	統合ランタイムバージョンの状態。