Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be "onedrive". | "onedrive" |
description | Yes | - | No | Name of the credential object. | "One DriveCredential" |
properties | Yes | - | No | Configuration object | |
domain | Yes | - | No | Tenant domain | yourdomain.onmicrosoft.com |
appID | Yes | - | No | Azure application ID registered | sampleapplicationid |
appSecret | Yes | - | No | Azure application secret | xxxxxxxxxxxxxxxxxxxxxxxxxx |
graphURL | Yes | - | No | the graph url | https://graph.microsoft.com/v1.0 |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": "<Connector Type>", "description": "<Connector Name> Credential", "properties": { "domain": "yourdomain.onmicrosoft.com" "appID": "sampleapplicationid", "appSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxx", "graphURL": "https://graph.microsoft.com/v1.0" } } |
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. | "OneDriveCredential" |
properties | Yes | - | No | Configuration object | |
domain | Yes | - | No | Tenant domain | yourdomain.onmicrosoft.com |
appID | Yes | - | No | Azure application ID registered | sampleapplicationid |
appSecret | Yes | - | No | Azure application secret | xxxxxxxxxxxxxxxxxxxxxxxxxx |
graphURL | Yes | - | No | the graph url | https://graph.microsoft.com/v1.0 |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065", "description": "<Connector Name> Credential", "properties": { "domain": "yourdomain.onmicrosoft.com" "appID": "sampleapplicationid", "appSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxx", "graphURL": "https://graph.microsoft.com/v1.0" } } |
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be onedrive | onedrive |
description | Yes | - | No | Name of the connection object. | "MyOne DriveConnection" |
credential | Yes | - | No | ID of the credential that applies to this connection object. | "d42e1872-02c8-4a90-a714-44f15577389a" |
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 | |
indexContainers | No | TRUE | No | Select if containers are to be indexed. Clear to index files only. | TRUE |
scanRecursively | No | TRUE | No | Select if subfolders are to be scanned. | TRUE |
scanExcludedItems | No | FALSE | No | Select so that the scanner will scan sub items of container items excluded by a pattern | FALSE |
includes | No | - | Yes | List of regex URL patterns to include | [{"include":".*tmp[^/]$"}] |
include | No | - | No | regex URL patterns to include | ".*tmp[^/]$" |
excludes | No | - | Yes | List of regex URL patterns to exclude | [{"include":".*tmp[^/]$"}] |
exclude | No | - | No | regex URL patterns to exclude | ".*tmp[^/]$" |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": "<Connector Type>onedrive", "descriptioncredential": "<Connector Name> Test Connectord42e1872-02c8-4a90-a714-44f15577389a", "propertiesthrottlePolicy": { "indexContainers": true, "scanRecursivelyroutingPolicies": true, ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"], "scanExcludedItemsdescription": false, "<Connector Name> Test Connector", "includesproperties": [{ {"includeindexContainers": ".*tmp[^/]$"}true, ]"scanRecursively": true, "excludes"scanExcludedItems": false, "includes": [ {"excludeinclude": ".*tmp[^/]$"} ] } }, "excludes": [ {"exclude": ".*tmp[^/]$"} ] } } |
Field | Required |
---|
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. | "My Connection" |
credential | Yes | - | No | ID of the credential that applies to this connection object. | "d42e1872-02c8-4a90-a714-44f15577389a" |
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 | |
indexContainers | No | TRUE | No | Select if containers are to be indexed. Clear to index files only. | TRUE |
scanRecursively | No | TRUE | No | Select if subfolders are to be scanned. | TRUE |
scanExcludedItems | No | FALSE | No | Select so that the scanner will scan sub items of container items excluded by a pattern | FALSE |
includes | No | - | Yes | List of regex URL patterns to include | [{"include":".*tmp[^/]$"}] |
include | No | - | No | regex URL patterns to include | ".*tmp[^/]$" |
excludes | No | - | Yes | List of regex URL patterns to exclude | [{"include":".*tmp[^/]$"}] |
exclude | No | - | No | regex URL patterns to exclude | ".*tmp[^/]$" |
Code Block | ||
---|---|---|
| ||
{ "id": "89d6632a-a296-426c-adb0-d442adcab4b0", "descriptiontype": "<Connector Name> Test Connectoronedrive", "propertiescredential": { "indexContainers": true"d42e1872-02c8-4a90-a714-44f15577389a", "throttlePolicy": "", "scanRecursively": true"routingPolicies": ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"], "description": "<Connector Name> Test Connector", "scanExcludedItemsproperties": false, { "includesindexContainers": [ true, {"includescanRecursively": ".*tmp[^/]$"} true, "scanExcludedItems": ]false, "excludesincludes": [ {"excludeinclude": ".*tmp[^/]$"} ], "excludes": } }[ {"exclude": ".*tmp[^/]$"} ] } } |
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 one-drive. | onedrive |
description | Yes | - | No | Name of the seed object. | "My OneDrive 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 onedrive_seed | "onedrive_seed" |
usersType |
Yes |
"List" | No | The way to add the users to crawl ("List" or "File") | "List" | ||
users | No | - | Yes | Only required if usersType "List" is selected. List of users | [{"user": "user1"},{"user": "user2"}] |
user | No | - | No | Only required if usersType "List" is selected.User Principal Name | "[email protected]" |
usersFile | No | - | No | Only required if usersType "File" is selected. The path to the names list file | "config/userNames.txt" |
Code Block | ||||
---|---|---|---|---|
| ||||
# LIST
{
"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": "onedrive_seed",
"usersType": "List",
"users":[
{"user": "user1"},
{"user": "user2"}
]
}
}
# FILE
{
"type": "<Connector Type>",
"seed": "directory",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c- | RDark | |||
title | POST aspire/_api/seeds | { "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": { -5696c3f0bda4"], "tags": ["tag1", "tag2"], "properties": { "seed": "onedrive_seed", "usersType": "List", "seed": "onedrive_seed", "usersType": "File", "usersFile": "config/userNames.txt" } } |
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. | "MyOneDriveSeed" | |||||
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 of the seed. These can be used to filter the seedto remove | ["tag1tag2", "tag3"] | |||||
tags.add | No | [ ] | Yes | The tags to add | ["tag4"] | |||||
tags.remove | No | [ ] | Yes | The tags to remove | ["tag2"] | properties | Yes | - | No | Configuration object |
] | ||||||||||
properties | Yes | - | No | Configuration object | ||||||
seed | Yes | - | No | This value must be onedrive_seed | "onedrive_seed" | |||||
usersType | Yes | "List" | No | The way to add the users to crawl ("List" or "File") | "List" | |||||
users | No | - | Yes | Only required if usersType "List" is selected. List of users | [{"user": "user1"},{"user": "user2"}] | |||||
user | No | - | No | Only required if usersType "List" is selected.User Principal Name | "[email protected]" | |||||
usersFile | No | - | No | |||||||
seed | Yes | - | No | This value must be onedrive_seed | "onedrive_seed" | |||||
usersType | Yes | "List" | No | The way to add the users to crawl ("List" or "File") | "List" | |||||
users | No | - | Yes | Only required if usersType "ListFile" is selected. List of users | [{"user": "user1"},{"user": "user2"}] | user | No | - | No | Only required if usersType "List" is selected.User Principal Name"[email protected]" |
usersFile | No | - | No | Only required if usersType "File" is selected. The path to the names list file | "config/userNames.txt" |
The path to the names list file | "config/userNames.txt" |
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
"seed": "<seed example>",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed", | ||||
Code Block | ||||
| ||||
{ "idthrottlePolicy": "2f2876696b8b5f23-d163fc77-4e3547a1-ad179b58-6bbfe9df3778106577162e7b", "seedroutingPolicies": "<seed example>"["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"], "connectorconnection": "82f7f0a4602d3700-8d2828dd-47ce4a6a-8c9d8b51-e3ca414b0d31e4a663fe9ee6", "descriptionworkflows": "<connector>_Test_Seed", "throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b"["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "routingPoliciestags": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7tag", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36tag2"], "connectionproperties": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "tags": ["tag", "tag2"], "properties": { { "seed": "onedrive_seed", "usersType": "List", "users":[ {"user": "user1"}, {"user": "user2"} ] } } |