The Azure File Storage Connector can be configured using the Rest API. It requires the following entities to be created:

Credential
Connection
Connector
Seed

Below are the examples of how to create the Connection and the Seed. For the Connector please check this page.

Easy Heading Free

navigationTitle	On this Page
wrapNavigationText	true
navigationExpandOption	expand-all-by-default

Create Credential

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be "azure-file-storage".	"azure-file-storage"
description	Yes	-	No	Name of the credential object.	"Azure File StorageCredential"
properties	Yes	-	No	Configuration object
storageConnectionString	Yes	-	No	Azure Storage Connection String	"DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;"

Example

Code Block

theme	RDark
title	POST aspire/_api/credentials

{
    "type": "<Connector Type>",
    "description": "<Connector Name> Credential",
    "properties": {   
		"storageConnectionString": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;"     
	}
}

Update Credential

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 File StorageCredential"
properties	Yes	-	No	Configuration object
storageConnectionString	Yes	-	No	Azure Storage Connection String	"DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;"

Example

Code Block

theme	RDark
title	PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065

{
    "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "description": "<Connector Name> Credential",
    "properties": {    
		"storageConnectionString": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;"           
	}
}

Create Connection

Field	Required	Default	Multiple	Notes	Example
type	Yes	-	No	The value must be azure-file-storage	azure-file-storage
description	Yes	-	No	Name of the connection object.	"MyAzure File 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
sourceType	Yes	"useRootURL"	No	Source type ("useRootURL", "useSeedsFile")	"useRootURL"
url	No	-	No	Only required when sourceType "useRootURL" is selected. Azure File Share URL which will serve as the start of the crawl.	http://hostname/tennant/fileShare
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/fileShare1"},{"siteCollectionUrl": "http://hostname/tennant/fileShare2"}]
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"
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[^/]$"

Example

Code Block

theme	RDark
title	POST aspire/_api/connections

{
    "type": "<Connector Type>",
    "description": "<Connector Name> Test Connector",
    "properties": {           
		"sourceType": "useRootURL",
        "urlscanRecursively": "http://hostname/tennant/fileShare"true,
        "seedsFilePathscanExcludedItems": ""false,
        "useExtraBlobContainersincludes": true,[
           "siteCollectionsToCrawl": [{
             {
   "include": ".*tmp[^/]$"
            "siteCollectionUrl": "http://hostname/tennant/blobContainer1"
}
        ],
         },"excludes": [
            {
                "siteCollectionUrlexclude": "http://hostname/tennant/blobContainer2.*tmp[^/]$"
            }
        ],
        "scanRecursively": true,
        "scanExcludedItems": false,
        "includes": [
            {
                "include": ".*tmp[^/]$"
            }
        ],
        "excludes": [
            {
                "exclude": ".*tmp[^/]$"
            }
        ]      
	}
}

Update Connection

Field

Required

Default

Multiple

Notes

Example

idYes-NoId of the connection to update"89d6632a-a296-426c-adb0-d442adcab4b0",descriptionNo-NoName of the connection object.

"MyImage RemovedConnection"

throttlePolicyNo-NoId of the throttle policy that applies to this connection object."f5587cee-9116-4011-b3a9-6b235b333a1b"routingPoliciesNo[ ]YesThe ids of the routing policies that this connection will use.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]propertiesYes-NoConfiguration objectsourceTypeYes"useRootURL"NoSource type ("useRootURL", "useSeedsFile")"useRootURL"urlNo-NoOnly required when sourceType "useRootURL" is selected. Azure File Share URL which will serve as the start of the crawl. http://hostname/tennant/fileShareuseExtraBlobContainersNofalseNoAdd More Azure Blob ContainersfalsesiteCollectionsToCrawlNo-YesOnly required when "useExtraBlobContainers" is enabled. List of Azure Blob Container to crawl[{"siteCollectionUrl": "http://hostname/tennant/fileShare1"},{"siteCollectionUrl": "http://hostname/tennant/fileShare2"}]siteCollectionUrlNo-NoAzure Blob Container to crawl"http://hostname/tennant/blobContainer1"seedsFilePathNo-NoOnly required if sourceType "useSeedsFile" is selected. Seeds File path."/path/to/file"scanRecursivelyNoTRUENoSelect if subfolders are to be scanned.TRUEscanExcludedItemsNoFALSENoSelect so that the scanner will scan sub items of container items excluded by a patternFALSEincludesNo-YesList of regex URL patterns to include[{"include":".*tmp[^/]$"}]includeNo-Noregex URL patterns to include".*tmp[^/]$"excludesNo-YesList of regex URL patterns to exclude[{"include":".*tmp[^/]$"}]excludeNo-Noregex URL patterns to exclude".*tmp[^/]$"

Example

}
}

Update Connection

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.	"MyImage AddedConnection"
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[^/]$"

Example

Code Block

theme	RDark

{
    "id": "89d6632a-a296-426c-adb0-d442adcab4b0",
    "description": "<Connector Name> Test Connector",
    "properties": {         
        "scanRecursively": true,
        "scanExcludedItems": false,
        "includes": [
            {
                "include": ".*tmp[^/]$"
            }
        ],
        "excludes": [
            {
                "exclude": ".*tmp[^/]$"
            }
        ]     
	}
}

Create Connector Instance

For the creation of the Connector object using the Rest API check this page

Update Connector Instance

For the update of the Connector object using the Rest API check this page

Create Seed

Field	Required	Default	Multiple	Notes	Example
seed	Yes	-	No	<seed description>
type	Yes	-	No	The value must be azure-file-storage.	azure-file-storage
description	Yes	-	No	Name of the seed object.	"My Azure File 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_file_storage_seed	azure_file_storage_seed
sourceType	Yes	"useRootURL"	No	Source type ("useRootURL", "useSeedsFile")	"useRootURL"
url	No	-	No	Only required when sourceType "useRootURL" is selected. Azure File Share URL which will serve as the start of the crawl.	http://hostname/tennant/fileShare
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/fileShare1"},{"siteCollectionUrl":

Code Block

theme	RDark

{ "id": "89d6632a-a296-426c-adb0-d442adcab4b0", "description": "<Connector Name> Test Connector", "properties": { "sourceType": "useRootURL", "url": "http://hostname/tennant/fileShare", "seedsFilePath": "", "useExtraBlobContainers": true, "siteCollectionsToCrawl": [ { "siteCollectionUrl":

"http://hostname/tennant/

blobContainer1" }, { "siteCollectionUrl":

fileShare2"}]
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"

Example

Code Block

theme	RDark
title	POST aspire/_api/seeds

{
    "type": "<Connector Type>",
blobContainer2"
            }
        ],
        "scanRecursivelyseed": true"directory",
        "scanExcludedItems": false,
    "connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
    "includesdescription": ["<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",
    "includeworkflows": ".*tmp[^/]$"["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
    "tags": ["tag1", "tag2"],
    "properties":  }
        ]{
		"seed": "azure_file_storage_seed",
		"sourceType": "useRootURL",
        "excludesurl": [
    "http://hostname/tennant/fileShare",
         {
"seedsFilePath": "",
        "useExtraBlobContainers": true,
        "excludesiteCollectionsToCrawl": ".*tmp[^/]$"
            }
{
              ]     
	}
}

Create Connector Instance

For the creation of the Connector object using the Rest API check this page

Update Connector Instance

For the update of the Connector object using the Rest API check this page

"siteCollectionUrl": "http://hostname/tennant/blobContainer1"
            },
            {
                "siteCollectionUrl": "http://hostname/tennant/blobContainer2"
            }
        ] 
     }
}

Update Seed

Field

Required

Default

Multiple

Notes

Example

id

Create Seed

Field

Required

Default

Multiple

Notes

Example

seedYes-No<seed description>typeYes-No

The value must be azure-file-storage.

azure-file-storage

descriptionYes-NoName of the seed object.

"My Azure File Storage Seed"

connector

Yes

-

No

The id

Id of the

connector to be used with this seed. The connector type must match the seed type

seed to update.

"

82f7f0a4

2f287669-

8d28

d163-

47ce

4e35-

8c9d

ad17-

e3ca414b0d31"connection

6bbfe9df3778"
seed	No	-	No	<seed description>
description	No

Yes

-

No

The id of the connection to be used with this seed. The connection type must match

Name of the seed

type

object.

"

602d3700-28dd-4a6a-8b51-e4a663fe9ee6

MyAzure File StorageSeed"

workflows

connector

No

[ ]

-

Yes

No

The

ids

id of the

workflows that will be executed for the documents crawled.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]

connector to be used with this seed. The connector type must match the seed type.	"82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31"
connection

throttlePolicy

No

-

No

Id

The id of the

throttle policy that applies to this connection object

connection to be used with this seed. The connection type must match the seed type.

"

f5587cee

602d3700-

9116

28dd-

4011

4a6a-

b3a9

8b51-

6b235b333a1b

e4a663fe9ee6"

routingPolicies

workflows

No

[ ]

Yes

The ids of the

routing policies

workflows that

this seed will use

will be executed for the documents crawled.

["

313de87c

f8c414cb-

3cb9

1f5d-

4fe0

42ef-

a2cb

9cc9-

17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]

5696c3f0bda4"]
workflows.add	No	[ ]	Yes	The ids of the workflows to add.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.remove

Example

Code Block

theme	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":

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"

, "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"], "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6", "workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"], "tags": ["tag1", "tag2"], "properties": { "seed": "

properties	Yes	-	No	Configuration object
]
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"]
seed	Yes	-	No	This value must be azure_file_storage_seed	azure_file_storage_seed

" } }


sourceType	Yes	"useRootURL"	No	Source type ("useRootURL", "useSeedsFile")	"useRootURL"
url	No	-	No	Only required when sourceType "useRootURL" is selected. Azure File Share URL which will serve as the start of the crawl.	http://hostname/tennant/fileShare
useExtraBlobContainers	No	false	No	Add More Azure Blob Containers	false
siteCollectionsToCrawl

Update 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	-	Yes	Only required when "useExtraBlobContainers" is enabled. List of Azure Blob Container to crawl	[{"siteCollectionUrl": "http://hostname/tennant/fileShare1"},{"siteCollectionUrl": "http://hostname/tennant/fileShare2"}]
siteCollectionUrl	No	Name of the seed object.	"MyAzure File StorageSeed"	connector	No	-	No	The id of the connector to be used with this seed. The connector type must match the seed type.		Azure Blob Container to crawl	"http://hostname/tennant/blobContainer1"
seedsFilePath	"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.
Only required if sourceType "useSeedsFile" is selected. Seeds File path.	"/path/to/file"

Example

Code Block

theme	RDark
title	PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

{
    "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"]

routingPolicies.addNo[ ]YesThe ids of the routingPolicies to add.["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]routingPolicies.removeNo[ ]YesThe ids of the routingPolicies to remove.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"]tagsNo[ ]YesThe tags of the seed. These can be used to filter the seed["tag1", "tag3"]tags.addNo[ ]YesThe tags to add["tag4"]tags.removeNo[ ]YesThe tags to remove["tag2"]propertiesYes-NoConfiguration objectseedYes-NoThis value must be azure_file_storage_seedazure_file_storage_seed

Example

Code Block

theme	RDark
title	PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

{
    "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_file_storage_seed"    ,
    "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
    "workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
    "tags": ["tag", "tag2"],
    "properties": {         
		seed": "azure_file_storage_seed",
 		"sourceType": "useRootURL",
        "url": "http://hostname/tennant/fileShare",
        "seedsFilePath": "",
        "useExtraBlobContainers": true,
        "siteCollectionsToCrawl": [
            {
                "siteCollectionUrl": "http://hostname/tennant/blobContainer1"
            },
            {
                "siteCollectionUrl": "http://hostname/tennant/blobContainer2"
            }
        ]  
	}
}

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Create Credential

Example

Update Credential

Example

Create Connection

Example

Update Connection

Example

Update Connection

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Create Connector Instance

Update Connector Instance

Update Seed

Create Seed

Example

Update Seed

Example

Example

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

Create Credential

Example

Update Credential

Example

Create Connection

Example

Update Connection

Example

Update Connection

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Create Connector Instance

Update Connector Instance

Update Seed

Create Seed

Example

Update Seed

Example

Example