Pipeline Runs - Get

Serviço:: Data Factory

Versão da API:: 2018-06-01

Obtenha um pipeline executado por sua ID de execução.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	O nome da fábrica.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	O nome do grupo de recursos.
runId	path	True	string	O identificador de execução do pipeline.
subscriptionId	path	True	string	O identificador da assinatura.
api-version	query	True	string	A versão da API.

Respostas

Nome	Tipo	Description
200 OK	PipelineRun	OKEY.
Other Status Codes	CloudError	Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

PipelineRuns_Get

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

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

Resposta de exemplo

Código de status:: 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": []
}

Definições

Nome	Description
CloudError	O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.
PipelineRun	Informações sobre uma execução de pipeline.
PipelineRunInvokedBy	Fornece o nome da entidade e a ID que iniciaram a execução do pipeline.

CloudError

Objeto

O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.

Nome	Tipo	Description
error.code	string	Código de erro.
error.details	CloudError[]	Matriz com detalhes de erro adicionais.
error.message	string	Mensagem de erro.
error.target	string	Nome/caminho da propriedade na solicitação associada ao erro.

PipelineRun

Objeto

Informações sobre uma execução de pipeline.

Nome	Tipo	Description
durationInMs	integer	A duração de uma execução de pipeline.
invokedBy	PipelineRunInvokedBy	Entidade que iniciou a execução do pipeline.
isLatest	boolean	Indica se a execução de pipeline recuperada é a mais recente em seu grupo.
lastUpdated	string (date-time)	O último carimbo de data/hora atualizado para o evento de execução de pipeline em ISO8601 formato.
message	string	A mensagem de uma execução de pipeline.
parameters	object	A lista completa ou parcial de nome do parâmetro, par de valor usado na execução do pipeline.
pipelineName	string	O nome do pipeline.
runDimensions	object	Executar dimensões emitidas pela execução do Pipeline.
runEnd	string (date-time)	A hora de término de uma execução de pipeline no formato ISO8601.
runGroupId	string	Identificador que correlaciona todas as execuções de recuperação de uma execução de pipeline.
runId	string	Identificador de uma execução.
runStart	string (date-time)	A hora de início de uma execução de pipeline no formato ISO8601.
status	string	O status de uma execução de pipeline. Valores possíveis: Enfileirado, InProgress, Êxito, Falha, Cancelamento, Cancelado

PipelineRunInvokedBy

Objeto

Fornece o nome da entidade e a ID que iniciaram a execução do pipeline.

Nome	Tipo	Description
id	string	A ID da entidade que iniciou a execução.
invokedByType	string	O tipo da entidade que iniciou a execução.
name	string	Nome da entidade que iniciou a execução do pipeline.
pipelineName	string	O nome do pipeline que disparou a execução, se houver.
pipelineRunId	string	A ID de execução do pipeline que disparou a execução, se houver.

Compartilhar via

Pipeline Runs - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

PipelineRuns_Get

Solicitação de exemplo

Resposta de exemplo

Definições

CloudError

PipelineRun

PipelineRunInvokedBy