Trigger Runs - Query By Factory

サービス:: 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 パラメーター

名前	/	必須	型	説明
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 のバージョン。

要求本文

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

応答

名前	型	説明
200 OK	TriggerRunsQueryResponse	わかりました。
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	ユーザーアカウントを偽装する

例

TriggerRuns_QueryByFactory

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

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

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-ratelimit-remaining-subscription-writes: 1199
x-ms-request-id: fb328f3e-d21e-44f7-80d7-dad60c955b4d
x-ms-correlation-request-id: fb328f3e-d21e-44f7-80d7-dad60c955b4d

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

定義

名前	説明
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 エラー応答の構造を定義するオブジェクト。

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

RunFilterParameters

Object

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

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

RunQueryFilter

Object

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

名前	型	説明
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
ActivityName
ActivityRunStart
ActivityRunEnd
ActivityType
TriggerName
TriggerRunTimestamp
RunGroupId
LatestOnly

RunQueryFilterOperator

列挙

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

値	説明
Equals
NotEquals
In
NotIn

RunQueryOrder

列挙

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

値	説明
ASC
DESC

RunQueryOrderBy

Object

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

名前	型	説明
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
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp

TriggerRun

Object

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

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

TriggerRunsQueryResponse

Object

トリガーの実行の一覧。

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

TriggerRunStatus

列挙

トリガーの実行状態。

値	説明
Succeeded
Failed
Inprogress

次の方法で共有

Trigger Runs - Query By Factory

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

TriggerRuns_QueryByFactory

要求のサンプル

応答のサンプル

定義

CloudError

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField

TriggerRun

TriggerRunsQueryResponse

TriggerRunStatus