Triggers - Create Or Update

Dienst:: Data Factory

API-Version:: 2018-06-01

Erstellt oder aktualisiert einen Trigger.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Werksname.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Der Ressourcengruppenname.
subscriptionId	path	True	string	Der Abonnementbezeichner.
triggerName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	Der Triggername.
api-version	query	True	string	Die API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Triggerentität. Sollte nur für updates angegeben werden, für die sie mit der vorhandenen Entität übereinstimmen soll oder * für bedingungslose Updates sein kann.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties	True	Trigger: MultiplePipelineTrigger	Eigenschaften des Triggers.

Antworten

Name	Typ	Beschreibung
200 OK	TriggerResource	OKAY.
Other Status Codes	CloudError	Eine Fehlerantwort, die vom Azure Data Factory-Dienst empfangen wurde.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Triggers_Create

Triggers_Update

Triggers_Create

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

{
  "properties": {
    "type": "ScheduleTrigger",
    "typeProperties": {
      "recurrence": {
        "frequency": "Minute",
        "interval": 4,
        "startTime": "2018-06-16T00:39:13.8441801Z",
        "endTime": "2018-06-16T00:55:13.8441801Z",
        "timeZone": "UTC"
      }
    },
    "pipelines": [
      {
        "pipelineReference": {
          "referenceName": "examplePipeline",
          "type": "PipelineReference"
        },
        "parameters": {
          "OutputBlobNameList": [
            "exampleoutput.csv"
          ]
        }
      }
    ]
  }
}

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_Create.json
// this example is just showing the usage of "Triggers_CreateOrUpdate" 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
DataFactoryTriggerData data = new DataFactoryTriggerData(new DataFactoryScheduleTrigger(new ScheduleTriggerRecurrence
{
    Frequency = DataFactoryRecurrenceFrequency.Minute,
    Interval = 4,
    StartOn = DateTimeOffset.Parse("2018-06-16T00:39:13.8441801Z"),
    EndOn = DateTimeOffset.Parse("2018-06-16T00:55:13.8441801Z"),
    TimeZone = "UTC",
})
{
    Pipelines = {new TriggerPipelineReference
    {
    PipelineReference = new DataFactoryPipelineReference(DataFactoryPipelineReferenceType.PipelineReference, "examplePipeline"),
    Parameters =
    {
    ["OutputBlobNameList"] = BinaryData.FromObjectAsJson(new object[]
    {
    "exampleoutput.csv"
    })
    },
    }},
});
ArmOperation<DataFactoryTriggerResource> lro = await dataFactoryTrigger.UpdateAsync(WaitUntil.Completed, data);
DataFactoryTriggerResource result = lro.Value;

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

Beispiel für eine Antwort

Statuscode:: 200

Date: Sat, 16 Jun 2018 00:40:14 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1186
x-ms-request-id: 373f1a49-685d-4c07-8857-0fcf1bcaffcb
x-ms-correlation-request-id: 373f1a49-685d-4c07-8857-0fcf1bcaffcb

{
  "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": "2018-06-16T00:39:13.8441801Z",
        "endTime": "2018-06-16T00:55:13.8441801Z",
        "timeZone": "UTC"
      }
    },
    "pipelines": [
      {
        "pipelineReference": {
          "referenceName": "examplePipeline",
          "type": "PipelineReference"
        },
        "parameters": {
          "OutputBlobNameList": [
            "exampleoutput.csv"
          ]
        }
      }
    ],
    "runtimeState": "Stopped"
  },
  "etag": "0a008ad4-0000-0000-0000-5b245c6e0000"
}

Triggers_Update

Beispielanforderung

HTTP
dotnet

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

{
  "properties": {
    "type": "ScheduleTrigger",
    "typeProperties": {
      "recurrence": {
        "frequency": "Minute",
        "interval": 4,
        "startTime": "2018-06-16T00:39:14.905167Z",
        "endTime": "2018-06-16T00:55:14.905167Z",
        "timeZone": "UTC"
      }
    },
    "pipelines": [
      {
        "pipelineReference": {
          "referenceName": "examplePipeline",
          "type": "PipelineReference"
        },
        "parameters": {
          "OutputBlobNameList": [
            "exampleoutput.csv"
          ]
        }
      }
    ],
    "description": "Example description"
  }
}

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_Update.json
// this example is just showing the usage of "Triggers_CreateOrUpdate" 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
DataFactoryTriggerData data = new DataFactoryTriggerData(new DataFactoryScheduleTrigger(new ScheduleTriggerRecurrence
{
    Frequency = DataFactoryRecurrenceFrequency.Minute,
    Interval = 4,
    StartOn = DateTimeOffset.Parse("2018-06-16T00:39:14.905167Z"),
    EndOn = DateTimeOffset.Parse("2018-06-16T00:55:14.905167Z"),
    TimeZone = "UTC",
})
{
    Pipelines = {new TriggerPipelineReference
    {
    PipelineReference = new DataFactoryPipelineReference(DataFactoryPipelineReferenceType.PipelineReference, "examplePipeline"),
    Parameters =
    {
    ["OutputBlobNameList"] = BinaryData.FromObjectAsJson(new object[]
    {
    "exampleoutput.csv"
    })
    },
    }},
    Description = "Example description",
});
ArmOperation<DataFactoryTriggerResource> lro = await dataFactoryTrigger.UpdateAsync(WaitUntil.Completed, data);
DataFactoryTriggerResource result = lro.Value;

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

Beispiel für eine Antwort

Statuscode:: 200

Date: Sat, 16 Jun 2018 00:40:15 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1185
x-ms-request-id: d5ccf096-0618-4b26-9829-db77e4c391c7
x-ms-correlation-request-id: d5ccf096-0618-4b26-9829-db77e4c391c7

{
  "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": "2018-06-16T00:39:14.905167Z",
        "endTime": "2018-06-16T00:55:14.905167Z",
        "timeZone": "UTC"
      }
    },
    "pipelines": [
      {
        "pipelineReference": {
          "referenceName": "examplePipeline",
          "type": "PipelineReference"
        },
        "parameters": {
          "OutputBlobNameList": [
            "exampleoutput.csv"
          ]
        }
      }
    ],
    "description": "Example description",
    "runtimeState": "Stopped"
  },
  "etag": "0a008dd4-0000-0000-0000-5b245c6f0000"
}

Definitionen

Name	Beschreibung
CloudError	Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert.
MultiplePipelineTrigger	Basisklasse für alle Trigger, die ein bis viele Modell für trigger to pipeline unterstützen.
PipelineReference	Pipelineverweistyp.
TriggerPipelineReference	Pipeline, die mit den angegebenen Parametern ausgelöst werden muss.
TriggerResource	Ressourcentyp auslösen.
TriggerRuntimeState	Listet den möglichen Zustand von Triggern auf.

CloudError

Objekt

Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert.

Name	Typ	Beschreibung
error.code	string	Fehlercode.
error.details	CloudError[]	Array mit zusätzlichen Fehlerdetails.
error.message	string	Fehlermeldung.
error.target	string	Eigenschaftsname/Pfad in Anforderung, die fehler zugeordnet ist.

MultiplePipelineTrigger

Objekt

Basisklasse für alle Trigger, die ein bis viele Modell für trigger to pipeline unterstützen.

Name	Typ	Beschreibung
annotations	object[]	Liste der Tags, die zum Beschreiben des Triggers verwendet werden können.
description	string	Triggerbeschreibung.
pipelines	TriggerPipelineReference[]	Pipelines, die gestartet werden müssen.
runtimeState	TriggerRuntimeState	Gibt an, ob trigger ausgeführt wird oder nicht. Aktualisiert, wenn Start-/Stopp-APIs für den Trigger aufgerufen werden.
type	string: MultiplePipelineTrigger	Triggertyp.

PipelineReference

Objekt

Pipelineverweistyp.

Name	Typ	Beschreibung
name	string	Verweisname.
referenceName	string	Referenzpipelinename.
type	enum: PipelineReference	Pipelineverweistyp.

TriggerPipelineReference

Objekt

Pipeline, die mit den angegebenen Parametern ausgelöst werden muss.

Name	Typ	Beschreibung
parameters	object	Pipelineparameter.
pipelineReference	PipelineReference	Pipelineverweis.

TriggerResource

Objekt

Ressourcentyp auslösen.

Name	Typ	Beschreibung
etag	string	Etag identifiziert Änderungen in der Ressource.
id	string	Der Ressourcenbezeichner.
name	string	Der Ressourcenname.
properties	Trigger: MultiplePipelineTrigger	Eigenschaften des Triggers.
type	string	Der Ressourcentyp.

TriggerRuntimeState

Enumeration

Listet den möglichen Zustand von Triggern auf.

Wert	Beschreibung
Started
Stopped
Disabled

Freigeben über

Triggers - Create Or Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Triggers_Create

Beispielanforderung

Beispiel für eine Antwort

Triggers_Update

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

MultiplePipelineTrigger

PipelineReference

TriggerPipelineReference

TriggerResource

TriggerRuntimeState