Triggers - Create Or Update

Hizmet:: Data Factory

API Sürümü:: 2018-06-01

Tetikleyici oluşturur veya güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Fabrika adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Kaynak grubu adı.
subscriptionId	path	True	string	Abonelik tanımlayıcısı.
triggerName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	Tetikleyici adı.
api-version	query	True	string	API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
If-Match		string	Tetikleyici varlığının ETag'i. Yalnızca mevcut varlıkla eşleşmesi gereken güncelleştirme için belirtilmelidir veya koşulsuz güncelleştirme için * olabilir.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties	True	Trigger: MultiplePipelineTrigger	Tetikleyicinin özellikleri.

Yanıtlar

Name	Tür	Description
200 OK	TriggerResource	TAMAM.
Other Status Codes	CloudError	Azure Data Factory hizmetinden alınan bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Örnek yanıt

Durum kodu:: 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

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
}

Tanımlar

Name	Description
CloudError	Azure Data Factory hata yanıtının yapısını tanımlayan nesne.
MultiplePipelineTrigger	İşlem hattına tetikleyici için bire çok modeli destekleyen tüm tetikleyiciler için temel sınıf.
PipelineReference	İşlem hattı başvuru türü.
TriggerPipelineReference	Verilen parametrelerle tetiklenmesi gereken işlem hattı.
TriggerResource	Tetikleyici kaynak türü.
TriggerRuntimeState	Tetikleyicilerin olası durumunu numaralandırır.

CloudError

Nesne

Azure Data Factory hata yanıtının yapısını tanımlayan nesne.

Name	Tür	Description
error.code	string	Hata kodu.
error.details	CloudError[]	Ek hata ayrıntıları içeren dizi.
error.message	string	Hata mesajı.
error.target	string	Hatayla ilişkili istekte özellik adı/yolu.

MultiplePipelineTrigger

Nesne

İşlem hattına tetikleyici için bire çok modeli destekleyen tüm tetikleyiciler için temel sınıf.

Name	Tür	Description
annotations	object[]	Tetikleyiciyi tanımlamak için kullanılabilecek etiketlerin listesi.
description	string	Tetikleyici açıklaması.
pipelines	TriggerPipelineReference[]	Başlatılması gereken işlem hatları.
runtimeState	TriggerRuntimeState	Tetikleyicinin çalışıp çalışmadığını gösterir. Tetikleyicide Başlat/Durdur API'leri çağrıldığında güncelleştirildi.
type	string: MultiplePipelineTrigger	Tetikleyici türü.

PipelineReference

Nesne

İşlem hattı başvuru türü.

Name	Tür	Description
name	string	Başvuru adı.
referenceName	string	Başvuru işlem hattı adı.
type	enum: PipelineReference	İşlem hattı başvuru türü.

TriggerPipelineReference

Nesne

Verilen parametrelerle tetiklenmesi gereken işlem hattı.

Name	Tür	Description
parameters	object	İşlem hattı parametreleri.
pipelineReference	PipelineReference	İşlem hattı başvurusu.

TriggerResource

Nesne

Tetikleyici kaynak türü.

Name	Tür	Description
etag	string	Etag, kaynaktaki değişikliği tanımlar.
id	string	Kaynak tanımlayıcısı.
name	string	Kaynak adı.
properties	Trigger: MultiplePipelineTrigger	Tetikleyicinin özellikleri.
type	string	Kaynak türü.

TriggerRuntimeState

Numaralandırma

Tetikleyicilerin olası durumunu numaralandırır.

Değer	Description
Started
Stopped
Disabled

Aracılığıyla paylaş

Triggers - Create Or Update

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

Triggers_Create

Örnek isteği

Örnek yanıt

Triggers_Update

Örnek isteği

Örnek yanıt

Tanımlar

CloudError

MultiplePipelineTrigger

PipelineReference

TriggerPipelineReference

TriggerResource

TriggerRuntimeState