Triggers - Query By Factory

Référence

Service:: Data Factory

Version d'API:: 2018-06-01

Déclencheurs de requête.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
factoryName	path	True	string	Nom de la fabrique. Modèle d’expression régulière: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Nom du groupe de ressources. Modèle d’expression régulière: `^[-\w\._\(\)]+$`
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l'API.

Corps de la demande

Nom	Type	Description
continuationToken	string	Jeton de continuation pour obtenir la page suivante des résultats. Null pour la première page.
parentTriggerName	string	Nom du tumblingWindowTrigger parent pour obtenir les déclencheurs de réexécuter l’enfant

Réponses

Nom	Type	Description
200 OK	TriggerQueryResponse	OK.
Other Status Codes	CloudError	Réponse d’erreur reçue du service Azure Data Factory.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Triggers_QueryByFactory

Exemple de requête

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"
}


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

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

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/v9"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DataFactory;

// 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

Exemple de réponse

Code d’état:: 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"
      }
    }
  ]
}

Définitions

Nom	Description
CloudError	Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.
MultiplePipelineTrigger	Classe de base pour tous les déclencheurs qui prennent en charge un à plusieurs modèles pour le déclencheur vers le pipeline.
PipelineReference	Type de référence de pipeline.
TriggerFilterParameters	Interroger les paramètres des déclencheurs.
TriggerPipelineReference	Pipeline qui doit être déclenché avec les paramètres donnés.
TriggerQueryResponse	Requête de déclencheurs.
TriggerResource	Type de ressource déclencheur.
TriggerRuntimeState	Énumère l’état possible des déclencheurs.

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

Nom	Type	Description
error.code	string	Code d’erreur.
error.details	CloudError[]	Tableau avec des détails d’erreur supplémentaires.
error.message	string	Message d’erreur.
error.target	string	Nom de propriété/chemin d’accès dans la requête associée à l’erreur.

MultiplePipelineTrigger

Classe de base pour tous les déclencheurs qui prennent en charge un à plusieurs modèles pour le déclencheur vers le pipeline.

Nom	Type	Description
annotations	object[]	Liste des balises qui peuvent être utilisées pour décrire le déclencheur.
description	string	Description du déclencheur.
pipelines	TriggerPipelineReference[]	Pipelines qui doivent être démarrés.
runtimeState	TriggerRuntimeState	Indique si le déclencheur est en cours d’exécution ou non. Mise à jour lorsque les API Start/Stop sont appelées sur le déclencheur.
type	string: MultiplePipelineTrigger	Type de déclencher.

PipelineReference

Type de référence de pipeline.

Nom	Type	Description
name	string	Nom de référence.
referenceName	string	Nom du pipeline de référence.
type	enum: PipelineReference	Type de référence de pipeline.

TriggerFilterParameters

Interroger les paramètres des déclencheurs.

Nom	Type	Description
continuationToken	string	Jeton de continuation pour obtenir la page suivante des résultats. Null pour la première page.
parentTriggerName	string	Nom du tumblingWindowTrigger parent pour obtenir les déclencheurs de réexécuter l’enfant

TriggerPipelineReference

Pipeline qui doit être déclenché avec les paramètres donnés.

Nom	Type	Description
parameters	object	Paramètres de pipeline.
pipelineReference	PipelineReference	Référence de pipeline.

TriggerQueryResponse

Requête de déclencheurs.

Nom	Type	Description
continuationToken	string	Jeton de continuation permettant d’obtenir la page suivante des résultats, si des résultats restants existent, null dans le cas contraire.
value	TriggerResource[]	Liste des déclencheurs.

TriggerResource

Type de ressource déclencheur.

Nom	Type	Description
etag	string	Etag identifie les modifications apportées à la ressource.
id	string	Identificateur de ressource.
name	string	Nom de la ressource.
properties	Trigger: MultiplePipelineTrigger	Propriétés du déclencheur.
type	string	Type de ressource.

TriggerRuntimeState

Énumère l’état possible des déclencheurs.

Nom	Type	Description
Disabled	string
Started	string
Stopped	string