Triggers - Query By Factory

서비스:

Data Factory

API 버전:

2018-06-01

쿼리 트리거.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
factoryName	path	True	string	팩터리 이름입니다. regex 패턴: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	리소스 그룹 이름입니다. regex 패턴: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	구독 식별자입니다.
api-version	query	True	string	API 버전입니다.

요청 본문

Name	형식	Description
continuationToken	string	결과의 다음 페이지를 가져오기 위한 연속 토큰입니다. 첫 번째 페이지의 경우 Null입니다.
parentTriggerName	string	자식 다시 실행 트리거를 가져올 부모 TumblingWindowTrigger의 이름입니다.

응답

Name	형식	Description
200 OK	TriggerQueryResponse	OK.
Other Status Codes	CloudError	Azure Data Factory 서비스에서 받은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

Triggers_QueryByFactory

Sample request

HTTP

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/querytriggers?api-version=2018-06-01

{
  "parentTriggerName": "exampleTrigger"
}

Java

import com.azure.resourcemanager.datafactory.models.TriggerFilterParameters;

/**
 * Samples for Triggers QueryByFactory.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * Triggers_QueryByFactory.json
     */
    /**
     * Sample code: Triggers_QueryByFactory.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void triggersQueryByFactory(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.triggers().queryByFactoryWithResponse("exampleResourceGroup", "exampleFactoryName",
            new TriggerFilterParameters().withParentTriggerName("exampleTrigger"), 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 typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python triggers_query_by_factory.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="12345678-1234-1234-1234-12345678abc",
    )

    response = client.triggers.query_by_factory(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        filter_parameters={"parentTriggerName": "exampleTrigger"},
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_QueryByFactory.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v8"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f6f50c6388fd5836fa142384641b8353a99874ef/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_QueryByFactory.json
func ExampleTriggersClient_QueryByFactory() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewTriggersClient().QueryByFactory(ctx, "exampleResourceGroup", "exampleFactoryName", armdatafactory.TriggerFilterParameters{
		ParentTriggerName: to.Ptr("exampleTrigger"),
	}, 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.TriggerQueryResponse = armdatafactory.TriggerQueryResponse{
	// 	Value: []*armdatafactory.TriggerResource{
	// 		{
	// 			Name: to.Ptr("exampleRerunTrigger"),
	// 			Type: to.Ptr("Microsoft.DataFactory/factories/triggers"),
	// 			ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleRerunTrigger"),
	// 			Properties: &armdatafactory.RerunTumblingWindowTrigger{
	// 				Type: to.Ptr("RerunTumblingWindowTrigger"),
	// 				Description: to.Ptr("Example description"),
	// 				TypeProperties: &armdatafactory.RerunTumblingWindowTriggerTypeProperties{
	// 					ParentTrigger: "exampleTrigger",
	// 					RequestedEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:55:14.905Z"); return t}()),
	// 					RequestedStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-16T00:39:14.905Z"); return t}()),
	// 					RerunConcurrency: to.Ptr[int32](4),
	// 				},
	// 			},
	// 	}},
	// }
}

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 Query triggers.
 *
 * @summary Query triggers.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_QueryByFactory.json
 */
async function triggersQueryByFactory() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const filterParameters = {
    parentTriggerName: "exampleTrigger",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.triggers.queryByFactory(
    resourceGroupName,
    factoryName,
    filterParameters,
  );
  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 System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataFactory;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_QueryByFactory.json
// this example is just showing the usage of "Triggers_QueryByFactory" 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
TriggerFilterContent content = new TriggerFilterContent()
{
    ParentTriggerName = "exampleTrigger",
};
await foreach (DataFactoryTriggerResource item in dataFactory.GetTriggersAsync(content))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    DataFactoryTriggerData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Sample response

Status code:

200

Date: Sat, 16 Jun 2018 00:40:20 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14986
x-ms-request-id: e474f8f8-b34f-4536-b059-ca740e6b44c3
x-ms-correlation-request-id: e474f8f8-b34f-4536-b059-ca740e6b44c3

{
  "value": [
    {
      "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleRerunTrigger",
      "name": "exampleRerunTrigger",
      "type": "Microsoft.DataFactory/factories/triggers",
      "properties": {
        "type": "RerunTumblingWindowTrigger",
        "typeProperties": {
          "parentTrigger": "exampleTrigger",
          "requestedStartTime": "2018-06-16T00:39:14.905167Z",
          "requestedEndTime": "2018-06-16T00:55:14.905167Z",
          "rerunConcurrency": 4
        },
        "description": "Example description"
      }
    }
  ]
}

정의

Name	Description
CloudError	Azure Data Factory 오류 응답의 구조를 정의하는 개체입니다.
MultiplePipelineTrigger	트리거-파이프라인에 대해 1대 다 모델을 지원하는 모든 트리거의 기본 클래스입니다.
PipelineReference	파이프라인 참조 형식입니다.
TriggerFilterParameters	트리거에 대한 쿼리 매개 변수입니다.
TriggerPipelineReference	지정된 매개 변수를 사용하여 트리거해야 하는 파이프라인입니다.
TriggerQueryResponse	트리거 쿼리입니다.
TriggerResource	리소스 유형을 트리거합니다.
TriggerRuntimeState	트리거의 가능한 상태를 열거합니다.

CloudError

Azure Data Factory 오류 응답의 구조를 정의하는 개체입니다.

Name	형식	Description
error.code	string	오류 코드
error.details	CloudError[]	추가 오류 세부 정보가 있는 배열입니다.
error.message	string	오류 메시지입니다.
error.target	string	오류와 관련된 요청의 속성 이름/경로입니다.

MultiplePipelineTrigger

트리거-파이프라인에 대해 1대 다 모델을 지원하는 모든 트리거의 기본 클래스입니다.

Name	형식	Description
annotations	object[]	트리거를 설명하는 데 사용할 수 있는 태그 목록입니다.
description	string	트리거 설명입니다.
pipelines	TriggerPipelineReference[]	시작해야 하는 파이프라인입니다.
runtimeState	TriggerRuntimeState	트리거가 실행 중인지 여부를 나타냅니다. 트리거에서 시작/중지 API가 호출되면 업데이트됩니다.
type	string: MultiplePipelineTrigger	트리거 유형입니다.

PipelineReference

파이프라인 참조 형식입니다.

Name	형식	Description
name	string	참조 이름입니다.
referenceName	string	참조 파이프라인 이름입니다.
type	enum: PipelineReference	파이프라인 참조 형식입니다.

TriggerFilterParameters

트리거에 대한 쿼리 매개 변수입니다.

Name	형식	Description
continuationToken	string	결과의 다음 페이지를 가져오기 위한 연속 토큰입니다. 첫 번째 페이지의 경우 Null입니다.
parentTriggerName	string	자식 다시 실행 트리거를 가져올 부모 TumblingWindowTrigger의 이름입니다.

TriggerPipelineReference

지정된 매개 변수를 사용하여 트리거해야 하는 파이프라인입니다.

Name	형식	Description
parameters	object	파이프라인 매개 변수
pipelineReference	PipelineReference	파이프라인 참조입니다.

TriggerQueryResponse

트리거 쿼리입니다.

Name	형식	Description
continuationToken	string	결과의 다음 페이지를 가져오기 위한 연속 토큰이며, 나머지 결과가 있는 경우 null이면 입니다.
value	TriggerResource[]	트리거 목록입니다.

TriggerResource

리소스 유형을 트리거합니다.

Name	형식	Description
etag	string	Etag는 리소스의 변경 사항을 식별합니다.
id	string	리소스 식별자입니다.
name	string	리소스 이름입니다.
properties	Trigger: MultiplePipelineTrigger	트리거의 속성입니다.
type	string	리소스 종류입니다.

TriggerRuntimeState

트리거의 가능한 상태를 열거합니다.

Name	형식	Description
Disabled	string
Started	string
Stopped	string