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 |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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 |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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" |
credential | No | - | No | ID of the credential that applies to this connection object. | "d42e1872-02c8-4a90-a714-44f15577389a" |
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 |
Code Block |
---|
| ||||
{
"type": "<Connector Type>",
"credential": "d42e1872-02c8-4a90-a714-44f15577389a",
"throttlePolicy": "",
"routingPolicies": ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"],
"description": "<Connector Name> Test Connector",
"properties": {
}
}
|
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" |
credential | No | - | No | ID of the credential that applies to this connection object. | "d42e1872-02c8-4a90-a714-44f15577389a" |
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 |
Code Block | ||||
---|---|---|---|---|
|
Code Block | ||||
---|---|---|---|---|
| ||||
#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 "credential": "<Connector Name> Test Connectord42e1872-02c8-4a90-a714-44f15577389a", "propertiesthrottlePolicy": {"", "routingPolicies": ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"], "filterOptionsdescription": "FROM_TO<Connector Name> Test Connector", "properties": { "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 | Id of the connection to update | "89d6632a-a296-426c-adb0-d442adcab4b0", | <seed description> | ||||
type | Yes | - | No | The value must be azure-events-hub. | azure-events-hub | |||||
description | Yes | description | No | - | No | Name of the connection seed object. | "MyConnectionMy Azure Events Hub Seed" | |||
throttlePolicyconnector | NoYes | - | No | Id The id of the throttle policy that applies to this connection objectconnector to be used with this seed. The connector type must match the seed type. | "f5587cee82f7f0a4-91168d28-401147ce-b3a98c9d-6b235b333a1be3ca414b0d31" | |||||
routingPoliciesconnection | NoYes | [ ]- | YesNo | The ids id 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 | |||||
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 | |||||
filterOptions | Yes | "TIME_RANGE" | No | Filter options ("TIME_RANGE", "ALL_TIME", "FROM_TO") | "TIME_RANGE" | |||||
timeRangeOption | No | 1 | toEndDate | No | - | No | Only required when filter option "FROMTIME_TORANGE" is selected. Ending point for the publication of the events | 03-02-2018 12:12:12 |
Code Block | ||
---|---|---|
| ||
{
"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"
}
} |
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 |
Code Block | ||||
---|---|---|---|---|
| ||||
#TIME_RANGE
{
"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",
"filterOptions": "TIME_RANGE",
"timeRangeOption": 6
}
}
#ALL_TIME
{
"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",
"filterOptions": "ALL_TIME",
"readUp": 0
}
}
#FROM_TO
{
"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",
"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 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 |
For the creation of the Connector object using the Rest API check this page
For the update of the Connector object using the Rest API check this page
Field
Required
Default
Multiple
Notes
Example
The value must be azure-events-hub.
azure-events-hub
"My Azure Events Hub Seed"
Code Block | ||||
---|---|---|---|---|
| ||||
{
"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"
}
} |
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 crawledroutingPolicies to remove. | ["f8c414cb313de87c-1f5d3cb9-42ef4fe0-9cc9a2cb-5696c3f0bda417f75ce7d0c7"] | |||||||||||
workflows.addtags | No | [ ] | Yes | The ids tags of the workflows to add.seed. These can be used to filter the seed | ["tag1", "tag3["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] | |||||||||||
workflowstags.removeadd | No | [ ] | Yes | The ids of the workflows to remove.tags to add | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4tag4"] | |||||||||||
throttlePolicytags.remove | 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"] | |||||||||||
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 | |||||||||||
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 | properties | Yes | - | No | Configuration object | seed | Yes | - | No | This value must be azure_events_hub_seed | azure_events_hub_seed |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "idtype": "2f287669-d163-4e35-ad17-6bbfe9df3778"<Connector Type>", "seed": "<seed example>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-d42780003b36"], "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "connectiontags": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",["tag1", "tag2"], "workflowsproperties": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], { "seed": "azure_events_hub_seed", "tagsfilterOptions": ["tagFROM_TO", "tag2"], "propertiesfromStartDate": {"02-02-2018 12:12:12", "seedtoEndDate": "azure_events_hub_seed04-02-2018 12:12:12" } } |