Действие веб-перехватчика в Фабрике данных Azure

ОБЛАСТЬ ПРИМЕНЕНИЯ: Фабрика данных Azure Azure Synapse Analytics

Действие веб-перехватчика может контролировать выполнение конвейеров с помощью пользовательского кода. С помощью действия веб-перехватчика код может вызвать конечную точку и передать ей URL-адрес обратного вызова. Выполнение конвейера ожидает обратный вызов перед переходом к следующему действию.

Создание действия Webhook с помощью пользовательского интерфейса

Чтобы использовать действие Webhook в конвейере, выполните следующие действия:

1. Выполните поиск Webhook в области конвейера "Действия" и перетащите действие Webhook на холст конвейера.

2. Выберите новое действие веб-перехватчика на холсте, если оно еще не выбрано и вкладка "Параметры " для изменения сведений.

   

3. Укажите URL-адрес веб-перехватчика, который может быть литеральной строкой URL-адреса или любым сочетанием динамических выражений, функций, системных переменных или выходных данных других действий. Укажите другие сведения для отправки в запрос.

4. Используйте выходные данные действия в качестве входных данных для любого другого действия. Укажите ссылку на выходные данные в любом месте целевого действия, где поддерживается динамическое содержимое.

Синтаксис

{
    "name": "MyWebHookActivity",
    "type": "WebHook",
    "typeProperties": {
        "method": "POST",
        "url": "<URLEndpoint>",
        "headers": {
            "Content-Type": "application/json"
        },
        "body": {
            "key": "value"
        },
        "timeout": "00:10:00",
        "reportStatusOnCallBack": false,
        "authentication": {
            "type": "ClientCertificate",
            "pfx": "****",
            "password": "****"
        }
    }
}

Свойства типа

Проверка подлинности

Действие веб-перехватчика поддерживает следующие типы проверки подлинности.

нет

Если проверка подлинности не требуется, не включайте свойство authentication.

Базовая

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

"authentication":{
   "type":"Basic",
   "username":"****",
   "password":"****"
}

Сертификат клиента

Укажите содержимое в кодировке Base64 PFX-файла и пароль.

"authentication":{
   "type":"ClientCertificate",
   "pfx":"****",
   "password":"****"
}

Управляемое удостоверение

Укажите URI ресурса, для которого будет запрошен маркер доступа, с помощью управляемого удостоверения для Фабрики данных или экземпляра рабочей области Synapse. Для вызова API управления ресурсами Azure используйте https://management.azure.com/. Дополнительные сведения об управляемых удостоверениях для ресурсов Azure см. в статье Что такое управляемые удостоверения для ресурсов Azure?

"authentication": {
    "type": "MSI",
    "resource": "https://management.azure.com/"
}

Дополнительные примечания

Служба передает дополнительное свойство callBackUri в тексте, отправляемом конечной точке URL-адреса. Служба ждет, что этот код URI будет вызываться, до истечения указанного значения времени ожидания. Если URI не вызывается, действие завершается с состоянием TimedOut.

Действие веб-перехватчика завершается ошибкой при сбое вызова пользовательской конечной точки. Любое сообщение об ошибке можно добавить в текст обратного вызова и использовать в последующем действии.

При каждом вызове REST API время ожидания клиента истекает, если конечная точка не отвечает в течение одной минуты. Такое поведение является стандартной рекомендацией для протокола HTTP. Чтобы устранить эту проблему, реализуйте шаблон 202. В текущем случае конечная точка возвращает 202 (принято) и клиентские опросы.

Время ожидания, равное 1 минуте, для запроса не имеет ничего общего со временем ожидания для действия. Последнее используется для ожидания обратного вызова, заданного параметром callbackUri.

Текст, переданный обратно в URI обратного вызова, должен быть допустимым в формате JSON. В качестве заголовка Content-Type установите application/json.

При использовании свойства Отчета о состоянии при обратном вызове необходимо добавить следующий код в тело при выполнении обратного вызова:

{
    "Output": {
        // output object is used in activity output
        "testProp": "testPropValue"
    },
    "Error": {
        // Optional, set it when you want to fail the activity
        "ErrorCode": "testErrorCode",
        "Message": "error message to show in activity error"
    },
    "StatusCode": "403" // when status code is >=400, activity is marked as failed
}

Связанный контент

Поддерживаются следующие действия потока управления:

• Действие условия If
• Действие выполнения конвейера
• Действие ForEach
• Действие получения метаданных
• Действие поиска
• Веб-действие
• Действие Until