你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Pipeline Runs - Get

服务:: Data Factory

API 版本:: 2018-06-01

按管道运行 ID 获取管道运行。

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

URI 参数

名称	在	必需	类型	说明
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 pattern: ^[-\w\._]+$	资源组名称。
runId	path	True	string	管道运行标识符。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 版本。

响应

名称	类型	说明
200 OK	PipelineRun	还行。
Other Status Codes	CloudError	从 Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

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

示例响应

状态代码:: 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": []
}

定义

名称	说明
CloudError	定义 Azure 数据工厂错误响应结构的对象。
PipelineRun	有关管道运行的信息。
PipelineRunInvokedBy	提供启动管道运行的实体名称和 ID。

CloudError

对象

定义 Azure 数据工厂错误响应结构的对象。

名称	类型	说明
error.code	string	错误代码。
error.details	CloudError[]	包含其他错误详细信息的数组。
error.message	string	错误信息。
error.target	string	与错误关联的请求中的属性名称/路径。

PipelineRun

对象

有关管道运行的信息。

名称	类型	说明
durationInMs	integer	管道运行的持续时间。
invokedBy	PipelineRunInvokedBy	启动管道运行的实体。
isLatest	boolean	指示恢复的管道运行是否是其组中的最新运行。
lastUpdated	string (date-time)	管道运行事件的上次更新时间戳ISO8601格式。
message	string	管道运行中的消息。
parameters	object	管道运行中使用的参数名称的完整或部分列表、值对。
pipelineName	string	管道名称。
runDimensions	object	管道运行发出的运行维度。
runEnd	string (date-time)	管道运行的结束时间采用ISO8601格式。
runGroupId	string	关联管道运行的所有恢复运行的标识符。
runId	string	运行的标识符。
runStart	string (date-time)	管道运行的开始时间ISO8601格式。
status	string	管道运行的状态。可能的值：Queued、InProgress、Succeeded、Failed、Canceling、Canceled

PipelineRunInvokedBy

对象

提供启动管道运行的实体名称和 ID。

名称	类型	说明
id	string	启动运行的实体的 ID。
invokedByType	string	启动运行的实体的类型。
name	string	启动管道运行的实体的名称。
pipelineName	string	触发运行的管道的名称（如果有）。
pipelineRunId	string	触发运行的管道的运行 ID（如果有）。

通过