Pipeline Runs - Get

Dienst:

Data Factory

API-Version:

2018-06-01

Rufen Sie eine Pipeline mit der Ausführungs-ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Werksname.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Der Ressourcengruppenname.
runId	path	True	string	Der Pipelineausführungsbezeichner.
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	PipelineRun	OKAY.
Other Status Codes	CloudError	Eine Fehlerantwort, die vom Azure Data Factory-Dienst empfangen wurde.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

PipelineRuns_Get

Beispielanforderung

HTTP

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

Java

/**
 * 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", 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

Python

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/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

Go

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/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()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPipelineRunsClient().Get(ctx, "exampleResourceGroup", "exampleFactoryName", "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PipelineRun = armdatafactory.PipelineRun{
	// 	AdditionalProperties: map[string]any{
	// 		"annotations": []any{
	// 		},
	// 	},
	// 	DurationInMs: to.Ptr[int32](28105),
	// 	InvokedBy: &armdatafactory.PipelineRunInvokedBy{
	// 		Name: to.Ptr("Manual"),
	// 		ID: to.Ptr("80a01654a9d34ad18b3fcac5d5d76b67"),
	// 	},
	// 	LastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:38:12.731Z"); return t}()),
	// 	Message: to.Ptr(""),
	// 	Parameters: map[string]*string{
	// 		"OutputBlobNameList": to.Ptr("[\"exampleoutput.csv\"]"),
	// 	},
	// 	PipelineName: to.Ptr("examplePipeline"),
	// 	RunEnd: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:38:12.731Z"); return t}()),
	// 	RunID: to.Ptr("2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"),
	// 	RunStart: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:37:44.625Z"); return t}()),
	// 	Status: to.Ptr("Succeeded"),
	// }
}

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

JavaScript

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 =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "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);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.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

CLI

az datafactory pipeline-run show --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --run-id "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"

Click here to learn more about the Azure CLI command.

Beispiel für eine Antwort

Statuscode:

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

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

Definitionen

Name	Beschreibung
CloudError	Das Objekt, das die Struktur einer 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.

CloudError

Objekt

Das Objekt, das die Struktur einer 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 Anforderung, die fehler zugeordnet ist.

PipelineRun

Objekt

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 (date-time)	Der letzte aktualisierte Zeitstempel für das Pipelineausführungsereignis im ISO8601 Format.
message	string	Die Nachricht aus einer Pipelineausführung.
parameters	object	Die vollständige oder teilweise Liste des Parameternamens, wertpaar, das in der Pipelineausführung verwendet wird.
pipelineName	string	Der Pipeline-Name.
runDimensions	object	Ausführen von Dimensionen, die von Pipelineausführung ausgegeben werden.
runEnd	string (date-time)	Die Endzeit einer Pipelineausführung im ISO8601 Format.
runGroupId	string	Bezeichner, der alle Wiederherstellungsläufe einer Pipelineausführung korreliert.
runId	string	Bezeichner einer Ausführung.
runStart	string (date-time)	Die Startzeit einer Pipelineausführung im ISO8601 Format.
status	string	Der Status einer Pipelineausführung. Mögliche Werte: Queued, InProgress, Succeeded, Failed, Canceling, Canceled

PipelineRunInvokedBy

Objekt

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, falls vorhanden.
pipelineRunId	string	Die Ausführungs-ID der Pipeline, die die Ausführung ausgelöst hat, falls vorhanden.