Triggers - Create Or Update
Skapar eller uppdaterar en utlösare.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}?api-version=2018-06-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
factory
|
path | True |
string |
Fabriksnamnet. Reguljärt uttrycksmönster: |
resource
|
path | True |
string |
Resursgruppens namn. Reguljärt uttrycksmönster: |
subscription
|
path | True |
string |
Prenumerationsidentifieraren. |
trigger
|
path | True |
string |
Utlösarnamnet. Reguljärt uttrycksmönster: |
api-version
|
query | True |
string |
API-versionen. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
If-Match |
string |
ETag för utlösarentiteten. Bör endast anges för uppdatering, för vilken den ska matcha en befintlig entitet eller kan vara * för ovillkorlig uppdatering. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
properties | True | Trigger: |
Egenskaper för utlösaren. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Ett felsvar som tagits emot från Azure Data Factory-tjänsten. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Triggers_Create |
Triggers_Update |
Triggers_Create
Exempelbegäran
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"
]
}
}
]
}
}
Exempelsvar
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
Exempelbegäran
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"
}
}
Exempelsvar
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"
}
Definitioner
Name | Description |
---|---|
Cloud |
Objektet som definierar strukturen för ett Azure Data Factory felsvar. |
Multiple |
Basklass för alla utlösare som stöder en till många-modell för utlösare till pipeline. |
Pipeline |
Referenstyp för pipeline. |
Trigger |
Pipeline som måste utlösas med de angivna parametrarna. |
Trigger |
Utlösa resurstyp. |
Trigger |
Räknar upp möjliga tillstånd för utlösare. |
CloudError
Objektet som definierar strukturen för ett Azure Data Factory felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Felkod. |
error.details |
Matris med ytterligare felinformation. |
|
error.message |
string |
Felmeddelande. |
error.target |
string |
Egenskapsnamn/sökväg i begäran som är associerad med fel. |
MultiplePipelineTrigger
Basklass för alla utlösare som stöder en till många-modell för utlösare till pipeline.
Name | Typ | Description |
---|---|---|
annotations |
object[] |
Lista över taggar som kan användas för att beskriva utlösaren. |
description |
string |
Utlösarbeskrivning. |
pipelines |
Pipelines som måste startas. |
|
runtimeState |
Anger om utlösaren körs eller inte. Uppdaterades när Start/Stop-API:er anropas på utlösaren. |
|
type | string: |
Utlösartyp. |
PipelineReference
Referenstyp för pipeline.
Name | Typ | Description |
---|---|---|
name |
string |
Referensnamn. |
referenceName |
string |
Referenspipelinenamn. |
type | enum: |
Referenstyp för pipeline. |
TriggerPipelineReference
Pipeline som måste utlösas med de angivna parametrarna.
Name | Typ | Description |
---|---|---|
parameters |
object |
Pipelineparametrar. |
pipelineReference |
Pipelinereferens. |
TriggerResource
Utlösa resurstyp.
Name | Typ | Description |
---|---|---|
etag |
string |
Etag identifierar ändring i resursen. |
id |
string |
Resursidentifieraren. |
name |
string |
Resursnamnet. |
properties | Trigger: |
Egenskaper för utlösaren. |
type |
string |
Resurstypen. |
TriggerRuntimeState
Räknar upp möjliga tillstånd för utlösare.
Name | Typ | Description |
---|---|---|
Disabled |
string |
|
Started |
string |
|
Stopped |
string |