キーを使用して Azure AI 検索に接続する

REST 呼び出しにおける API キーの使用方法:

要求ヘッダーに管理者キーを設定します。 URI または要求の本文で管理者キーを渡すことはできません。 管理者キーは、作成、読み取り、更新、削除操作や、インデックスの一覧取得 (LIST) やサービス統計情報の取得 (GET) など、検索サービス自体に対して発行された要求にも使用されます。

インデックス作成要求での管理者 API キーの使用方法の例を次に示します。

### Create an index
POST {{baseUrl}}/indexes?api-version=2024-07-01  HTTP/1.1
  Content-Type: application/json
  api-key: {{adminApiKey}}

    {
        "name": "my-new-index",  
        "fields": [
            {"name": "docId", "type": "Edm.String", "key": true, "filterable": true},
            {"name": "Name", "type": "Edm.String", "searchable": true }
         ]
   }

POST の要求ヘッダーまたは GET の URI にクエリ キーを設定します。 クエリ キーは、index/docs コレクションを対象とする操作 (ドキュメントの検索、オートコンプリート、提案、またはドキュメントの取得 (GET)) に使用されます。

ドキュメントの検索 (GET) 要求でのクエリ API キーの使用方法の例を次に示します。

### Query an index
GET /indexes/my-new-index/docs?search=*&api-version=2024-07-01&api-key={{queryApiKey}}

PowerShell における API キーの使用方法:

次の構文を使用して、要求ヘッダーに API キーを設定します。

$headers = @{
'api-key' = '<YOUR-ADMIN-OR-QUERY-API-KEY>'
'Content-Type' = 'application/json' 
'Accept' = 'application/json' }

さまざまな操作の API キー使用法を示すスクリプトの例については、「クイック スタート: REST APIを使用して PowerShell で Azure AI Search インデックスを作成する」を参照してください。

Azure portal における API キーの使用方法:

• キー認証が組み込まれています。 既定では、Azure portal によって最初に API キーが試されます。 ただし、ユーザーが API キーを無効にしてロールの割り当てを設定した場合は、代わりにロールの割り当てが Azure portal によって使われます。

1. Azure portal にサインインし、ご利用の検索サービスを探します。

2. [設定] で [キー] を選択して、管理者キーとクエリ キーを表示します。

1. Az.Search モジュールをインストールします。

   Install-Module Az.Search
   

2. 管理者キーを返します。

   Get-AzSearchAdminKeyPair -ResourceGroupName <resource-group-name> -ServiceName <search-service-name>
   

3. クエリ キーを返します。

   Get-AzSearchQueryKey -ResourceGroupName <resource-group-name> -ServiceName <search-service-name>
   

管理者とクエリの API キーをそれぞれ返すには、次のコマンドを使用します。

az search admin-key show --resource-group <myresourcegroup> --service-name <myservice>

az search query-key list --resource-group <myresourcegroup> --service-name <myservice>

Management REST API で管理者キーの一覧表示またはクエリ キーの一覧表示を使用して、API キーを返します。

API キーを取得または更新するには、有効なロールの割り当てが必要です。 REST API を使用したロール要件の満たすガイダンスについては、「 REST API を使用して Azure AI Search Serviceを管理する 」を参照してください。

POST https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{resource-group}}/providers//Microsoft.Search/searchServices/{{search-service-name}}/listAdminKeys?api-version=2023-11-01

1. Azure portal にサインインし、ご利用の検索サービスを探します。

2. [設定]で [キー] 選択して、API キーを表示します。

3. [クエリ キーの管理] で、サービス用に既に生成されているクエリ キーを使用するか、新しいクエリ キーを作成します。 既定のクエリ キーには名前はありませんが、生成された他のクエリ キーには、管理を容易にするために名前を付けることができます。

   

API キーの使用方法を示すスクリプトの例については、「クエリ キーの作成または削除」参照してください。

クエリ キーの使用方法を示すスクリプトの例については、「クエリ キーの作成または削除」参照してください。

Management REST API のクエリ キーの作成を使用します。

API キーを作成または管理するには、有効なロールの割り当てが必要です。 REST API を使用したロール要件の満たすガイダンスについては、「 REST API を使用して Azure AI Search Serviceを管理する 」を参照してください。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2023-11-01