Page through Azure AI Search list results (preview)

• The latest Azure.Search.Documents preview package: dotnet add package Azure.Search.Documents --prerelease

• For keyless authentication, the Azure.Identity package: dotnet add package Azure.Identity

  Note

  The client library must support the 2026-08-01-preview version of the Search Service REST API. Earlier versions don't expose the cursor parameters shown in this article.

• The latest azure-search-documents preview package: pip install --pre azure-search-documents

• For keyless authentication, the azure-identity package: pip install azure-identity

  Note

  The client library must support the 2026-08-01-preview version of the Search Service REST API. Earlier versions don't expose the cursor parameters shown in this article.

• The 2026-08-01-preview version of the Search Service REST API.

• For keyless authentication, include a Microsoft Entra ID token in the Authorization header of each HTTP request.

The following example lists indexes whose names start with hotels and requests up to 50 indexes per page. Iterating the AsyncPageable<SearchIndex> result automatically requests each subsequent page.

using System;
using Azure;
using Azure.Identity;
using Azure.Search.Documents;
using Azure.Search.Documents.Indexes;
using Azure.Search.Documents.Indexes.Models;
using Azure.Search.Documents.Models;

string endpoint = Environment.GetEnvironmentVariable(
    "AZURE_SEARCH_ENDPOINT")!;

var options = new SearchClientOptions(
    SearchClientOptions.ServiceVersion.V2026_08_01_Preview);
var client = new SearchIndexClient(
    new Uri(endpoint),
    new AzureCliCredential(),
    options);

AsyncPageable<SearchIndex> indexes = client.GetIndexesAsync(
    search: "hotels",
    pageSize: 50,
    searchType: ListingSearchType.Prefix);

await foreach (SearchIndex index in indexes)
{
    Console.WriteLine(index.Name);
}

Reference: SearchIndexClient.GetIndexesAsync

The following example lists indexes whose names start with hotels and requests up to 50 indexes per page. Iterating the ItemPaged result automatically requests each subsequent page.

import os

from azure.identity import AzureCliCredential
from azure.search.documents.indexes import SearchIndexClient

endpoint = os.getenv("AZURE_SEARCH_ENDPOINT")

with SearchIndexClient(
    endpoint,
    AzureCliCredential(),
    api_version="2026-08-01-preview",
) as client:
    indexes = client.list_indexes(
        select=["name"],
        search="hotels",
        page_size=50,
        search_type="prefix",
    )
    for index in indexes:
        print(index.name)

Reference: SearchIndexClient.list_indexes

Send an initial request to list indexes whose names start with hotels. The request returns up to 50 index names:

GET https://<search-service-name>.search.windows.net/indexes?api-version=2026-08-01-preview&search=hotels&searchType=prefix&pageSize=50&$select=name
Authorization: Bearer <access-token>
Accept: application/json

Reference: List Indexes

When more than 50 matching indexes exist, the response includes @odata.nextLink, which contains the complete continuation URL and an opaque token. The following response is abbreviated:

{
  "value": [
    {
      "name": "<index-name>"
    }
  ],
  "@odata.nextLink": "https://<search-service-name>.search.windows.net/indexes?api-version=2026-08-01-preview&searchType=prefix&%24select=name&%24skiptoken=<opaque-token>"
}

To request the next page, send a GET request to the complete @odata.nextLink value exactly as returned. Keep the same authentication header:

GET <complete-@odata.nextLink-value>
Authorization: Bearer <access-token>
Accept: application/json

Reference: List Indexes

The terminal response contains the final index names and omits @odata.nextLink, indicating that no more pages are available. Result order isn't part of the cursor contract:

{
  "value": [
    {
      "name": "<next-index-name>"
    }
  ]
}