Pipeline Runs - Query By Factory

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

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

URI パラメーター

Name In Required Type Description
factoryName
path True
  • string

ファクトリの名前。

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True
  • string

リソース グループ名。

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

サブスクリプションの識別子です。

api-version
query True
  • string

API のバージョン。

要求本文

Name Required Type Description
lastUpdatedAfter True
  • string

実行イベントが ' ISO 8601 ' 形式で更新された時刻またはそれ以降の時刻。

lastUpdatedBefore True
  • string

実行イベントが ' ISO 8601 ' 形式で更新された時刻またはそれ以前の時刻。

continuationToken
  • string

結果の次のページを取得するための継続トークン。 最初のページの場合は Null です。

filters

フィルターの一覧。

orderBy

OrderBy オプションの一覧。

応答

Name Type Description
200 OK

OK です。

Other Status Codes

Azure Data Factory サービスから受信したエラー応答。

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

PipelineRuns_QueryByFactory

Sample Request

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"
      ]
    }
  ]
}

Sample Response

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、Runstart、Status です。アクティビティの実行をクエリするには、ActivityName、ActivityRunStart、Activityrunstart、ActivityType、Status、およびトリガー、TriggerRunTimestamp、Status の各トリガーを実行します。

RunQueryFilterOperator

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

RunQueryOrder

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

RunQueryOrderBy

リストの実行に対して order by オプションを提供するオブジェクト。

RunQueryOrderByField

Order by に使用するパラメーター名。 パイプラインの実行で order by に使用できるパラメーターは、PipelineName、RunStart、Runstart、Status です。アクティビティの実行の場合は、ActivityName、ActivityRunStart、Activityrunstart、Status です。トリガーの実行の場合は、トリガー、TriggerRunTimestamp、Status です。

CloudError

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

Name Type Description
error.code
  • string

エラー コード。

error.details

追加のエラーの詳細が含まれている配列。

error.message
  • string

エラー メッセージ。

error.target
  • string

エラーに関連付けられている要求のプロパティ名/パス。

PipelineRun

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

Name Type Description
durationInMs
  • integer

パイプライン実行の期間。

invokedBy

パイプラインの実行を開始したエンティティ。

isLatest
  • boolean

復旧されたパイプラインの実行が、そのグループの最新バージョンであるかどうかを示します。

lastUpdated
  • string

変更前のパイプライン実行イベントの最終更新タイムスタンプ。

message
  • string

パイプラインからのメッセージが実行されます。

parameters
  • object

パイプラインの実行で使用されるパラメーター名と値のペアの完全な一覧または部分的なリスト。

pipelineName
  • string

パイプライン名。

runDimensions
  • object

パイプラインの実行によって生成されたディメンションを実行します。

runEnd
  • string

パイプラインの終了時刻は、外形式で実行されます。

runGroupId
  • string

パイプラインの実行のすべての復旧実行を相互に関連付けた識別子。

runId
  • string

実行の識別子。

runStart
  • string

パイプラインの開始時刻は、外形式で実行されます。

status
  • string

パイプラインの実行の状態。

PipelineRunInvokedBy

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

Name Type Description
id
  • string

実行を開始したエンティティの ID。

invokedByType
  • string

実行を開始したエンティティの型。

name
  • string

パイプラインの実行を開始したエンティティの名前。

pipelineName
  • string

実行をトリガーしたパイプラインの名前 (存在する場合)。

pipelineRunId
  • string

実行をトリガーしたパイプラインの実行 id (存在する場合)。

PipelineRunsQueryResponse

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

Name Type Description
continuationToken
  • string

結果の次のページを取得するための継続トークン (残りの結果が存在する場合)。それ以外の場合は null。

value

パイプラインの実行の一覧。

RunFilterParameters

リストの実行のクエリパラメーター。

Name Type Description
continuationToken
  • string

結果の次のページを取得するための継続トークン。 最初のページの場合は Null です。

filters

フィルターの一覧。

lastUpdatedAfter
  • string

実行イベントが ' ISO 8601 ' 形式で更新された時刻またはそれ以降の時刻。

lastUpdatedBefore
  • string

実行イベントが ' ISO 8601 ' 形式で更新された時刻またはそれ以前の時刻。

orderBy

OrderBy オプションの一覧。

RunQueryFilter

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

Name Type Description
operand

フィルターに使用するパラメーター名。 パイプラインの実行のクエリに使用できるオペランドは、PipelineName、RunStart、Runstart、Status です。アクティビティの実行をクエリするには、ActivityName、ActivityRunStart、Activityrunstart、ActivityType、Status、およびトリガー、TriggerRunTimestamp、Status の各トリガーを実行します。

operator

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

values
  • string[]

フィルター値の一覧。

RunQueryFilterOperand

フィルターに使用するパラメーター名。 パイプラインの実行のクエリに使用できるオペランドは、PipelineName、RunStart、Runstart、Status です。アクティビティの実行をクエリするには、ActivityName、ActivityRunStart、Activityrunstart、ActivityType、Status、およびトリガー、TriggerRunTimestamp、Status の各トリガーを実行します。

Name Type Description
ActivityName
  • string
ActivityRunEnd
  • string
ActivityRunStart
  • string
ActivityType
  • string
LatestOnly
  • string
PipelineName
  • string
RunEnd
  • string
RunGroupId
  • string
RunStart
  • string
Status
  • string
TriggerName
  • string
TriggerRunTimestamp
  • string

RunQueryFilterOperator

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

Name Type Description
Equals
  • string
In
  • string
NotEquals
  • string
NotIn
  • string

RunQueryOrder

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

Name Type Description
ASC
  • string
DESC
  • string

RunQueryOrderBy

リストの実行に対して order by オプションを提供するオブジェクト。

Name Type Description
order

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

orderBy

Order by に使用するパラメーター名。 パイプラインの実行で order by に使用できるパラメーターは、PipelineName、RunStart、Runstart、Status です。アクティビティの実行の場合は、ActivityName、ActivityRunStart、Activityrunstart、Status です。トリガーの実行の場合は、トリガー、TriggerRunTimestamp、Status です。

RunQueryOrderByField

Order by に使用するパラメーター名。 パイプラインの実行で order by に使用できるパラメーターは、PipelineName、RunStart、Runstart、Status です。アクティビティの実行の場合は、ActivityName、ActivityRunStart、Activityrunstart、Status です。トリガーの実行の場合は、トリガー、TriggerRunTimestamp、Status です。

Name Type Description
ActivityName
  • string
ActivityRunEnd
  • string
ActivityRunStart
  • string
PipelineName
  • string
RunEnd
  • string
RunStart
  • string
Status
  • string
TriggerName
  • string
TriggerRunTimestamp
  • string