REST API Reference

Back Next

Azure Event Hubs targets

When the target connection of the task target is Azure Event Hubs, you can include the following fields and key-value pairs in the config array of the target connection:

Key	Type	Required	Description
sasPolicyName	String	-	The name of the Event Hub Namespace Shared Access Policy. You can enter a string of up to 255 characters.
sasPolicyPrimaryKey	String	-	The primary key of the Event Hub Namespace Shared Access Policy. You can enter a string of up to 255 characters.
Event Hub	String	Yes	The name of the Azure Event Hubs. You can enter a string up to 255 characters. The name can contain lower case characters, upper case characters, numbers, and the special characters - and _.

POST request example

To update a

streaming ingestion and replication

task with a flat file source and an Azure Event Hubs target, you might send a request similar to the following example:

POST <serverUrl>/sisvc/restapi/v1/UpdateEntity/Documents('<document ID>')
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>

{
  "name": "flatfile to azure event hub",
  "description": "flatfile to azure event hub",
  "runtimeId": "01000025000000000003",
  "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
  "currentVersion": "2",
  "messageFormat": "binary",
  "nodes": [
    {
      "name": "flatfile to azure event hub_source",
      "type": "source",
      "connectionId": "012MGS0B00000000002N",
      "transformationType": "",
      "config": [
        {
          "key": "File",
          "value": "logfile"
        },
        {
          "key": "initialPosition",
          "value": "Current Time"
        },
        {
          "key": "rolloverPattern",
          "value": "test"
        },
        {
          "key": "tailingMode",
          "value": "Single file"
        }
      ]
    },
    {
      "name": "flatfile to azure event hub_target",
      "type": "target",
      "connectionId": "012MGS0B00000000001S",
      "transformationType": "",
      "config": [
        {
          "key": "sasPolicyName",
          "value": "test"
        },
        {
          "key": "sasPolicyPrimaryKey",
          "value": "test"
        },
        {
          "key": "Event Hub",
          "value": "test"
        }
      ]
    }
  ],
  "edges": [
    {
      "from": "flatfile to azure event hub_source",
      "to": "flatfile to azure event hub_target"
    }
  ]
}

The response returns only the fields that you entered in the request. If the request is unsuccessful, the response includes a reason for the failure.

POST response example

If the request is successful, you might receive a response similar to the following example in a

Success

node:

{
  "Success": {
    "name": "flatfile to azure event hub",
    "description": "flatfile to azure event hub",
    "runtimeId": "01000025000000000003",
    "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
    "currentVersion": "2",
    "messageFormat": "binary",
    "nodes": [
      {
        "name": "flatfile to azure event hub_source",
        "type": "source",
        "connectionId": "012MGS0B00000000002N",
        "transformationType": "",
        "config": [
          {
            "key": "File",
            "value": "logfile"
          },
          {
            "key": "initialPosition",
            "value": "Current Time"
          },
          {
            "key": "rolloverPattern",
            "value": "test"
          },
          {
            "key": "tailingMode",
            "value": "Single file"
          }
        ]
      },
      {
        "name": "flatfile to azure event hub_target",
        "type": "target",
        "connectionId": "012MGS0B00000000001S",
        "transformationType": "",
        "config": [
          {
            "key": "sasPolicyName",
            "value": "test"
          },
          {
            "key": "sasPolicyPrimaryKey",
            "value": "test"
          },
          {
            "key": "Event Hub",
            "value": "test"
          }
        ]
      }
    ],
    "edges": [
      {
        "from": "flatfile to azure event hub_source",
        "to": "flatfile to azure event hub_target"
      }
    ]
  }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Azure Event Hubs targets

Azure Event Hubs targets

POST request example

POST response example