Activity Runs - Query By Pipeline Run

Служба:: Data Factory

Версия API:: 2018-06-01

Действие запроса выполняется в зависимости от условий фильтра ввода.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?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	Имя группы ресурсов. Имя регистронезависимо.
runId	path	True	string	Идентификатор выполнения конвейера.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
lastUpdatedAfter	True	string (date-time)	Время или после обновления события выполнения в формате ISO 8601.
lastUpdatedBefore	True	string (date-time)	Время или до обновления события выполнения в формате ISO 8601.
continuationToken		string	Маркер продолжения для получения следующей страницы результатов. Null для первой страницы.
filters		RunQueryFilter[]	Список фильтров.
orderBy		RunQueryOrderBy[]	Список параметра OrderBy.

Ответы

Имя	Тип	Описание
200 OK	ActivityRunsQueryResponse	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ActivityRuns_QueryByPipelineRun

Образец запроса

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b/queryActivityruns?api-version=2018-06-01

{
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z"
}


import com.azure.resourcemanager.datafactory.models.RunFilterParameters;
import java.time.OffsetDateTime;

/**
 * Samples for ActivityRuns QueryByPipelineRun.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/ActivityRuns_QueryByPipelineRun.json
     */
    /**
     * Sample code: ActivityRuns_QueryByPipelineRun.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void
        activityRunsQueryByPipelineRun(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.activityRuns().queryByPipelineRunWithResponse("exampleResourceGroup", "exampleFactoryName",
            "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
            new RunFilterParameters().withLastUpdatedAfter(OffsetDateTime.parse("2018-06-16T00:36:44.3345758Z"))
                .withLastUpdatedBefore(OffsetDateTime.parse("2018-06-16T00:49:48.3686473Z")),
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python activity_runs_query_by_pipeline_run.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.activity_runs.query_by_pipeline_run(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        run_id="2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
        filter_parameters={
            "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
            "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z",
        },
    )
    print(response)


# x-ms-original-file: 2018-06-01/ActivityRuns_QueryByPipelineRun.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

package armdatafactory_test

import (
	"context"
	"log"
	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/ActivityRuns_QueryByPipelineRun.json
func ExampleActivityRunsClient_QueryByPipelineRun() {
	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.NewActivityRunsClient().QueryByPipelineRun(ctx, "exampleResourceGroup", "exampleFactoryName", "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", armdatafactory.RunFilterParameters{
		LastUpdatedAfter:  to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:36:44.3345758Z"); return t }()),
		LastUpdatedBefore: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:49:48.3686473Z"); return t }()),
	}, 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.ActivityRunsClientQueryByPipelineRunResponse{
	// 	ActivityRunsQueryResponse: &armdatafactory.ActivityRunsQueryResponse{
	// 		Value: []*armdatafactory.ActivityRun{
	// 			{
	// 				ActivityName: to.Ptr("ExampleForeachActivity"),
	// 				ActivityRunEnd: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:38:11.5445431Z"); return t}()),
	// 				ActivityRunID: to.Ptr("f30c5514-fb85-43ed-9fa4-768d42e58680"),
	// 				ActivityRunStart: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:37:49.4804925Z"); return t}()),
	// 				ActivityType: to.Ptr("ForEach"),
	// 				DurationInMs: to.Ptr[int32](22064),
	// 				Error: map[string]any{
	// 					"errorCode": "",
	// 					"failureType": "",
	// 					"message": "",
	// 					"target": "ExampleForeachActivity",
	// 				},
	// 				Input: map[string]any{
	// 				},
	// 				LinkedServiceName: to.Ptr(""),
	// 				Output: map[string]any{
	// 				},
	// 				PipelineName: to.Ptr("examplePipeline"),
	// 				PipelineRunID: to.Ptr("2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"),
	// 				Status: to.Ptr("Succeeded"),
	// 				AdditionalProperties: map[string]any{
	// 				"retryAttempt": nil,
	// 				"userProperties": map[string]any{
	// 				},
	// 			},
	// 			},
	// 			{
	// 				ActivityName: to.Ptr("ExampleCopyActivity"),
	// 				ActivityRunEnd: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:38:07.4188923Z"); return t}()),
	// 				ActivityRunID: to.Ptr("a96678c8-7167-4f00-b629-afccfbad4e51"),
	// 				ActivityRunStart: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:37:50.2460952Z"); return t}()),
	// 				ActivityType: to.Ptr("Copy"),
	// 				DurationInMs: to.Ptr[int32](17172),
	// 				Error: map[string]any{
	// 					"errorCode": "",
	// 					"failureType": "",
	// 					"message": "",
	// 					"target": "ExampleCopyActivity",
	// 				},
	// 				Input: map[string]any{
	// 					"dataIntegrationUnits": 32,
	// 					"sink": map[string]any{
	// 						"type": "BlobSink",
	// 					},
	// 					"source": map[string]any{
	// 						"type": "BlobSource",
	// 					},
	// 				},
	// 				LinkedServiceName: to.Ptr(""),
	// 				Output: map[string]any{
	// 					"copyDuration": 6,
	// 					"dataRead": 142000,
	// 					"dataWritten": 142000,
	// 					"effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)",
	// 					"errors": []any{
	// 					},
	// 					"executionDetails": []any{
	// 						map[string]any{
	// 							"detailedDurations": map[string]any{
	// 								"queuingDuration": 4,
	// 								"transferDuration": 2,
	// 							},
	// 							"duration": 6,
	// 							"sink": map[string]any{
	// 								"type": "AzureBlob",
	// 							},
	// 							"source": map[string]any{
	// 								"type": "AzureBlob",
	// 							},
	// 							"start": "2018-06-16T00:37:50.68834Z",
	// 							"status": "Succeeded",
	// 							"usedCloudDataMovementUnits": 4,
	// 							"usedParallelCopies": 1,
	// 						},
	// 					},
	// 					"filesRead": 1,
	// 					"filesWritten": 1,
	// 					"throughput": 23.112,
	// 					"usedCloudDataMovementUnits": 4,
	// 					"usedParallelCopies": 1,
	// 				},
	// 				PipelineName: to.Ptr("examplePipeline"),
	// 				PipelineRunID: to.Ptr("2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"),
	// 				Status: to.Ptr("Succeeded"),
	// 				AdditionalProperties: map[string]any{
	// 				"retryAttempt": nil,
	// 				"userProperties": map[string]any{
	// 				},
	// 			},
	// 			},
	// 		},
	// 	},
	// }
}

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

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to query activity runs based on input filter conditions.
 *
 * @summary query activity runs based on input filter conditions.
 * x-ms-original-file: 2018-06-01/ActivityRuns_QueryByPipelineRun.json
 */
async function activityRunsQueryByPipelineRun() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.activityRuns.queryByPipelineRun(
    "exampleResourceGroup",
    "exampleFactoryName",
    "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
    {
      lastUpdatedAfter: new Date("2018-06-16T00:36:44.3345758Z"),
      lastUpdatedBefore: new Date("2018-06-16T00:49:48.3686473Z"),
    },
  );
  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

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/ActivityRuns_QueryByPipelineRun.json
// this example is just showing the usage of "ActivityRuns_QueryByPipelineRun" 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 and iterate over the result
string runId = "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b";
RunFilterContent content = new RunFilterContent(DateTimeOffset.Parse("2018-06-16T00:36:44.3345758Z"), DateTimeOffset.Parse("2018-06-16T00:49:48.3686473Z"));
await foreach (PipelineActivityRunInformation item in dataFactory.GetActivityRunAsync(runId, content))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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:13 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9
x-ms-ratelimit-remaining-subscription-writes: 1187
x-ms-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9

{
  "value": [
    {
      "activityName": "ExampleForeachActivity",
      "activityRunEnd": "2018-06-16T00:38:11.5445431Z",
      "activityRunId": "f30c5514-fb85-43ed-9fa4-768d42e58680",
      "activityRunStart": "2018-06-16T00:37:49.4804925Z",
      "activityType": "ForEach",
      "durationInMs": 22064,
      "error": {
        "errorCode": "",
        "failureType": "",
        "message": "",
        "target": "ExampleForeachActivity"
      },
      "input": {},
      "linkedServiceName": "",
      "output": {},
      "pipelineName": "examplePipeline",
      "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "retryAttempt": null,
      "status": "Succeeded",
      "userProperties": {}
    },
    {
      "activityName": "ExampleCopyActivity",
      "activityRunEnd": "2018-06-16T00:38:07.4188923Z",
      "activityRunId": "a96678c8-7167-4f00-b629-afccfbad4e51",
      "activityRunStart": "2018-06-16T00:37:50.2460952Z",
      "activityType": "Copy",
      "durationInMs": 17172,
      "error": {
        "errorCode": "",
        "failureType": "",
        "message": "",
        "target": "ExampleCopyActivity"
      },
      "input": {
        "dataIntegrationUnits": 32,
        "sink": {
          "type": "BlobSink"
        },
        "source": {
          "type": "BlobSource"
        }
      },
      "linkedServiceName": "",
      "output": {
        "copyDuration": 6,
        "dataRead": 142000,
        "dataWritten": 142000,
        "effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)",
        "errors": [],
        "executionDetails": [
          {
            "detailedDurations": {
              "queuingDuration": 4,
              "transferDuration": 2
            },
            "duration": 6,
            "sink": {
              "type": "AzureBlob"
            },
            "source": {
              "type": "AzureBlob"
            },
            "start": "2018-06-16T00:37:50.68834Z",
            "status": "Succeeded",
            "usedCloudDataMovementUnits": 4,
            "usedParallelCopies": 1
          }
        ],
        "filesRead": 1,
        "filesWritten": 1,
        "throughput": 23.112,
        "usedCloudDataMovementUnits": 4,
        "usedParallelCopies": 1
      },
      "pipelineName": "examplePipeline",
      "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "retryAttempt": null,
      "status": "Succeeded",
      "userProperties": {}
    }
  ]
}

Определения

Имя	Описание
ActivityRun	Сведения о выполнении действия в конвейере.
ActivityRunsQueryResponse	Выполняется действие списка.
CloudError	Объект, определяющий структуру ответа об ошибке Фабрики данных Azure.
RunFilterParameters	Параметры запроса для перечисления запусков.
RunQueryFilter	Параметр фильтра запросов для перечисления запусков.
RunQueryFilterOperand	Имя параметра, используемое для фильтрации. Допустимые операнды для выполнения конвейеров запросов: PipelineName, RunStart, RunEnd и Status; для выполнения действий запроса являются ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType и Status, а для запуска триггера запроса — TriggerName, TriggerRunTimestamp и Status.
RunQueryFilterOperator	Оператор, используемый для фильтрации.
RunQueryOrder	Порядок сортировки параметра.
RunQueryOrderBy	Объект, предоставляющий порядок по параметрам для перечисления запусков.
RunQueryOrderByField	Имя параметра, используемое для заказа. Допустимые параметры для выполнения конвейера: PipelineName, RunStart, RunEnd и Status; для выполнения действий являются ActivityName, ActivityRunStart, ActivityRunEnd и Status; для запусков триггеров являются TriggerName, TriggerRunTimestamp и Status.

ActivityRun

Объект

Сведения о выполнении действия в конвейере.

Имя	Тип	Описание
activityName	string	Имя действия.
activityRunEnd	string (date-time)	Время окончания действия в формате ISO 8601.
activityRunId	string	Идентификатор выполнения действия.
activityRunStart	string (date-time)	Время начала действия в формате ISO 8601.
activityType	string	Тип действия.
durationInMs	integer (int32)	Длительность выполнения действия.
error		Ошибка при выполнении действия.
input		Входные данные для действия.
linkedServiceName	string	Имя связанной службы вычислений.
output		Выходные данные для действия.
pipelineName	string	Имя конвейера.
pipelineRunId	string	Идентификатор запуска конвейера.
status	string	Состояние выполнения действия.

ActivityRunsQueryResponse

Объект

Выполняется действие списка.

Имя	Тип	Описание
continuationToken	string	Маркер продолжения для получения следующей страницы результатов, если все оставшиеся результаты существуют, значение NULL в противном случае.
value	ActivityRun[]	Список запусков действий.

CloudError

Объект

Объект, определяющий структуру ответа об ошибке Фабрики данных Azure.

Имя	Тип	Описание
error.code	string	Код ошибки.
error.details	CloudError[]	Массив с дополнительными сведениями об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Имя или путь свойства в запросе, связанном с ошибкой.

RunFilterParameters

Объект

Параметры запроса для перечисления запусков.

Имя	Тип	Описание
continuationToken	string	Маркер продолжения для получения следующей страницы результатов. Null для первой страницы.
filters	RunQueryFilter[]	Список фильтров.
lastUpdatedAfter	string (date-time)	Время или после обновления события выполнения в формате ISO 8601.
lastUpdatedBefore	string (date-time)	Время или до обновления события выполнения в формате ISO 8601.
orderBy	RunQueryOrderBy[]	Список параметра OrderBy.

RunQueryFilter

Объект

Параметр фильтра запросов для перечисления запусков.

Имя	Тип	Описание
operand	RunQueryFilterOperand	Имя параметра, используемое для фильтрации. Допустимые операнды для выполнения конвейеров запросов: PipelineName, RunStart, RunEnd и Status; для выполнения действий запроса являются ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType и Status, а для запуска триггера запроса — TriggerName, TriggerRunTimestamp и Status.
operator	RunQueryFilterOperator	Оператор, используемый для фильтрации.
values	string[]	Список значений фильтра.

RunQueryFilterOperand

Перечисление

Имя параметра, используемое для фильтрации. Допустимые операнды для выполнения конвейеров запросов: PipelineName, RunStart, RunEnd и Status; для выполнения действий запроса являются ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType и Status, а для запуска триггера запроса — TriggerName, TriggerRunTimestamp и Status.

Значение	Описание
PipelineName	НазваниеТрубопровода
Status	Статус
RunStart	RunStart
RunEnd	RunEnd
ActivityName	Название мероприятия
ActivityRunStart	ActivityRunStart
ActivityRunEnd	ActivityRunEnd
ActivityType	ТипАктивности
TriggerName	Название триггера
TriggerRunTimestamp	TriggerRunTimestamp
RunGroupId	RunGroupId
LatestOnly	LatestOnly

RunQueryFilterOperator

Перечисление

Оператор, используемый для фильтрации.

Значение	Описание
Equals	Равно
NotEquals	NotEquals
In	In
NotIn	NotIn

RunQueryOrder

Перечисление

Порядок сортировки параметра.

Значение	Описание
ASC	ASC
DESC	DESC

RunQueryOrderBy

Объект

Объект, предоставляющий порядок по параметрам для перечисления запусков.

Имя	Тип	Описание
order	RunQueryOrder	Порядок сортировки параметра.
orderBy	RunQueryOrderByField	Имя параметра, используемое для заказа. Допустимые параметры для выполнения конвейера: PipelineName, RunStart, RunEnd и Status; для выполнения действий являются ActivityName, ActivityRunStart, ActivityRunEnd и Status; для запусков триггеров являются TriggerName, TriggerRunTimestamp и Status.

RunQueryOrderByField

Перечисление

Имя параметра, используемое для заказа. Допустимые параметры для выполнения конвейера: PipelineName, RunStart, RunEnd и Status; для выполнения действий являются ActivityName, ActivityRunStart, ActivityRunEnd и Status; для запусков триггеров являются TriggerName, TriggerRunTimestamp и Status.

Значение	Описание
RunStart	RunStart
RunEnd	RunEnd
PipelineName	НазваниеТрубопровода
Status	Статус
ActivityName	Название мероприятия
ActivityRunStart	ActivityRunStart
ActivityRunEnd	ActivityRunEnd
TriggerName	Название триггера
TriggerRunTimestamp	TriggerRunTimestamp