Triggers - Create Or Update

Создает или обновляет триггер.

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

Параметры URI

Имя В Обязательно Тип Описание
factoryName
path True

string

Имя фабрики.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

Имя группы ресурсов.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Идентификатор подписки.

triggerName
path True

string

Имя триггера.

Regex pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$

api-version
query True

string

Версия API.

Заголовок запроса

Имя Обязательно Тип Описание
If-Match

string

ETag сущности триггера. Должен указываться только для обновления, для которого он должен соответствовать существующей сущности или может иметь значение * для безусловного обновления.

Текст запроса

Имя Обязательно Тип Описание
properties True Trigger:

MultiplePipelineTrigger

Свойства триггера.

Ответы

Имя Тип Описание
200 OK

TriggerResource

Все в порядке.

Other Status Codes

CloudError

Ответ об ошибке, полученный от службы Фабрика данных Azure.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Triggers_Create
Triggers_Update

Triggers_Create

Sample Request

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"
          ]
        }
      }
    ]
  }
}

Sample Response

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

Sample Request

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"
  }
}

Sample Response

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"
}

Определения

Имя Описание
CloudError

Объект , определяющий структуру Фабрика данных Azure ответа на ошибку.

MultiplePipelineTrigger

Базовый класс для всех триггеров, поддерживающих модель "один ко многим" для конвейера триггера.

PipelineReference

Ссылочный тип конвейера.

TriggerPipelineReference

Конвейер, который должен быть активирован с заданными параметрами.

TriggerResource

Тип ресурса триггера.

TriggerRuntimeState

Перечисляет возможное состояние триггеров.

CloudError

Объект , определяющий структуру Фабрика данных Azure ответа на ошибку.

Имя Тип Описание
error.code

string

Код ошибки.

error.details

CloudError[]

Массив с дополнительными сведениями об ошибке.

error.message

string

Сообщение об ошибке.

error.target

string

Имя свойства или путь в запросе, связанном с ошибкой.

MultiplePipelineTrigger

Базовый класс для всех триггеров, поддерживающих модель "один ко многим" для конвейера триггера.

Имя Тип Описание
annotations

object[]

Список тегов, которые можно использовать для описания триггера.

description

string

Описание триггера.

pipelines

TriggerPipelineReference[]

Конвейеры, которые необходимо запустить.

runtimeState

TriggerRuntimeState

Указывает, запущен триггер или нет. Обновляется при вызове API запуска и остановки в триггере.

type string:

MultiplePipelineTrigger

Тип триггера.

PipelineReference

Ссылочный тип конвейера.

Имя Тип Описание
name

string

Имя ссылки.

referenceName

string

Имя ссылочного конвейера.

type enum:

PipelineReference

Ссылочный тип конвейера.

TriggerPipelineReference

Конвейер, который должен быть активирован с заданными параметрами.

Имя Тип Описание
parameters

object

Параметры конвейера.

pipelineReference

PipelineReference

Справочник по конвейеру.

TriggerResource

Тип ресурса триггера.

Имя Тип Описание
etag

string

Etag определяет изменения в ресурсе.

id

string

Идентификатор ресурса.

name

string

Имя ресурса.

properties Trigger:

MultiplePipelineTrigger

Свойства триггера.

type

string

Тип ресурса.

TriggerRuntimeState

Перечисляет возможное состояние триггеров.

Имя Тип Описание
Disabled

string

Started

string

Stopped

string