Azure AI 検索 の一覧結果をページングする (プレビュー)

• 最新の Azure.Search.Documents プレビュー パッケージ: dotnet add package Azure.Search.Documents --prerelease

• キーレス認証の場合、 Azure.Identity パッケージは次のようになります。 dotnet add package Azure.Identity

  Note

  クライアント ライブラリは、Search Service REST API の 2026-08-01-preview バージョンをサポートする必要があります。 以前のバージョンでは、この記事に示されているカーソル パラメーターは公開されていません。

• 最新の azure-search-documents プレビュー パッケージ: pip install --pre azure-search-documents

• キーレス認証の場合、 azure-identity パッケージは次のようになります。 pip install azure-identity

  Note

  クライアント ライブラリは、Search Service REST API の 2026-08-01-preview バージョンをサポートする必要があります。 以前のバージョンでは、この記事に示されているカーソル パラメーターは公開されていません。

• Search Service REST API の 2026-08-01-preview バージョン。

• キーレス認証の場合は、各 HTTP 要求の Authorization ヘッダーにMicrosoft Entra ID トークンを含めます。

次の例では、名前が hotels で始まり、ページあたり最大 50 個のインデックスを要求するインデックスを一覧表示します。 AsyncPageable<SearchIndex>結果を反復処理すると、後続の各ページが自動的に要求されます。

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

次の例では、名前が hotels で始まり、ページあたり最大 50 個のインデックスを要求するインデックスを一覧表示します。 ItemPaged結果を反復処理すると、後続の各ページが自動的に要求されます。

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)

リファレンス:SearchIndexClient.list_indexes

名前が hotels で始まるインデックスを一覧表示する最初の要求を送信します。 この要求は、最大 50 個のインデックス名を返します。

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

一致するインデックスが 50 個を超える場合、応答には完全な継続 URL と不透明なトークンを含む @odata.nextLinkが含まれます。 次の応答は省略されています。

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

次のページを要求するには、返された完全な @odata.nextLink 値に GET 要求を送信します。 同じ認証ヘッダーを保持します。

GET <[email protected]>
Authorization: Bearer <access-token>
Accept: application/json

Reference:List Indexes

ターミナル応答には最終的なインデックス名が含まれており、 @odata.nextLinkを省略して、使用可能なページがなくなったことを示します。 結果の順序はカーソル コントラクトの一部ではありません。

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