Triggers - Get

Service:

Data Factory

API-versie:

2018-06-01

Hiermee haalt u een trigger op.

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

URI-parameters

Name	In	Vereist	Type	Description
factoryName	path	True	string	De naam van de fabriek. Regex-patroon: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	De naam van de resourcegroep. Regex-patroon: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	De abonnements-id.
triggerName	path	True	string	De naam van de trigger. Regex-patroon: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$
api-version	query	True	string	De API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-None-Match		string	ETag van de triggerentiteit. Moet alleen worden opgegeven voor get. Als de ETag overeenkomt met de bestaande entiteitstag of als * is opgegeven, wordt er geen inhoud geretourneerd.

Antwoorden

Name	Type	Description
200 OK	TriggerResource	OK.
Other Status Codes		Niet gewijzigd.
Other Status Codes	CloudError	Er is een foutbericht ontvangen van de Azure Data Factory-service.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Triggers_Get

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for Triggers Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Get.json
     */
    /**
     * Sample code: Triggers_Get.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void triggersGet(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.triggers().getWithResponse("exampleResourceGroup", "exampleFactoryName", "exampleTrigger", null,
            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 azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python triggers_get.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.get(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        trigger_name="exampleTrigger",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Get.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/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_Get.json
func ExampleTriggersClient_Get() {
	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().Get(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleTrigger", &armdatafactory.TriggersClientGetOptions{IfNoneMatch: 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.TriggerResource = armdatafactory.TriggerResource{
	// 	Name: to.Ptr("exampleTrigger"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/triggers"),
	// 	Etag: to.Ptr("1500544f-0000-0200-0000-5cbe09100000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger"),
	// 	Properties: &armdatafactory.ScheduleTrigger{
	// 		Type: to.Ptr("ScheduleTrigger"),
	// 		RuntimeState: to.Ptr(armdatafactory.TriggerRuntimeStateStopped),
	// 		Pipelines: []*armdatafactory.TriggerPipelineReference{
	// 			{
	// 				Parameters: map[string]any{
	// 					"OutputBlobNameList": []any{
	// 						"exampleoutput.csv",
	// 					},
	// 				},
	// 				PipelineReference: &armdatafactory.PipelineReference{
	// 					Type: to.Ptr(armdatafactory.PipelineReferenceTypePipelineReference),
	// 					ReferenceName: to.Ptr("examplePipeline"),
	// 				},
	// 		}},
	// 		TypeProperties: &armdatafactory.ScheduleTriggerTypeProperties{
	// 			Recurrence: &armdatafactory.ScheduleTriggerRecurrence{
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-22T18:48:52.528Z"); return t}()),
	// 				Frequency: to.Ptr(armdatafactory.RecurrenceFrequencyMinute),
	// 				Interval: to.Ptr[int32](4),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-22T18:32:52.527Z"); return t}()),
	// 				TimeZone: to.Ptr("UTC"),
	// 			},
	// 		},
	// 	},
	// }
}

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 Gets a trigger.
 *
 * @summary Gets a trigger.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Triggers_Get.json
 */
async function triggersGet() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const triggerName = "exampleTrigger";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.triggers.get(resourceGroupName, factoryName, triggerName);
  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 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/stable/2018-06-01/examples/Triggers_Get.json
// this example is just showing the usage of "Triggers_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);

// get the collection of this DataFactoryTriggerResource
DataFactoryTriggerCollection collection = dataFactory.GetDataFactoryTriggers();

// invoke the operation
string triggerName = "exampleTrigger";
NullableResponse<DataFactoryTriggerResource> response = await collection.GetIfExistsAsync(triggerName);
DataFactoryTriggerResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Voorbeeldrespons

Statuscode:

304

Statuscode:

200

Date: Mon, 22 Apr 2019 18:33:52 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11989
x-ms-request-id: 8ad1759f-24c1-46a5-aef5-edd267e18870
x-ms-correlation-request-id: 8ad1759f-24c1-46a5-aef5-edd267e18870

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/triggers/exampleTrigger",
  "name": "exampleTrigger",
  "type": "Microsoft.DataFactory/factories/triggers",
  "properties": {
    "type": "ScheduleTrigger",
    "typeProperties": {
      "recurrence": {
        "frequency": "Minute",
        "interval": 4,
        "startTime": "2019-04-22T18:32:52.527912Z",
        "endTime": "2019-04-22T18:48:52.5281747Z",
        "timeZone": "UTC"
      }
    },
    "pipelines": [
      {
        "pipelineReference": {
          "referenceName": "examplePipeline",
          "type": "PipelineReference"
        },
        "parameters": {
          "OutputBlobNameList": [
            "exampleoutput.csv"
          ]
        }
      }
    ],
    "runtimeState": "Stopped"
  },
  "etag": "1500544f-0000-0200-0000-5cbe09100000"
}

Definities

Name	Description
CloudError	Het object dat de structuur van een Azure Data Factory foutreactie definieert.
MultiplePipelineTrigger	Basisklasse voor alle triggers die ondersteuning bieden voor een-op-veel-model voor trigger naar pijplijn.
PipelineReference	Type pijplijnreferentie.
TriggerPipelineReference	Pijplijn die moet worden geactiveerd met de opgegeven parameters.
TriggerResource	Resourcetype activeren.
TriggerRuntimeState	Inventariseert de mogelijke status van triggers.

CloudError

Het object dat de structuur van een Azure Data Factory foutreactie definieert.

Name	Type	Description
error.code	string	Foutcode.
error.details	CloudError[]	Matrix met aanvullende foutdetails.
error.message	string	Foutbericht.
error.target	string	Eigenschapsnaam/-pad in aanvraag die is gekoppeld aan een fout.

MultiplePipelineTrigger

Basisklasse voor alle triggers die ondersteuning bieden voor een-op-veel-model voor trigger naar pijplijn.

Name	Type	Description
annotations	object[]	Lijst met tags die kunnen worden gebruikt voor het beschrijven van de trigger.
description	string	Beschrijving van trigger.
pipelines	TriggerPipelineReference[]	Pijplijnen die moeten worden gestart.
runtimeState	TriggerRuntimeState	Geeft aan of de trigger wordt uitgevoerd of niet. Wordt bijgewerkt wanneer start-/stop-API's worden aangeroepen op de trigger.
type	string: MultiplePipelineTrigger	Triggertype.

PipelineReference

Type pijplijnreferentie.

Name	Type	Description
name	string	Verwijzingsnaam.
referenceName	string	Naam van referentiepijplijn.
type	enum: PipelineReference	Type pijplijnreferentie.

TriggerPipelineReference

Pijplijn die moet worden geactiveerd met de opgegeven parameters.

Name	Type	Description
parameters	object	Pijplijnparameters.
pipelineReference	PipelineReference	Pijplijnreferentie.

TriggerResource

Resourcetype activeren.

Name	Type	Description
etag	string	Etag identificeert wijzigingen in de resource.
id	string	De resource-id.
name	string	De resourcenaam.
properties	Trigger: MultiplePipelineTrigger	Eigenschappen van de trigger.
type	string	Het resourcetype.

TriggerRuntimeState

Inventariseert de mogelijke status van triggers.

Name	Type	Description
Disabled	string
Started	string
Stopped	string