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
storageConnectionStringaccountKey	Yes	-	No	Azure Storage Connection StringAccount Key	"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;"

Example

Code Block

theme	RDark
title	POST aspire/_api/credentials

{
    "type": "<Connector Type>azure-file-storage",
    "description": "<Connector Name> Credential",
    "properties": {   
		"storageConnectionStringaccountKey": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"     
	}
}

Update Credential

storageConnectionString Storage Connection String

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	Id 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
accountKey	Yes	-	No	Azure	"DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;"

Example

Account Key

"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

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": {        
		"storageConnectionStringaccountKey": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=myKey;"  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"         
	}
}

Create Connection

No[ ]YesThe ids routing policies will use[scanRecursivelyNoTRUE

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 ID of the throttle policy that applies to this connection object.	"f5587cee-9116-4011-b3a9-6b235b333a1b"routingPolicies
credential	Yes	-	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-313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
properties	Yes	-	No	Configuration object
url	Yes	-	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[^/]$"}]
Base path. All the seeds will be prefixed with this value to form the full URL.	"https://accountname.file.core.windows.net/"
storageConnectionString	Yes	-	No	Azure Storage Connection String. Set the value of 'AccountKey' to '${accountKey}'. '${accountKey}' will be replaced with the value from the Credentials	"DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=${accountKey};EndpointSuffix=core.windows.net"
indexContainers	No	TRUE	No	Select if containers are to be indexed.	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":"	exclude	No	-	No	regex URL patterns to exclude	".*tmp[^/]$"}]

Example

include

code

No

theme

-	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

RDark

title

POST aspire/_api/connections

{
    "type": "<Connector Type>",
    "descriptiontype": "<Connector Name> Test Connectorazure-file-storage",
    "properties": {           
        "scanRecursively": true,
    	"credential": "d42e1872-02c8-4a90-a714-44f15577389a",
    "scanExcludedItemsthrottlePolicy": false"",
        "includesroutingPolicies": [
            {"5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"],
    "description": "<Connector Name> Test Connector",
    "properties":            "include{ 
		"url": ".*tmp[^/]$"https://accountname.file.core.windows.net",
            }"storageConnectionString": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=${accountKey};EndpointSuffix=core.windows.net",
        ]"indexContainers": true,
           "excludesscanRecursively": true,
        "scanExcludedItems": false,
        "includes": [
            {
                "excludeinclude": ".*tmp[^/]$"
            }
        ],
          "excludes": 
	}
}

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 objectscanRecursivelyNoTRUENoSelect 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

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[^/]$"
            }
        ]      
	}
}

Update Connection

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

Notes
Example
connectorThe id connector to be used with this seed. The connector type must match the seed type.throttlePolicyId throttle policy f5587cee91164011b3a96b235b333a1bseed
Field
Required
Default
Multiple
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"
Notes
Example
id Yes - No ID of the connection to update "89d6632a-a296-426c-adb0-d442adcab4b0",
description No "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" connection Yes - No The id Name of the connection to be used with this seed. The connection type must match the seed typeobject.
"
602d3700-28dd-4a6a-8b51-e4a663fe9ee6
MyImage AddedConnection"
workflowsthrottlePolicy No [ ]- YesNo The ids ID of the workflows that will be executed for the documents crawled. ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] 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 IDs of the routing policies that this seed connection 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
url 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": "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"

Example

Base path. All the seeds will be prefixed with this value to form the full URL.	"https://accountname.file.core.windows.net/"
storageConnectionString	Yes	-	No	Azure Storage Connection String. Set the value of 'AccountKey' to '${accountKey}'. '${accountKey}' will be replaced with the value from the Credentials	"DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=${accountKey};EndpointSuffix=core.windows.net"
indexContainers	No	TRUE	No	Select if containers are to be indexed.	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[^/]$"

Example

Code Block

theme	RDark

{
    "id": "89d6632a-a296-426c-adb0-d442adcab4b0",
	"credential": "d42e1872-02c8-4a90-a714-44f15577389a",
    "throttlePolicy": "

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": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
    "connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
    "workflowsroutingPolicies": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"],
     "tagsdescription": ["tag1", "tag2"]"<Connector Name> Test Connector",
    "properties": {   
 		"seedurl": "azure_file_storage_seed",
		"sourceType": "useRootURLhttps://accountname.file.core.windows.net",
        "storageConnectionString": "DefaultEndpointsProtocol=http;AccountName=myAccount;AccountKey=${accountKey};EndpointSuffix=core.windows.net",
        "urlindexContainers": "http://hostname/tennant/fileShare",true, 
        "seedsFilePathscanRecursively": ""true,
        "useExtraBlobContainersscanExcludedItems": truefalse,
        "siteCollectionsToCrawlincludes": [
            {
                "siteCollectionUrlinclude": "http://hostname/tennant/blobContainer1"
.*tmp[^/]$"
            }
        ],
        },"excludes": [
            {
                "siteCollectionUrlexclude": "http://hostname/tennant/blobContainer2.*tmp[^/]$"
            }
        ] 
     }
}

Update

}
}

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

id


seed	Yes	-	No

Id of the seed to update."2f287669-d163-4e35-ad17-6bbfe9df3778"

	<seed description>
type	Yes	-	No	The value must be azure-file-storage.	azure-file-storage
description	Yes

seedNo-No<seed description>descriptionNo

-

No

Name of the seed object.

"

MyAzure

My Azure File

StorageSeed

Storage Seed"

connector

No

Yes

-

No

The id

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

Yes

-

No

The id

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

IDs of the workflows that will be executed

for the documents crawled.["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]workflows.add

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

IDs of the

workflows to add

routing policies that this seed will use.

[

"f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]workflows.remove

"313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
tags	No	[ ]	Yes	The

ids

tags of the

workflows to remove

seed. These can be used to filter the seed.

[

"f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]throttlePolicy

properties	Yes	-	No	Configuration object
"tag1", "tag2"]
seed	Yes	-	No	This value must be azure_file_storage_seed	"azure_file_storage_seed"
path	No	-	No

Id of the throttle policy that applies to this connection object."f5587cee-9116-4011-b3a9-6b235b333a1b"routingPoliciesNo[ ]YesThe ids of the routing policies that this seed will use.["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]routingPolicies.addNo[ ]YesThe ids of the routingPolicies to add.["

Path to the element to be crawled.

"/sample/path"

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": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "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

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

azure_file_storage_seed

",
        "path": "/sample/path"
    }
}

Update Seed

sourceTypeYes"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"

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

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 File StorageSeed"
connector	No	-	No	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	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	IDs of the workflows that will be executed for the documents crawled.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.add	No	[ ]	Yes	IDs of the workflows to add.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.remove	No	[ ]	Yes	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	IDs of the routing policies that this seed will use.

["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7",

"b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.add	No	[ ]	Yes	IDs of the routingPolicies to add.	["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":

properties	Yes	-	No	Configuration object

routingPolicies.remove	No	[ ]	Yes	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"]
seed	Yes	-	No	This value must be azure_file_storage_seed	"azure_file_storage_seed"
path	No	-	No	Path to the element to be crawled.	"/sample/path"

Example

Code Block

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

{
,
 		"sourceType": "useRootURL",
        "url": "http://hostname/tennant/fileShare",
        "seedsFilePath": "",
        "useExtraBlobContainers": true,
        "siteCollectionsToCrawlid": ["2f287669-d163-4e35-ad17-6bbfe9df3778",
    "seed":        {
            "<seed example>",
    "siteCollectionUrlconnector": "http://hostname/tennant/blobContainer1"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": ["siteCollectionUrltag":, "http://hostname/tennant/blobContainer2"tag2"],
    "properties": {           }
        ]  
		"seed": "azure_file_storage_seed",
        "path": "/sample/path"  
	}
}

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Create Credential

Example

Update Credential

Example

Example

Create Connection

Example

Update Connection

Example

Update Connection

Create Connector Instance

Update Connector Instance

Example

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Update Seed

Example

Example

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

Create Credential

Example

Update Credential

Example

Example

Create Connection

Example

Update Connection

Example

Update Connection

Create Connector Instance

Update Connector Instance

Example

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Update Seed

Example

Example