Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be "azure-blob". | "azure-blob" |
description | Yes | - | No | Name of the credential object. | "Azure Blob StorageCredential" |
properties | Yes | - | No | Configuration object | |
storageConnectionString | Yes | - | No | Azure Storage Connection String | "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;" |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": "<Connector Type>", "description": "<Connector Name> Credential", "properties": { "storageConnectionString": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;" } } |
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 Blob StorageCredential" |
properties | Yes | - | No | Configuration object | |
storageConnectionString | Yes | - | No | Azure Storage Connection String | "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;" |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065", "description": "<Connector Name> Credential", "properties": { "storageConnectionString": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;" } } |
Field | Required | Default | Multiple | Notes | Example | |||
---|---|---|---|---|---|---|---|---|
type | Yes | - | No | The value must be azure-blob | azure-blob | |||
description | Yes | - | No | Name of the connection object. | "MyAzure Blob StorageConnection" | |||
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 | ||||
sourceTypescanRecursively | YesNo | "useRootURL"TRUE | No | Source type ("useRootURL", "useSeedsFile") | "useRootURL" | Select if subfolders are to be scanned. | TRUE | |
scanExcludedItems | urlNo | -FALSE | No | Only required when sourceType "useRootURL" is selected. Azure Blob Container URL which will serve as the start of the crawl. | http://hostname/tennant/blobContainer | |||
useExtraBlobContainers | No | false | No | Add More Azure Blob Containers | false | |||
siteCollectionsToCrawl | No | - | Yes | Only required when "useExtraBlobContainers" is enabled. List of Azure Blob Container to crawl | [{"siteCollectionUrl": "http://hostname/tennant/blobContainer1"},{"siteCollectionUrl": "http://hostname/tennant/blobContainer2"}] | |||
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 | siteCollectionUrlNo | - | No | Azure Blob Container to crawl | "http://hostname/tennant/blobContainer1" | regex URL patterns to include | ".*tmp[^/]$" | |
excludes | seedsFilePathNo | - | No | Only required if sourceType "useSeedsFile" is selected. Seeds File path. | "/path/to/file" | |||
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[^/]$" |
Yes | List of regex URL patterns to exclude | [{"include":".*tmp[^/]$"}] | |||
exclude | No | - | No | regex URL patterns to exclude | ".*tmp[^/]$" |
Code Block | ||||
---|---|---|---|---|
| ||||
{
"type": "<Connector Type>",
"description": "<Connector Name> Test Connector", | ||||
Code Block | ||||
| ||||
{ "typeproperties": "<Connector Type>", "description": "<Connector Name> Test Connector", { "propertiesscanRecursively": {true, "sourceTypescanExcludedItems": "useRootURL"false, "urlincludes": "http://hostname/tennant/blobContainer", [ "seedsFilePath": "", { "useExtraBlobContainers": true, "siteCollectionsToCrawlinclude": ".*tmp[^/]$" {} ], "siteCollectionUrlexcludes": "http://hostname/tennant/blobContainer1"[ },{ { "exclude": ".*tmp[^/]$" "siteCollectionUrl": "http://hostname/tennant/blobContainer2" } } ], "scanRecursively": true, "scanExcludedItems": false, "includes": [ { "include": ".*tmp[^/]$" } ], "excludes": [ { "exclude": } } |
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 | |
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": " |
Field
Required
Default
Multiple
Notes
Example
89d6632a-a296-426c-adb0-d442adcab4b0", |
"MyConnection"
"description": "<Connector Name> Test Connector",
"properties": {
"scanRecursively": true,
"scanExcludedItems": false,
"includes": [
{
"include": ".*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 azure-blob. | azure-blob |
description | Yes | - | No | Name of the seed object. | "My Azure Blob Storage 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_blob_seed | azure_blob_seed |
sourceType | Yes | "useRootURL" | No | Source type ("useRootURL", "useSeedsFile") | "useRootURL" |
url | No | - | No | Only required when sourceType "useRootURL" is selected. Azure Blob Container URL which will serve as the start of the crawl. | http://hostname/tennant/blobContainer |
useExtraBlobContainers | No | false | No | Add More Azure Blob Containers | false |
siteCollectionsToCrawl | No | - | Yes | Only required when "useExtraBlobContainers" is enabled. List of Azure Blob Container to crawl | [{"siteCollectionUrl": "http://hostname/tennant/blobContainer1"},{"siteCollectionUrl": "http://hostname/tennant/blobContainer2"}] |
siteCollectionUrl | No | - | No | Azure Blob Container to crawl | "http://hostname/tennant/blobContainer1" |
seedsFilePath | No | - | No | Only required if sourceType "useSeedsFile" is selected. Seeds File path. | "/path/to/file" |
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": { |
Code Block | ||
---|---|---|
| ||
{ "id": "89d6632a-a296-426c-adb0-d442adcab4b0", "description": "<Connector Name> Test Connector", "properties": { "sourceType": "useRootURL", "url": "http://hostname/tennant/blobContainer", "seedsFilePath": "", "useExtraBlobContainers": true, "siteCollectionsToCrawl": [ { "siteCollectionUrl": "http://hostname/tennant/blobContainer1" }, { "siteCollectionUrl": "http://hostname/tennant/blobContainer2" } ], "scanRecursively": true, "scanExcludedItems": false, "includes": [ { "include": ".*tmp[^/]$" } ], "excludesseed": ["azure_blob_seed", "sourceType": "useRootURL", "url": { "http://hostname/tennant/blobContainer", "seedsFilePath": "", "excludeuseExtraBlobContainers": ".*tmp[^/]$"true, "siteCollectionsToCrawl": [ } { ] } } |
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
"siteCollectionUrl": "http://hostname/tennant/blobContainer1"
},
{
"siteCollectionUrl": "http://hostname/tennant/blobContainer2"
}
]
}
} |
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
id |
Field
Required
Default
Multiple
Notes
Example
The value must be azure-blob.
azure-blob
"My Azure Blob Storage Seed"
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 Blob StorageSeed" | ||||
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 |
theme | RDark |
---|---|
title | POST aspire/_api/seeds |
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- |
Field
Required
Default
Multiple
Notes
Example
"MyAzure Blob StorageSeed"
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_blob_seed | azure_blob_seed |
sourceType | Yes | "useRootURL" | No | Source type ("useRootURL", "useSeedsFile") | "useRootURL" |
url | No | - | No | Only required when sourceType "useRootURL" is selected. Azure Blob Container URL which will serve as the start of the crawl. | http://hostname/tennant/blobContainer |
useExtraBlobContainers | No | false | No | Add More Azure Blob Containers | false |
siteCollectionsToCrawl | No | - | Yes | Only required when "useExtraBlobContainers" is enabled. List of Azure Blob Container to crawl | [{"siteCollectionUrl": "http://hostname/tennant/blobContainer1"},{"siteCollectionUrl": "http://hostname/tennant/blobContainer2"}] |
siteCollectionUrl | No | - | No | Azure Blob Container to crawl | "http://hostname/tennant/blobContainer1" |
seedsFilePath | No | - | No | Only required if sourceType "useSeedsFile" is selected. Seeds File path. | "/path/to/file" |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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"] |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "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_blob_seed" , "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "tags": ["tag", "tag2"], "properties": { "seed": "azure_blob_seed", "sourceType": "useRootURL", "url": "http://hostname/tennant/blobContainer", "seedsFilePath": "", "useExtraBlobContainers": true, "siteCollectionsToCrawl": [ { "siteCollectionUrl": "http://hostname/tennant/blobContainer1" }, { "siteCollectionUrl": "http://hostname/tennant/blobContainer2" } ] } } |