Pipeline Runs - Get

Služba:

Data Factory

Verze rozhraní API:

2018-06-01

Získejte spuštění kanálu podle ID spuštění.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
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	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
runId	path	True	string	Identifikátor spuštění kanálu.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	PipelineRun	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

PipelineRuns_Get

Ukázkový požadavek

HTTP

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

Java

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

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="SUBSCRIPTION_ID",
    )

    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: 2018-06-01/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/v11"
)

// Generated from example definition: 2018-06-01/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("12345678-1234-1234-1234-123456789012", 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 = armdatafactory.PipelineRunsClientGetResponse{
	// 	PipelineRun: armdatafactory.PipelineRun{
	// 		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.7314495Z"); 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.7314495Z"); 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.6257014Z"); return t}()),
	// 		Status: to.Ptr("Succeeded"),
	// 		AdditionalProperties: map[string]any{
	// 		"annotations": []any{
	// 		},
	// 	},
	// 	},
	// }
}

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: 2018-06-01/PipelineRuns_Get.json
 */
async function pipelineRunsGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.pipelineRuns.get(
    "exampleResourceGroup",
    "exampleFactoryName",
    "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
  );
  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.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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CloudError	Objekt, který definuje strukturu chybové odpovědi služby Azure Data Factory.
PipelineRun	Informace o spuštění kanálu
PipelineRunInvokedBy	Poskytuje název a ID entity, které spustily spuštění kanálu.

CloudError

Objekt

Objekt, který definuje strukturu chybové odpovědi služby Azure Data Factory.

Name	Typ	Description
error.code	string	Kód chyby
error.details	CloudError[]	Pole s dalšími podrobnostmi o chybě
error.message	string	Zpráva o chybě.
error.target	string	Název vlastnosti nebo cesta v požadavku přidruženém k chybě.

PipelineRun

Objekt

Informace o spuštění kanálu

Name	Typ	Description
durationInMs	integer (int32)	Doba trvání spuštění kanálu.
invokedBy	PipelineRunInvokedBy	Entita, která spustila spuštění kanálu
isLatest	boolean	Označuje, jestli je obnovené spuštění kanálu nejnovější ve své skupině.
lastUpdated	string (date-time)	Časové razítko poslední aktualizace události spuštění kanálu ve formátu ISO8601.
message	string	Zpráva ze spuštění kanálu.
parameters	object	Úplný nebo částečný seznam názvu parametru, dvojice hodnot použitá při spuštění kanálu.
pipelineName	string	Název kanálu.
runDimensions	object	Spuštění dimenzí vygenerovaných spuštěním kanálu
runEnd	string (date-time)	Koncový čas spuštění kanálu ve formátu ISO8601.
runGroupId	string	Identifikátor, který koreluje všechna spuštění obnovení spuštění kanálu.
runId	string	Identifikátor spuštění.
runStart	string (date-time)	Počáteční čas spuštění kanálu ve formátu ISO8601.
status	string	Stav spuštění kanálu Možné hodnoty: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled

PipelineRunInvokedBy

Objekt

Poskytuje název a ID entity, které spustily spuštění kanálu.

Name	Typ	Description
id	string	ID entity, která spustila spuštění.
invokedByType	string	Typ entity, která spustila spuštění.
name	string	Název entity, která spustila spuštění kanálu
pipelineName	string	Název kanálu, který aktivoval spuštění, pokud existuje.
pipelineRunId	string	ID spuštění kanálu, který spuštění aktivoval, pokud existuje.