How to Index on Specific document Library from the Sharepoint Subsite in Azure Cognitive Search

Question

How to Index on Specific document Library from the Sharepoint Subsite in Azure Cognitive Search

Marcelo Lorenzetti 20

below is the Full Url of the Document library:
https://test.sharepoint.com/sites/Corporate-Technology/sandbox/azuresearchtest/Forms/AllItems.aspx

Site : Corporate-Technology
Subsite : sandbox
Document Library : azuresearchtest

Below API use to create DataSourse

curl --location 'https://test.search.windows.net/datasources?api-version=2020-06-30' \
--header 'api-key: aVL4MqPqtAoRQc28aQoGSymu1SM8ioxtGl8HFUvAUVAzSeCj8Ypf' \
--header 'Content-Type: application/json' \
--data '{
    "name": "sharepoint-search1",
    "type": "sharepoint",
    "credentials": {
        "connectionString": "SharePointOnlineEndpoint=https://test.sharepoint.com/sites/Corporate-Technology/sandbox/;ApplicationId=270d755b-3fa8-4436-b90a-1f69b920c3de"
    },
    "container": {
        "name": "azuresearchtest",
        "query": null
    }
}'

Response of the Above API :

{
    "error": {
        "code": "",
        "message": "Container name azuresearchtest is invalid for type sharepoint."
    }
}

how to create datasource for specific Document Library.In my case Document library is "azuresearchtest"

Thank you

Bhargavi Naragani 3,085 Reputation points Microsoft External Staff

2025-03-21T19:16:03.76+00:00
Hi @Marcelo Lorenzetti,

To create a data source for a specific document library in a SharePoint subsite using Azure Cognitive Search, you can utilize the useQuery option in the container parameter. Here’s how you can structure your data source definition to index the "azuresearchtest" document library located in the "sandbox" subsite of the "Corporate-Technology" site.

Here's how you can modify your cURL command:

curl --location 'https://test.search.windows.net/datasources?api-version=2020-06-30' \ --header 'api-key: aVL4MqPqtAoRQc28aQoGSymu1SM8ioxtGl8HFUvAUVAzSeCj8Ypf' \ --header 'Content-Type: application/json' \ --data '{ "name": "sharepoint-search1", "type": "sharepoint", "credentials": { "connectionString": "SharePointOnlineEndpoint=https://test.sharepoint.com/sites/Corporate-Technology/sandbox/;ApplicationId=270d755b-3fa8-4436-b90a-1f69b920c3de" }, "container": { "name": "useQuery", "query": "path:\"https://test.sharepoint.com/sites/Corporate-Technology/sandbox/azuresearchtest\"" } }'

In this configuration the container's name is set to "useQuery", indicating that a query will specify the content to index. The query uses the path filter to target the specific document library "azuresearchtest" within your subsite.

Ensure that the Application ID used in the connectionString has the necessary permissions to access the specified document library.

Verify that the API version you're using supports the useQuery functionality. If you encounter issues, consider updating to a newer API version if available.

By following these adjustments, you should be able to create a data source that targets your specific document library within the SharePoint subsite.

Kindly refer to the below documentation for better understanding:
Index data from SharePoint document libraries
Configure the SharePoint Online indexer

Let me know if you have any further Queries.

2 answers

Your answer

Answer 1

When using created resoure to create Indexer ,
curl --location 'https://test.search.windows.net/indexers?api-version=2024-05-01-preview' \

--header 'api-key: aVL4MqPqtAoQQc28aQoGSymu1SM8ioxtGl8HFUvAUVAzSeCj8Ypf' \

--header 'Content-Type: application/json' \

--data '{

"name": "sharepoint-indexer1",

"dataSourceName": "sharepoint-search",

"targetIndexName": "sharepoint-index",

"parameters": {

    "batchSize": null,

    "maxFailedItems": null,

    "maxFailedItemsPerBatch": null,

    "base64EncodeKeys": null,

    "configuration": {

        "indexedFileNameExtensions": ".pdf, .docx",

        "excludedFileNameExtensions": ".png, .jpg",

        "dataToExtract": "contentAndMetadata"

    }

},

"schedule": {},

"outputFieldMappings": [

    {

        "sourceFieldName": "/document/content/myKeyPhrases",

        "targetFieldName": "content"

    }

],

"fieldMappings": [

    {

        "sourceFieldName": "metadata_spo_site_library_item_id",

        "targetFieldName": "id",

        "mappingFunction": {

            "name": "base64Encode"

        }

    }

]

}'

Error :

{
    "error": {
        "code": "",
        "message": "Error with data source: Unexpected keyword 'p' in query property.  Please adjust your data source definition in order to proceed."
    }
}

Answer 2

Hello @Marcelo Lorenzetti,

The error occurs due to an incorrect query format in the data source definition. The container.name should be "useQuery", and the query parameter must correctly point to the document library path.

Modify the data source creation request to correctly target the document library:


curl --location 'https://test.search.windows.net/datasources?api-version=2020-06-30' \

--header 'api-key: aVL4MqPqtAoRQc28aQoGSymu1SM8ioxtGl8HFUvAUVAzSeCj8Ypf' \

--header 'Content-Type: application/json' \

--data '{

    "name": "sharepoint-search1",

    "type": "sharepoint",

    "credentials": {

        "connectionString": "SharePointOnlineEndpoint=https://test.sharepoint.com/sites/Corporate-Technology/sandbox/;ApplicationId=270d755b-3fa8-4436-b90a-1f69b920c3de"

    },

    "container": {

        "name": "useQuery",

        "query": "path:\"https://test.sharepoint.com/sites/Corporate-Technology/sandbox/azuresearchtest\""

    }

}'

Update the indexer request to use the corrected data source:


curl --location 'https://test.search.windows.net/indexers?api-version=2024-05-01-preview' \

--header 'api-key: aVL4MqPqtAoQQc28aQoGSymu1SM8ioxtGl8HFUvAUVAzSeCj8Ypf' \

--header 'Content-Type: application/json' \

--data '{

    "name": "sharepoint-indexer1",

    "dataSourceName": "sharepoint-search1",

    "targetIndexName": "sharepoint-index",

    "parameters": {

        "batchSize": null,

        "maxFailedItems": null,

        "maxFailedItemsPerBatch": null,

        "base64EncodeKeys": null,

        "configuration": {

            "indexedFileNameExtensions": ".pdf, .docx",

            "excludedFileNameExtensions": ".png, .jpg",

            "dataToExtract": "contentAndMetadata"

        }

    },

    "schedule": {},

    "outputFieldMappings": [

        {

            "sourceFieldName": "/document/content/myKeyPhrases",

            "targetFieldName": "content"

        }

    ],

    "fieldMappings": [

        {

            "sourceFieldName": "metadata_spo_site_library_item_id",

            "targetFieldName": "id",

            "mappingFunction": {

                "name": "base64Encode"

            }

        }

    ]

}'

If the issue persists try using a different API version, such as 2020-06-30 or 2024-05-01-preview. Verify that your SharePoint Application ID has the necessary permissions to access the document library.

Hope this help!

Please do not forget to click "Accept the answer” and Yes wherever the information provided helps you, this can be beneficial to other community members.

User's image

If you have any other questions or still running into more issues, let me know in the "comments" and I would be happy to help you.

Bodapati Harish 320 Reputation points Microsoft External Staff

2025-03-26T04:06:20.98+00:00

Hello @Marcelo Lorenzetti,

Following up to see if you have chance to check my previous response and help us with requested information to check and assist you further on this.
Bodapati Harish 320 Reputation points Microsoft External Staff

2025-03-27T03:45:34.7966667+00:00

Hello @Marcelo Lorenzetti,

We haven’t heard from you on the last response and was just checking back to see could you please provide more details on your requirement so that I can assist you further.

Share via

How to Index on Specific document Library from the Sharepoint Subsite in Azure Cognitive Search

2 answers

Your answer