Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be "azure-events-hub". | "azure-events-hub" |
description | Yes | - | No | Name of the credential object. | "Azure Events HubCredential" |
properties | Yes | - | No | Configuration object | |
namespace | Yes | - | No | Namespace as created in Azure portal | namespacesample |
eventHubName | Yes | - | No | Name of the Event Hub | eventhubnamesample |
sasKeyName | Yes | - | No | Name of the Shared Access Signature token | saskeynamesample |
sasKey | Yes | - | No | Value of the Shared Access Signature token | saskeyvaluesample |
{ "type": "<Connector Type>", "description": "<Connector Name> Credential", "properties": { "namespace": "namespacesample", "eventHubName": "namespacesample", "sasKeyName": "namespacesample", "sasKey": "namespacesample" } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | Yes | - | No | Id of the credential to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
description | Yes | - | No | Name of the credential object. | "Azure Events HubCredential" |
properties | Yes | - | No | Configuration object | |
namespace | Yes | - | No | Namespace as created in Azure portal | namespacesample |
eventHubName | Yes | - | No | Name of the Event Hub | eventhubnamesample |
sasKeyName | Yes | - | No | Name of the Shared Access Signature token | saskeynamesample |
sasKey | Yes | - | No | Value of the Shared Access Signature token | saskeyvaluesample |
{ "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065", "description": "<Connector Name> Credential", "properties": { "namespace": "namespacesample", "eventHubName": "namespacesample", "sasKeyName": "namespacesample", "sasKey": "namespacesample" } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be azure-events-hub | azure-events-hub |
description | Yes | - | No | Name of the connection object. | "MyAzure Events HubConnection" |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
properties | Yes | - | No | Configuration object | |
filterOptions | Yes | "TIME_RANGE" | No | Filter options ("TIME_RANGE", "ALL_TIME", "FROM_TO") | "TIME_RANGE" |
timeRangeOption | No | 1 | No | Only required when filter option "TIME_RANGE" is selected. The starting date/time to consumer events to now | 1 |
readUp | No | 0 | No | Only required when filter option "ALL_TIME" is selected. Use this option to crawl all the events in the hub | 0 |
fromStartDate | No | - | No | Only required when filter option "FROM_TO" is selected. Starting point for the publication of the events | 02-02-2018 12:12:12 |
toEndDate | No | - | No | Only required when filter option "FROM_TO" is selected. Ending point for the publication of the events | 03-02-2018 12:12:12 |
#TIME_RANGE { "type": "<Connector Type>", "description": "<Connector Name> Test Connector", "properties": { "filterOptions": "TIME_RANGE", "timeRangeOption": 6 } } #ALL_TIME { "type": "<Connector Type>", "description": "<Connector Name> Test Connector", "properties": { "filterOptions": "ALL_TIME", "readUp": 0 } } #FROM_TO { "type": "<Connector Type>", "description": "<Connector Name> Test Connector", "properties": { "filterOptions": "FROM_TO", "fromStartDate": "02-02-2018 12:12:12", "toEndDate": "03-02-2018 12:12:12" } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | Yes | - | No | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", |
description | No | - | No | Name of the connection object. | "MyConnection" |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
properties | Yes | - | No | Configuration object | |
filterOptions | Yes | "TIME_RANGE" | No | Filter options ("TIME_RANGE", "ALL_TIME", "FROM_TO") | "TIME_RANGE" |
timeRangeOption | No | 1 | No | Only required when filter option "TIME_RANGE" is selected. The starting date/time to consumer events to now | 1 |
readUp | No | 0 | No | Only required when filter option "ALL_TIME" is selected. Use this option to crawl all the events in the hub | 0 |
fromStartDate | No | - | No | Only required when filter option "FROM_TO" is selected. Starting point for the publication of the events | 02-02-2018 12:12:12 |
toEndDate | No | - | No | Only required when filter option "FROM_TO" is selected. Ending point for the publication of the events | 03-02-2018 12:12:12 |
{ "id": "89d6632a-a296-426c-adb0-d442adcab4b0", "description": "<Connector Name> Test Connector", "properties": { "filterOptions": "FROM_TO", "fromStartDate": "02-02-2018 12:12:12", "toEndDate": "03-02-2018 12:12:12" } }
For the creation of the Connector object using the Rest API check this page
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
seed | Yes | - | No | <seed description> | |
type | Yes | - | No | The value must be azure-events-hub. | azure-events-hub |
description | Yes | - | No | Name of the seed object. | "My Azure Events Hub Seed" |
connector | Yes | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
connection | Yes | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
workflows | No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
properties | Yes | - | No | Configuration object | |
seed | Yes | - | No | This value must be azure_events_hub_seed | azure_events_hub_seed |
{ "type": "<Connector Type>", "seed": "directory", "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31", "description": "<connector>_Test_Seed", "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b", "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"], "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "tags": ["tag1", "tag2"], "properties": { "seed": "azure_events_hub_seed" } }
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id | Yes | - | No | Id of the seed to update. | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
seed | No | - | No | <seed description> | |
description | No | - | No | Name of the seed object. | "MyAzure Events HubSeed" |
connector | No | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
connection | No | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
workflows | No | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
workflows.add | No | [ ] | Yes | The ids of the workflows to add. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
workflows.remove | No | [ ] | Yes | The ids of the workflows to remove. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
throttlePolicy | No | - | No | Id of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The ids of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
routingPolicies.add | No | [ ] | Yes | The ids of the routingPolicies to add. | ["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
routingPolicies.remove | No | [ ] | Yes | The ids of the routingPolicies to remove. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"] |
tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag3"] |
tags.add | No | [ ] | Yes | The tags to add | ["tag4"] |
tags.remove | No | [ ] | Yes | The tags to remove | ["tag2"] |
properties | Yes | - | No | Configuration object | |
seed | Yes | - | No | This value must be azure_events_hub_seed | azure_events_hub_seed |
{ "id": "2f287669-d163-4e35-ad17-6bbfe9df3778", "seed": "<seed example>", "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31", "description": "<connector>_Test_Seed", "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b", "routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"], "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "tags": ["tag", "tag2"], "properties": { "seed": "azure_events_hub_seed" } }