Pipeline Runs - Query By Factory

Referensi

Service:: Data Factory

API Version:: 2018-06-01

Alur kueri berjalan di pabrik berdasarkan kondisi filter input.

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

Parameter URI

Name	In	Required	Type	Description
factoryName	path	True	string	Nama pabrik. Regex pattern: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Nama grup sumber daya. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Isi Permintaan

Name	Required	Type	Description
lastUpdatedAfter	True	string	Waktu pada atau setelah peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
lastUpdatedBefore	True	string	Waktu pada atau sebelum peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
continuationToken		string	Token kelanjutan untuk mendapatkan halaman hasil berikutnya. Null untuk halaman pertama.
filters		RunQueryFilter[]	Daftar filter.
orderBy		RunQueryOrderBy[]	Daftar opsi OrderBy.

Respons

Name	Type	Description
200 OK	PipelineRunsQueryResponse	OK.
Other Status Codes	CloudError	Respons kesalahan yang diterima dari layanan Azure Data Factory.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

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

import com.azure.core.util.Context;
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 PipelineRuns QueryByFactory. */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json
     */
    /**
     * Sample code: PipelineRuns_QueryByFactory.
     *
     * @param manager Entry point to DataFactoryManager.
     */
    public static void pipelineRunsQueryByFactory(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager
            .pipelineRuns()
            .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.PIPELINE_NAME)
                                    .withOperator(RunQueryFilterOperator.EQUALS)
                                    .withValues(Arrays.asList("examplePipeline")))),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json
func ExamplePipelineRunsClient_QueryByFactory() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdatafactory.NewPipelineRunsClient("12345678-1234-1234-1234-12345678abc", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.QueryByFactory(ctx,
		"exampleResourceGroup",
		"exampleFactoryName",
		armdatafactory.RunFilterParameters{
			Filters: []*armdatafactory.RunQueryFilter{
				{
					Operand:  to.Ptr(armdatafactory.RunQueryFilterOperandPipelineName),
					Operator: to.Ptr(armdatafactory.RunQueryFilterOperatorEquals),
					Values: []*string{
						to.Ptr("examplePipeline")},
				}},
			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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Query pipeline runs in the factory based on input filter conditions.
 *
 * @summary Query pipeline runs in the factory based on input filter conditions.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_QueryByFactory.json
 */
async function pipelineRunsQueryByFactory() {
  const subscriptionId = "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const filterParameters = {
    filters: [
      {
        operand: "PipelineName",
        operator: "Equals",
        values: ["examplePipeline"],
      },
    ],
    lastUpdatedAfter: new Date("2018-06-16T00:36:44.3345758Z"),
    lastUpdatedBefore: new Date("2018-06-16T00:49:48.3686473Z"),
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.pipelineRuns.queryByFactory(
    resourceGroupName,
    factoryName,
    filterParameters
  );
  console.log(result);
}

pipelineRunsQueryByFactory().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 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

Response Body

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

Definisi

CloudError	Objek yang menentukan struktur respons kesalahan Azure Data Factory.
PipelineRun	Informasi tentang eksekusi alur.
PipelineRunInvokedBy	Menyediakan nama entitas dan id yang memulai eksekusi alur.
PipelineRunsQueryResponse	Alur daftar berjalan.
RunFilterParameters	Parameter kueri untuk mencantumkan eksekusi.
RunQueryFilter	Opsi filter kueri untuk mencantumkan eksekusi.
RunQueryFilterOperand	Nama parameter yang akan digunakan untuk filter. Operan yang diizinkan untuk menjalankan alur kueri adalah PipelineName, RunStart, RunEnd dan Status; untuk mengkueri eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType dan Status, dan untuk mengkueri eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.
RunQueryFilterOperator	Operator yang akan digunakan untuk filter.
RunQueryOrder	Urutan pengurutan parameter.
RunQueryOrderBy	Objek untuk menyediakan urutan berdasarkan opsi untuk mencantumkan eksekusi.
RunQueryOrderByField	Nama parameter yang akan digunakan untuk urutan berdasarkan. Parameter yang diizinkan untuk diurutkan menurut untuk eksekusi alur adalah PipelineName, RunStart, RunEnd dan Status; untuk eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd dan Status; untuk eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.

CloudError

Objek yang menentukan struktur respons kesalahan Azure Data Factory.

Name	Type	Description
error.code	string	Kode Kesalahan.
error.details	CloudError[]	Array dengan detail kesalahan tambahan.
error.message	string	Pesan kesalahan.
error.target	string	Nama/jalur properti dalam permintaan yang terkait dengan kesalahan.

PipelineRun

Informasi tentang eksekusi alur.

Name	Type	Description
durationInMs	integer	Durasi eksekusi alur.
invokedBy	PipelineRunInvokedBy	Entitas yang memulai eksekusi alur.
isLatest	boolean	Menunjukkan apakah eksekusi alur yang dipulihkan adalah yang terbaru dalam grupnya.
lastUpdated	string	Tanda waktu terakhir yang diperbarui untuk peristiwa eksekusi alur dalam format ISO8601.
message	string	Pesan dari eksekusi alur.
parameters	object	Daftar lengkap atau parsial nama parameter, pasangan nilai yang digunakan dalam eksekusi alur.
pipelineName	string	Nama alur.
runDimensions	object	Jalankan dimensi yang dipancarkan oleh Eksekusi alur.
runEnd	string	Waktu akhir eksekusi alur dalam format ISO8601.
runGroupId	string	Pengidentifikasi yang menghubungkan semua eksekusi pemulihan eksekusi alur.
runId	string	Pengidentifikasi eksekusi.
runStart	string	Waktu mulai eksekusi alur dalam format ISO8601.
status	string	Status eksekusi alur. Nilai yang mungkin: Antrean, InProgress, Berhasil, Gagal, Membatalkan, Dibatalkan

PipelineRunInvokedBy

Menyediakan nama entitas dan id yang memulai eksekusi alur.

Name	Type	Description
id	string	ID entitas yang memulai eksekusi.
invokedByType	string	Jenis entitas yang memulai eksekusi.
name	string	Nama entitas yang memulai eksekusi alur.
pipelineName	string	Nama alur yang memicu eksekusi, jika ada.
pipelineRunId	string	Id eksekusi alur yang memicu eksekusi, jika ada.

PipelineRunsQueryResponse

Alur daftar berjalan.

Name	Type	Description
continuationToken	string	Token kelanjutan untuk mendapatkan halaman hasil berikutnya, jika ada hasil yang tersisa, null sebaliknya.
value	PipelineRun[]	Daftar eksekusi alur.

RunFilterParameters

Parameter kueri untuk mencantumkan eksekusi.

Name	Type	Description
continuationToken	string	Token kelanjutan untuk mendapatkan halaman hasil berikutnya. Null untuk halaman pertama.
filters	RunQueryFilter[]	Daftar filter.
lastUpdatedAfter	string	Waktu pada atau setelah peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
lastUpdatedBefore	string	Waktu pada atau sebelum peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
orderBy	RunQueryOrderBy[]	Daftar opsi OrderBy.

RunQueryFilter

Opsi filter kueri untuk mencantumkan eksekusi.

Name	Type	Description
operand	RunQueryFilterOperand	Nama parameter yang akan digunakan untuk filter. Operan yang diizinkan untuk menjalankan alur kueri adalah PipelineName, RunStart, RunEnd dan Status; untuk mengkueri eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType dan Status, dan untuk mengkueri eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.
operator	RunQueryFilterOperator	Operator yang akan digunakan untuk filter.
values	string[]	Daftar nilai filter.

RunQueryFilterOperand

Nama parameter yang akan digunakan untuk filter. Operan yang diizinkan untuk menjalankan alur kueri adalah PipelineName, RunStart, RunEnd dan Status; untuk mengkueri eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType dan Status, dan untuk mengkueri eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan 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

Operator yang akan digunakan untuk filter.

Name	Type	Description
Equals	string
In	string
NotEquals	string
NotIn	string

RunQueryOrder

Urutan pengurutan parameter.

Name	Type	Description
ASC	string
DESC	string

RunQueryOrderBy

Objek untuk menyediakan urutan berdasarkan opsi untuk mencantumkan eksekusi.

Name	Type	Description
order	RunQueryOrder	Urutan pengurutan parameter.
orderBy	RunQueryOrderByField	Nama parameter yang akan digunakan untuk urutan berdasarkan. Parameter yang diizinkan untuk diurutkan menurut untuk eksekusi alur adalah PipelineName, RunStart, RunEnd dan Status; untuk eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd dan Status; untuk eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.

RunQueryOrderByField

Nama parameter yang akan digunakan untuk urutan berdasarkan. Parameter yang diizinkan untuk diurutkan menurut untuk eksekusi alur adalah PipelineName, RunStart, RunEnd dan Status; untuk eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd dan Status; untuk eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.

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