Triggers - Create Or Update
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 |
---|---|---|---|---|
factory
|
path | True |
string |
Der Factoryname. RegEx-Muster: |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. RegEx-Muster: |
subscription
|
path | True |
string |
Die Abonnement-ID. |
trigger
|
path | True |
string |
Der Triggername. RegEx-Muster: |
api-version
|
query | True |
string |
Die API-Version. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
If-Match |
string |
ETag der Triggerentität. Sollte nur für das Update angegeben werden, für das es mit einer vorhandenen Entität übereinstimmen sollte, oder kann * für bedingungslose Aktualisierung sein. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties | True | Trigger: |
Eigenschaften des Triggers. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Eine vom Azure Data Factory Dienst empfangene Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
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
Beispielanforderung
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"
]
}
}
]
}
}
Beispiel für eine Antwort
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
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"
}
}
Beispiel für eine Antwort
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 |
---|---|
Cloud |
Das -Objekt, das die Struktur einer Azure Data Factory Fehlerantwort definiert. |
Multiple |
Basisklasse für alle Trigger, die ein bis viele Modelle für Trigger zur Pipeline unterstützen. |
Pipeline |
Pipelineverweistyp. |
Trigger |
Pipeline, die mit den angegebenen Parametern ausgelöst werden muss. |
Trigger |
Ressourcentyp auslösen. |
Trigger |
Listet den möglichen Zustand von Triggern auf. |
CloudError
Das -Objekt, das die Struktur einer Azure Data Factory Fehlerantwort definiert.
Name | Typ | Beschreibung |
---|---|---|
error.code |
string |
Fehlercode |
error.details |
Array mit zusätzlichen Fehlerdetails. |
|
error.message |
string |
Fehlermeldung. |
error.target |
string |
Eigenschaftsname/Pfad in der Anforderung, die einem Fehler zugeordnet ist. |
MultiplePipelineTrigger
Basisklasse für alle Trigger, die ein bis viele Modelle für Trigger zur Pipeline unterstützen.
Name | Typ | Beschreibung |
---|---|---|
annotations |
object[] |
Liste der Tags, die zum Beschreiben des Triggers verwendet werden können. |
description |
string |
Triggerbeschreibung. |
pipelines |
Pipelines, die gestartet werden müssen. |
|
runtimeState |
Gibt an, ob der Trigger ausgeführt wird oder nicht. Aktualisiert, wenn Start/Stop-APIs auf dem Trigger aufgerufen werden. |
|
type | string: |
Der Triggertyp, |
PipelineReference
Pipelineverweistyp.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Verweisname. |
referenceName |
string |
Name der Referenzpipeline. |
type | enum: |
Pipelineverweistyp. |
TriggerPipelineReference
Pipeline, die mit den angegebenen Parametern ausgelöst werden muss.
Name | Typ | Beschreibung |
---|---|---|
parameters |
object |
Pipelineparameter |
pipelineReference |
Pipelineverweis. |
TriggerResource
Ressourcentyp auslösen.
Name | Typ | Beschreibung |
---|---|---|
etag |
string |
Etag identifiziert Änderungen in der Ressource. |
id |
string |
Der Ressourcenbezeichner. |
name |
string |
Der Name der Ressource. |
properties | Trigger: |
Eigenschaften des Triggers. |
type |
string |
Der Ressourcentyp. |
TriggerRuntimeState
Listet den möglichen Zustand von Triggern auf.
Name | Typ | Beschreibung |
---|---|---|
Disabled |
string |
|
Started |
string |
|
Stopped |
string |