Pipeline Runs - Query By Factory

サービス:: Data Factory

API バージョン:: 2018-06-01

クエリパイプラインは、入力フィルター条件に基づいてファクトリで実行されます。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns?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	PipelineRunsQueryResponse	わかりました。
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	ユーザーアカウントを偽装する

例

PipelineRuns_QueryByFactory

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

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

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/PipelineRuns_QueryByFactory.json
// this example is just showing the usage of "PipelineRuns_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.PipelineName, RunQueryFilterOperator.EqualsValue, new string[] { "examplePipeline" }) },
};
await foreach (DataFactoryPipelineRunInfo item in dataFactory.GetPipelineRunsAsync(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:40:01 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14989
x-ms-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd
x-ms-correlation-request-id: 2f955e10-c6df-45a7-97d4-81acdb8540cd

{
  "value": [
    {
      "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "pipelineName": "examplePipeline",
      "parameters": {
        "OutputBlobNameList": "[\"exampleoutput.csv\"]"
      },
      "invokedBy": {
        "id": "80a01654a9d34ad18b3fcac5d5d76b67",
        "name": "Manual"
      },
      "runStart": "2018-06-16T00:37:44.6257014Z",
      "runEnd": "2018-06-16T00:38:12.7314495Z",
      "durationInMs": 28105,
      "status": "Succeeded",
      "message": "",
      "lastUpdated": "2018-06-16T00:38:12.7314495Z",
      "annotations": [],
      "runDimension": {
        "JobId": "79c1cc52-265f-41a5-9553-be65e736fbd3"
      }
    },
    {
      "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721",
      "pipelineName": "examplePipeline",
      "parameters": {
        "OutputBlobNameList": "[\"exampleoutput.csv\"]"
      },
      "invokedBy": {
        "id": "7c5fd7ef7e8a464b98b931cf15fcac66",
        "name": "Manual"
      },
      "runStart": "2018-06-16T00:39:49.2745128Z",
      "runEnd": null,
      "durationInMs": null,
      "status": "Cancelled",
      "message": "",
      "lastUpdated": "2018-06-16T00:39:51.216097Z",
      "annotations": [],
      "runDimension": {
        "JobId": "84a3c493-0628-4b44-852f-ef5b3a11bdab"
      }
    }
  ]
}

定義

名前	説明
CloudError	Azure Data Factory エラー応答の構造を定義するオブジェクト。
PipelineRun	パイプラインの実行に関する情報。
PipelineRunInvokedBy	パイプラインの実行を開始したエンティティ名と ID を提供します。
PipelineRunsQueryResponse	リストパイプラインが実行されます。
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 があります。

CloudError

Object

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

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

PipelineRun

Object

パイプラインの実行に関する情報。

名前	型	説明
durationInMs	integer	パイプラインの実行時間。
invokedBy	PipelineRunInvokedBy	パイプラインの実行を開始したエンティティ。
isLatest	boolean	回復されたパイプラインの実行が、そのグループ内の最新のパイプラインであるかどうかを示します。
lastUpdated	string (date-time)	パイプライン実行イベントの最後に更新されたタイムスタンプ (ISO8601形式)。
message	string	パイプライン実行からのメッセージ。
parameters	object	パイプライン実行で使用されるパラメーター名と値ペアの完全または部分的なリスト。
pipelineName	string	パイプライン名。
runDimensions	object	パイプライン実行によって出力されるディメンションを実行します。
runEnd	string (date-time)	パイプライン実行の終了時刻をISO8601形式で指定します。
runGroupId	string	パイプライン実行のすべての復旧実行を関連付ける識別子。
runId	string	実行の識別子。
runStart	string (date-time)	パイプラインの実行の開始時刻をISO8601形式で指定します。
status	string	パイプライン実行の状態。指定できる値: Queued、InProgress、Succeeded、Failed、Canceling、Cancelled

PipelineRunInvokedBy

Object

パイプラインの実行を開始したエンティティ名と ID を提供します。

名前	型	説明
id	string	実行を開始したエンティティの ID。
invokedByType	string	実行を開始したエンティティの型。
name	string	パイプラインの実行を開始したエンティティの名前。
pipelineName	string	実行をトリガーしたパイプラインの名前 (存在する場合)。
pipelineRunId	string	実行をトリガーしたパイプラインの実行 ID (存在する場合)。

PipelineRunsQueryResponse

Object

リストパイプラインが実行されます。

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

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

次の方法で共有

Pipeline Runs - Query By Factory

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

PipelineRuns_QueryByFactory

要求のサンプル

応答のサンプル

定義

CloudError

PipelineRun

PipelineRunInvokedBy

PipelineRunsQueryResponse

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField