Freigeben über


Pipeline Runs - Query By Factory

Abfragepipeline wird in der Factory basierend auf Eingabefilterbedingungen ausgeführt.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
factoryName
path True

string

Der Werksname.

RegEx-Muster: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

RegEx-Muster: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
lastUpdatedAfter True

string

Der Zeitpunkt zu oder nach dem das Ausführungsereignis im ISO 8601-Format aktualisiert wurde.

lastUpdatedBefore True

string

Der Zeitpunkt zu oder vor dem das Ausführungsereignis im FORMAT "ISO 8601" aktualisiert wurde.

continuationToken

string

Das Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite. Null für die erste Seite.

filters

RunQueryFilter[]

Liste der Filter.

orderBy

RunQueryOrderBy[]

Liste der OrderBy-Option.

Antworten

Name Typ Beschreibung
200 OK

PipelineRunsQueryResponse

OK.

Other Status Codes

CloudError

Eine Vom Azure Data Factory-Dienst empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

PipelineRuns_QueryByFactory

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CloudError

Das -Objekt, das die Struktur eines Azure Data Factory Fehlerantwort definiert.

PipelineRun

Informationen zu einer Pipelineausführung.

PipelineRunInvokedBy

Stellt den Entitätsnamen und die ID bereit, die die Pipelineausführung gestartet hat.

PipelineRunsQueryResponse

Eine Listenpipeline wird ausgeführt.

RunFilterParameters

Abfrageparameter für das Auflisten von Ausführungen.

RunQueryFilter

Abfragefilteroption zum Auflisten von Ausführungen.

RunQueryFilterOperand

Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden zum Abfragen von Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. zum Abfragen von Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status und zum Abfragen von Triggerausführungen TriggerName, TriggerRunTimestamp und Status.

RunQueryFilterOperator

Operator, der für den Filter verwendet werden soll.

RunQueryOrder

Sortierreihenfolge des Parameters.

RunQueryOrderBy

Ein Objekt, das die Reihenfolge nach Optionen für das Auflisten von Ausführungen bereitstellt.

RunQueryOrderByField

Parametername, der für die Reihenfolge nach verwendet werden soll. Die zulässigen Parameter für pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. für Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerausführungen sind TriggerName, TriggerRunTimestamp und Status.

CloudError

Das -Objekt, das die Struktur eines Azure Data Factory Fehlerantwort definiert.

Name Typ Beschreibung
error.code

string

Fehlercode

error.details

CloudError[]

Array mit zusätzlichen Fehlerdetails.

error.message

string

Fehlermeldung.

error.target

string

Eigenschaftsname/Pfad in der Anforderung, die einem Fehler zugeordnet ist.

PipelineRun

Informationen zu einer Pipelineausführung.

Name Typ Beschreibung
durationInMs

integer

Die Dauer einer Pipelineausführung.

invokedBy

PipelineRunInvokedBy

Entität, die die Pipelineausführung gestartet hat.

isLatest

boolean

Gibt an, ob die wiederhergestellte Pipelineausführung die neueste in der Gruppe ist.

lastUpdated

string

Der letzte aktualisierte Zeitstempel für das Pipelineausführungsereignis in ISO8601 Format.

message

string

Die Nachricht aus einer Pipelineausführung.

parameters

object

Die vollständige oder partielle Liste des Parameternamens, des Wertpaars, das in der Pipelineausführung verwendet wird.

pipelineName

string

Der Pipelinename.

runDimensions

object

Von der Pipelineausführung ausgegebene Ausführungsdimensionen.

runEnd

string

Die Endzeit einer Pipelineausführung in ISO8601 Format.

runGroupId

string

Bezeichner, der alle Wiederherstellungsausführungen einer Pipelineausführung korreliert.

runId

string

Bezeichner einer Ausführung.

runStart

string

Die Startzeit einer Pipelineausführung in ISO8601 Format.

status

string

Die status einer Pipelineausführung. Mögliche Werte: Queued, InProgress, Succeeded, Failed, Canceling, Canceled

PipelineRunInvokedBy

Stellt den Entitätsnamen und die ID bereit, die die Pipelineausführung gestartet hat.

Name Typ Beschreibung
id

string

Die ID der Entität, die die Ausführung gestartet hat.

invokedByType

string

Der Typ der Entität, die die Ausführung gestartet hat.

name

string

Name der Entität, die die Pipelineausführung gestartet hat.

pipelineName

string

Der Name der Pipeline, die die Ausführung ausgelöst hat, sofern vorhanden.

pipelineRunId

string

Die Ausführungs-ID der Pipeline, die die Ausführung ausgelöst hat, falls vorhanden.

PipelineRunsQueryResponse

Eine Listenpipeline wird ausgeführt.

Name Typ Beschreibung
continuationToken

string

Das Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite, falls noch ergebnisse vorhanden sind, andernfalls NULL.

value

PipelineRun[]

Liste der Pipelineausführungen.

RunFilterParameters

Abfrageparameter für das Auflisten von Ausführungen.

Name Typ Beschreibung
continuationToken

string

Das Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite. Null für die erste Seite.

filters

RunQueryFilter[]

Liste der Filter.

lastUpdatedAfter

string

Der Zeitpunkt zu oder nach dem das Ausführungsereignis im ISO 8601-Format aktualisiert wurde.

lastUpdatedBefore

string

Der Zeitpunkt zu oder vor dem das Ausführungsereignis im FORMAT "ISO 8601" aktualisiert wurde.

orderBy

RunQueryOrderBy[]

Liste der OrderBy-Option.

RunQueryFilter

Abfragefilteroption zum Auflisten von Ausführungen.

Name Typ Beschreibung
operand

RunQueryFilterOperand

Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden zum Abfragen von Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. zum Abfragen von Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status und zum Abfragen von Triggerausführungen TriggerName, TriggerRunTimestamp und Status.

operator

RunQueryFilterOperator

Operator, der für den Filter verwendet werden soll.

values

string[]

Liste der Filterwerte.

RunQueryFilterOperand

Parametername, der für den Filter verwendet werden soll. Die zulässigen Operanden zum Abfragen von Pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. zum Abfragen von Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType und Status und zum Abfragen von Triggerausführungen TriggerName, TriggerRunTimestamp und Status.

Name Typ Beschreibung
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

Operator, der für den Filter verwendet werden soll.

Name Typ Beschreibung
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

Sortierreihenfolge des Parameters.

Name Typ Beschreibung
ASC

string

DESC

string

RunQueryOrderBy

Ein Objekt, das die Reihenfolge nach Optionen für das Auflisten von Ausführungen bereitstellt.

Name Typ Beschreibung
order

RunQueryOrder

Sortierreihenfolge des Parameters.

orderBy

RunQueryOrderByField

Parametername, der für die Reihenfolge nach verwendet werden soll. Die zulässigen Parameter für pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. für Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerausführungen sind TriggerName, TriggerRunTimestamp und Status.

RunQueryOrderByField

Parametername, der für die Reihenfolge nach verwendet werden soll. Die zulässigen Parameter für pipelineausführungen sind PipelineName, RunStart, RunEnd und Status. für Aktivitätsausführungen sind ActivityName, ActivityRunStart, ActivityRunEnd und Status; für Triggerausführungen sind TriggerName, TriggerRunTimestamp und Status.

Name Typ Beschreibung
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string