Trigger Runs - Query By Factory

Service:

Data Factory

API バージョン:

2018-06-01

クエリ トリガーが実行されます。

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

URI パラメーター

Name	/	必須	型	説明
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	リソース グループの名前。 名前の大文字と小文字は区別されません。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

Name	必須	型	説明
lastUpdatedAfter	True	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻以降。
lastUpdatedBefore	True	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻またはそれ以前。
continuationToken		string	結果の次のページを取得するための継続トークン。 最初のページの場合は Null。
filters		RunQueryFilter[]	フィルターの一覧。
orderBy		RunQueryOrderBy[]	OrderBy オプションの一覧。

応答

Name	型	説明
200 OK	TriggerRunsQueryResponse	Azureの運用は無事に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

Name	説明
user_impersonation	ユーザー アカウントを偽装する

例

TriggerRuns_QueryByFactory

要求のサンプル

HTTP

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

{
  "filters": [
    {
      "operand": "TriggerName",
      "operator": "Equals",
      "values": [
        "exampleTrigger"
      ]
    }
  ],
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z"
}

Java

import com.azure.resourcemanager.datafactory.models.RunFilterParameters;
import com.azure.resourcemanager.datafactory.models.RunQueryFilter;
import com.azure.resourcemanager.datafactory.models.RunQueryFilterOperand;
import com.azure.resourcemanager.datafactory.models.RunQueryFilterOperator;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for TriggerRuns QueryByFactory.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/TriggerRuns_QueryByFactory.json
     */
    /**
     * Sample code: TriggerRuns_QueryByFactory.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void triggerRunsQueryByFactory(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.triggerRuns().queryByFactoryWithResponse("exampleResourceGroup", "exampleFactoryName",
            new RunFilterParameters().withLastUpdatedAfter(OffsetDateTime.parse("2018-06-16T00:36:44.3345758Z"))
                .withLastUpdatedBefore(OffsetDateTime.parse("2018-06-16T00:49:48.3686473Z"))
                .withFilters(Arrays.asList(new RunQueryFilter().withOperand(RunQueryFilterOperand.TRIGGER_NAME)
                    .withOperator(RunQueryFilterOperator.EQUALS).withValues(Arrays.asList("exampleTrigger")))),
            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 trigger_runs_query_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="SUBSCRIPTION_ID",
    )

    response = client.trigger_runs.query_by_factory(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        filter_parameters={
            "filters": [{"operand": "TriggerName", "operator": "Equals", "values": ["exampleTrigger"]}],
            "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
            "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
        },
    )
    print(response)


# x-ms-original-file: 2018-06-01/TriggerRuns_QueryByFactory.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"
	"time"

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

// Generated from example definition: 2018-06-01/TriggerRuns_QueryByFactory.json
func ExampleTriggerRunsClient_QueryByFactory() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("12345678-1234-1234-1234-123456789012", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewTriggerRunsClient().QueryByFactory(ctx, "exampleResourceGroup", "exampleFactoryName", armdatafactory.RunFilterParameters{
		Filters: []*armdatafactory.RunQueryFilter{
			{
				Operand:  to.Ptr(armdatafactory.RunQueryFilterOperandTriggerName),
				Operator: to.Ptr(armdatafactory.RunQueryFilterOperatorEquals),
				Values: []*string{
					to.Ptr("exampleTrigger"),
				},
			},
		},
		LastUpdatedAfter:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:36:44.3345758Z"); return t }()),
		LastUpdatedBefore: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:49:48.3686473Z"); return t }()),
	}, 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 = armdatafactory.TriggerRunsClientQueryByFactoryResponse{
	// 	TriggerRunsQueryResponse: armdatafactory.TriggerRunsQueryResponse{
	// 		Value: []*armdatafactory.TriggerRun{
	// 			{
	// 				Message: to.Ptr(""),
	// 				Properties: map[string]*string{
	// 					"ScheduleTime": to.Ptr("6/16/2018 12:43:14 AM"),
	// 					"TriggerTime": to.Ptr("6/16/2018 12:43:15 AM"),
	// 				},
	// 				Status: to.Ptr(armdatafactory.TriggerRunStatusSucceeded),
	// 				TriggerName: to.Ptr("exampleTrigger"),
	// 				TriggerRunID: to.Ptr("08586724970898148904457116912CU27"),
	// 				TriggerRunTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:43:15.660141Z"); return t}()),
	// 				TriggerType: to.Ptr("ScheduleTrigger"),
	// 				TriggeredPipelines: map[string]*string{
	// 					"examplePipeline": to.Ptr("9f3ce8b3-37d7-43eb-96ac-a656c0476283"),
	// 				},
	// 			},
	// 		},
	// 	},
	// }
}

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 query trigger runs.
 *
 * @summary query trigger runs.
 * x-ms-original-file: 2018-06-01/TriggerRuns_QueryByFactory.json
 */
async function triggerRunsQueryByFactory() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.triggerRuns.queryByFactory(
    "exampleResourceGroup",
    "exampleFactoryName",
    {
      filters: [{ operand: "TriggerName", operator: "Equals", values: ["exampleTrigger"] }],
      lastUpdatedAfter: new Date("2018-06-16T00:36:44.3345758Z"),
      lastUpdatedBefore: new Date("2018-06-16T00:49:48.3686473Z"),
    },
  );
  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

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/DataFactory/stable/2018-06-01/examples/TriggerRuns_QueryByFactory.json
// this example is just showing the usage of "TriggerRuns_QueryByFactory" 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);

// invoke the operation and iterate over the result
RunFilterContent content = new RunFilterContent(DateTimeOffset.Parse("2018-06-16T00:36:44.3345758Z"), DateTimeOffset.Parse("2018-06-16T00:49:48.3686473Z"))
{
    Filters = { new RunQueryFilter(RunQueryFilterOperand.TriggerName, RunQueryFilterOperator.EqualsValue, new string[] { "exampleTrigger" }) },
};
await foreach (DataFactoryTriggerRun item in dataFactory.GetTriggerRunsAsync(content))
{
    Console.WriteLine($"Succeeded: {item}");
}

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: Sat, 16 Jun 2018 00:46:22 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: fb328f3e-d21e-44f7-80d7-dad60c955b4d
x-ms-ratelimit-remaining-subscription-writes: 1199
x-ms-request-id: fb328f3e-d21e-44f7-80d7-dad60c955b4d

{
  "value": [
    {
      "message": "",
      "properties": {
        "ScheduleTime": "6/16/2018 12:43:14 AM",
        "TriggerTime": "6/16/2018 12:43:15 AM"
      },
      "status": "Succeeded",
      "triggerName": "exampleTrigger",
      "triggerRunId": "08586724970898148904457116912CU27",
      "triggerRunTimestamp": "2018-06-16T00:43:15.660141Z",
      "triggerType": "ScheduleTrigger",
      "triggeredPipelines": {
        "examplePipeline": "9f3ce8b3-37d7-43eb-96ac-a656c0476283"
      }
    }
  ]
}

定義

Name	説明
CloudError	Azure Data Factory エラー応答の構造を定義するオブジェクト。
RunFilterParameters	実行を一覧表示するためのクエリ パラメーター。
RunQueryFilter	実行を一覧表示するためのクエリ フィルター オプション。
RunQueryFilterOperand	フィルターに使用するパラメーター名。 パイプライン実行のクエリに使用できるオペランドは、PipelineName、RunStart、RunEnd、Status です。アクティビティ実行のクエリには ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType、Status があり、クエリ トリガーの実行には TriggerName、TriggerRunTimestamp、Status があります。
RunQueryFilterOperator	フィルターに使用する演算子。
RunQueryOrder	パラメーターの並べ替え順序。
RunQueryOrderBy	実行を一覧表示するためのオプション別の順序を指定するオブジェクト。
RunQueryOrderByField	順序付けに使用するパラメーター名。 パイプラインの実行で順序付けできるパラメーターは、PipelineName、RunStart、RunEnd、Status です。アクティビティの実行は ActivityName、ActivityRunStart、ActivityRunEnd、Status です。トリガーの実行には、TriggerName、TriggerRunTimestamp、および Status があります。
TriggerRun	トリガーが実行されます。
TriggerRunsQueryResponse	トリガーの実行の一覧。
TriggerRunStatus	トリガーの実行状態。

CloudError

Object

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

Name	型	説明
error.code	string	エラー コード。
error.details	CloudError[]	追加のエラーの詳細を含む配列。
error.message	string	エラーメッセージ。
error.target	string	エラーに関連付けられている要求のプロパティ名/パス。

RunFilterParameters

Object

実行を一覧表示するためのクエリ パラメーター。

Name	型	説明
continuationToken	string	結果の次のページを取得するための継続トークン。 最初のページの場合は Null。
filters	RunQueryFilter[]	フィルターの一覧。
lastUpdatedAfter	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻以降。
lastUpdatedBefore	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻またはそれ以前。
orderBy	RunQueryOrderBy[]	OrderBy オプションの一覧。

RunQueryFilter

Object

実行を一覧表示するためのクエリ フィルター オプション。

Name	型	説明
operand	RunQueryFilterOperand	フィルターに使用するパラメーター名。 パイプライン実行のクエリに使用できるオペランドは、PipelineName、RunStart、RunEnd、Status です。アクティビティ実行のクエリには ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType、Status があり、クエリ トリガーの実行には TriggerName、TriggerRunTimestamp、Status があります。
operator	RunQueryFilterOperator	フィルターに使用する演算子。
values	string[]	フィルター値の一覧。

RunQueryFilterOperand

列挙

フィルターに使用するパラメーター名。 パイプライン実行のクエリに使用できるオペランドは、PipelineName、RunStart、RunEnd、Status です。アクティビティ実行のクエリには ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType、Status があり、クエリ トリガーの実行には TriggerName、TriggerRunTimestamp、Status があります。

値	説明
PipelineName	パイプライン名
Status	地位
RunStart	ランスタート
RunEnd	RunEnd
ActivityName	活動名
ActivityRunStart	アクティビティランスタート
ActivityRunEnd	ActivityRunEnd
ActivityType	アクティビティの種類
TriggerName	トリガー名
TriggerRunTimestamp	トリガーランタイムスタンプ
RunGroupId	RunGroupID
LatestOnly	最新

RunQueryFilterOperator

列挙

フィルターに使用する演算子。

値	説明
Equals	等しい
NotEquals	NotEquals
In	In
NotIn	ノットイン

RunQueryOrder

列挙

パラメーターの並べ替え順序。

値	説明
ASC	ASC
DESC	DESC

RunQueryOrderBy

Object

実行を一覧表示するためのオプション別の順序を指定するオブジェクト。

Name	型	説明
order	RunQueryOrder	パラメーターの並べ替え順序。
orderBy	RunQueryOrderByField	順序付けに使用するパラメーター名。 パイプラインの実行で順序付けできるパラメーターは、PipelineName、RunStart、RunEnd、Status です。アクティビティの実行は ActivityName、ActivityRunStart、ActivityRunEnd、Status です。トリガーの実行には、TriggerName、TriggerRunTimestamp、および Status があります。

RunQueryOrderByField

列挙

順序付けに使用するパラメーター名。 パイプラインの実行で順序付けできるパラメーターは、PipelineName、RunStart、RunEnd、Status です。アクティビティの実行は ActivityName、ActivityRunStart、ActivityRunEnd、Status です。トリガーの実行には、TriggerName、TriggerRunTimestamp、および Status があります。

値	説明
RunStart	ランスタート
RunEnd	RunEnd
PipelineName	パイプライン名
Status	地位
ActivityName	活動名
ActivityRunStart	アクティビティランスタート
ActivityRunEnd	ActivityRunEnd
TriggerName	トリガー名
TriggerRunTimestamp	トリガーランタイムスタンプ

TriggerRun

Object

トリガーが実行されます。

Name	型	説明
dependencyStatus		アップストリーム パイプラインの状態。
message	string	トリガー エラー メッセージ。
properties	object	トリガーの実行に関連するプロパティ名と値の一覧。 名前と値のペアは、トリガーの種類によって異なります。
runDimension	object	トリガーが起動されたディメンションを実行します。
status	TriggerRunStatus	トリガーの実行状態。
triggerName	string	トリガー名。
triggerRunId	string	トリガー実行 ID。
triggerRunTimestamp	string (date-time)	トリガーの実行開始時刻。
triggerType	string	トリガーの種類。
triggeredPipelines	object	トリガーの実行によってトリガーされるパイプライン名と実行 ID の一覧。

TriggerRunsQueryResponse

Object

トリガーの実行の一覧。

Name	型	説明
continuationToken	string	残りの結果が存在する場合は、結果の次のページを取得するための継続トークン。それ以外の場合は null。
value	TriggerRun[]	トリガーの実行の一覧。

TriggerRunStatus

列挙

トリガーの実行状態。

値	説明
Succeeded	成功しました
Failed	失敗
Inprogress	進行中