Pipeline Runs - Get

Layanan:: Data Factory

Versi API:: 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

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
runId	path	True	string	Pengidentifikasi eksekusi alur.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	PipelineRun	Operasi Azure berhasil diselesaikan.
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

PipelineRuns_Get

Permintaan sampel

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


/**
 * Samples for PipelineRuns Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/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", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python pipeline_runs_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.pipeline_runs.get(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        run_id="2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/PipelineRuns_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_Get.json
// this example is just showing the usage of "PipelineRuns_Get" 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
string runId = "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b";
DataFactoryPipelineRunInfo result = await dataFactory.GetPipelineRunAsync(runId);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:: 200

Date: Sat, 16 Jun 2018 00:40:02 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646
x-ms-ratelimit-remaining-subscription-reads: 14988
x-ms-request-id: 6d9de9bd-a412-4a6f-8b9e-37d369323646

{
  "annotations": [],
  "durationInMs": 28105,
  "invokedBy": {
    "name": "Manual",
    "id": "80a01654a9d34ad18b3fcac5d5d76b67"
  },
  "lastUpdated": "2018-06-16T00:38:12.7314495Z",
  "message": "",
  "parameters": {
    "OutputBlobNameList": "[\"exampleoutput.csv\"]"
  },
  "pipelineName": "examplePipeline",
  "runEnd": "2018-06-16T00:38:12.7314495Z",
  "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
  "runStart": "2018-06-16T00:37:44.6257014Z",
  "status": "Succeeded"
}

Definisi

Nama	Deskripsi
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

Objek yang menentukan struktur respons kesalahan Azure Data Factory.

Nama	Jenis	Deskripsi
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

Objek

Informasi tentang eksekusi alur.

Nama	Jenis	Deskripsi
durationInMs	integer (int32)	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 (date-time)	Tanda waktu terakhir yang diperbarui untuk peristiwa eksekusi alur dalam format ISO8601.
message	string	Pesan dari eksekusi alur.
parameters	object	Daftar lengkap atau sebagian nama parameter, pasangan nilai yang digunakan dalam eksekusi alur.
pipelineName	string	Nama jalur.
runDimensions	object	Jalankan dimensi yang dipancarkan oleh eksekusi Alur.
runEnd	string (date-time)	Waktu akhir eksekusi alur dalam format ISO8601.
runGroupId	string	Pengidentifikasi yang menghubungkan semua eksekusi pemulihan eksekusi alur.
runId	string	Pengidentifikasi eksekusi.
runStart	string (date-time)	Waktu mulai eksekusi alur dalam format ISO8601.
status	string	Status eksekusi alur. Nilai yang mungkin: Antrean, InProgress, Berhasil, Gagal, Membatalkan, Dibatalkan

PipelineRunInvokedBy

Objek

Menyediakan nama entitas dan id yang memulai eksekusi alur.

Nama	Jenis	Deskripsi
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.