Pipeline Runs - Get

Referensi

Service:: Data Factory

API Version:: 2018-06-01

Dapatkan eksekusi alur dengan ID eksekusinya.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}?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\._]+$`
runId	path	True	string	Pengidentifikasi eksekusi alur.
subscriptionId	path	True	string	Pengidentifikasi langganan.
api-version	query	True	string	Versi API.

Respons

Name	Type	Description
200 OK	PipelineRun	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_Get

Sample Request

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b?api-version=2018-06-01

import com.azure.core.util.Context;

/** Samples for PipelineRuns Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Get.json
     */
    /**
     * Sample code: PipelineRuns_Get.
     *
     * @param manager Entry point to DataFactoryManager.
     */
    public static void pipelineRunsGet(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager
            .pipelineRuns()
            .getWithResponse(
                "exampleResourceGroup", "exampleFactoryName", "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", Context.NONE);
    }
}

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

package armdatafactory_test

import (
	"context"
	"log"

	"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_Get.json
func ExamplePipelineRunsClient_Get() {
	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.Get(ctx,
		"exampleResourceGroup",
		"exampleFactoryName",
		"2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
		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 Get a pipeline run by its run ID.
 *
 * @summary Get a pipeline run by its run ID.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/PipelineRuns_Get.json
 */
async function pipelineRunsGet() {
  const subscriptionId = "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const runId = "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.pipelineRuns.get(resourceGroupName, factoryName, runId);
  console.log(result);
}

pipelineRunsGet().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:02 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14988
x-ms-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646
x-ms-correlation-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646

Response Body

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

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.

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.