Triggers - Get

Service:: Data Factory

API Version:: 2018-06-01

Gets a trigger.

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	Required	Type	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	The factory name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	The resource group name.
subscriptionId	path	True	string	The subscription identifier.
triggerName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	The trigger name.
api-version	query	True	string	The API version.

Request Header

Name	Required	Type	Description
If-None-Match		string	ETag of the trigger entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Responses

Name	Type	Description
200 OK	TriggerResource	OK.
Other Status Codes		Not modified.
Other Status Codes	CloudError	An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Triggers_Get

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

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/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 DataFactoryTriggerResource created on azure
// for more information of creating DataFactoryTriggerResource, please refer to the document of DataFactoryTriggerResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string triggerName = "exampleTrigger";
ResourceIdentifier dataFactoryTriggerResourceId = DataFactoryTriggerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, triggerName);
DataFactoryTriggerResource dataFactoryTrigger = client.GetDataFactoryTriggerResource(dataFactoryTriggerResourceId);

// invoke the operation
DataFactoryTriggerResource result = await dataFactoryTrigger.GetAsync();

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

Sample response

Status code:: 304

Status code:: 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"
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Data Factory error response.
MultiplePipelineTrigger	Base class for all triggers that support one to many model for trigger to pipeline.
PipelineReference	Pipeline reference type.
TriggerPipelineReference	Pipeline that needs to be triggered with the given parameters.
TriggerResource	Trigger resource type.
TriggerRuntimeState	Enumerates possible state of Triggers.

CloudError

Object

The object that defines the structure of an Azure Data Factory error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

MultiplePipelineTrigger

Object

Base class for all triggers that support one to many model for trigger to pipeline.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the trigger.
description	string	Trigger description.
pipelines	TriggerPipelineReference[]	Pipelines that need to be started.
runtimeState	TriggerRuntimeState	Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger.
type	string: MultiplePipelineTrigger	Trigger type.

PipelineReference

Object

Pipeline reference type.

Name	Type	Description
name	string	Reference name.
referenceName	string	Reference pipeline name.
type	enum: PipelineReference	Pipeline reference type.

TriggerPipelineReference

Object

Pipeline that needs to be triggered with the given parameters.

Name	Type	Description
parameters	object	Pipeline parameters.
pipelineReference	PipelineReference	Pipeline reference.

TriggerResource

Object

Trigger resource type.

Name	Type	Description
etag	string	Etag identifies change in the resource.
id	string	The resource identifier.
name	string	The resource name.
properties	Trigger: MultiplePipelineTrigger	Properties of the trigger.
type	string	The resource type.

TriggerRuntimeState

Enumeration

Enumerates possible state of Triggers.

Value	Description
Started
Stopped
Disabled

Share via

Triggers - Get

URI Parameters

Request Header

Responses

Security

azure_auth

Scopes

Examples

Triggers_Get

Sample request

Sample response

Definitions

CloudError

MultiplePipelineTrigger

PipelineReference

TriggerPipelineReference

TriggerResource

TriggerRuntimeState