Pipeline Runs - Get

Servicio:: Data Factory

Versión de la API:: 2018-06-01

Obtenga una canalización ejecutada por su identificador de ejecución.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre de fábrica.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nombre del grupo de recursos.
runId	path	True	string	Identificador de ejecución de canalización.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Respuestas

Nombre	Tipo	Description
200 OK	PipelineRun	De acuerdo.
Other Status Codes	CloudError	Respuesta de error recibida del servicio Azure Data Factory.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

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

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

Definiciones

Nombre	Description
CloudError	Objeto que define la estructura de una respuesta de error de Azure Data Factory.
PipelineRun	Información sobre una ejecución de canalización.
PipelineRunInvokedBy	Proporciona el nombre y el identificador de entidad que iniciaron la ejecución de la canalización.

CloudError

Objeto

Objeto que define la estructura de una respuesta de error de Azure Data Factory.

Nombre	Tipo	Description
error.code	string	Código de error.
error.details	CloudError[]	Matriz con detalles de error adicionales.
error.message	string	Mensaje de error.
error.target	string	Nombre o ruta de acceso de propiedad en la solicitud asociada al error.

PipelineRun

Objeto

Información sobre una ejecución de canalización.

Nombre	Tipo	Description
durationInMs	integer	Duración de una ejecución de canalización.
invokedBy	PipelineRunInvokedBy	Entidad que inició la ejecución de la canalización.
isLatest	boolean	Indica si la ejecución de la canalización recuperada es la más reciente de su grupo.
lastUpdated	string (date-time)	La última marca de tiempo actualizada para el evento de ejecución de canalización en formato ISO8601.
message	string	Mensaje de una ejecución de canalización.
parameters	object	La lista completa o parcial del nombre de parámetro, el par de valores usado en la ejecución de la canalización.
pipelineName	string	El nombre de la canalización.
runDimensions	object	Ejecute dimensiones emitidas por la ejecución de canalización.
runEnd	string (date-time)	Hora de finalización de una ejecución de canalización en formato ISO8601.
runGroupId	string	Identificador que correlaciona todas las ejecuciones de recuperación de una ejecución de canalización.
runId	string	Identificador de una ejecución.
runStart	string (date-time)	Hora de inicio de una ejecución de canalización en formato ISO8601.
status	string	Estado de una ejecución de canalización. Valores posibles: Queued, InProgress, Succeeded, Failed, Canceling, Cancelled

PipelineRunInvokedBy

Objeto

Proporciona el nombre y el identificador de entidad que iniciaron la ejecución de la canalización.

Nombre	Tipo	Description
id	string	Identificador de la entidad que inició la ejecución.
invokedByType	string	Tipo de la entidad que inició la ejecución.
name	string	Nombre de la entidad que inició la ejecución de la canalización.
pipelineName	string	Nombre de la canalización que desencadenó la ejecución, si existe.
pipelineRunId	string	Identificador de ejecución de la canalización que desencadenó la ejecución, si existe.

Compartir a través de

Pipeline Runs - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

PipelineRuns_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

PipelineRun

PipelineRunInvokedBy