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

1. Azure ポータルで検索サービスに移動します。

2. 左側のウィンドウで [設定]>[キー ]を選択して、管理者キーとクエリ キーを表示します。

   

次のコマンドを実行して、それぞれ管理者キーとクエリ API キーを返します。 REST のヘルプについては、「 REST API を使用してAzure AI 検索 サービスを管理するを参照してください。

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

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

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

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

リファレンス:管理キー - 取得、 クエリ キー - Search サービス別リスト

PYTHONのAzure SDKを使用して、API キーをプログラムで取得します。 管理 SDK をインストールします。

pip install azure-mgmt-search azure-identity

管理者キーとクエリ API キーを返すには、次のコードを実行します。

import os
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

# Set up variables
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]
resource_group = "your-resource-group"
search_service_name = "your-search-service"

# Create the management client
credential = DefaultAzureCredential()
client = SearchManagementClient(credential, subscription_id)

# Get admin keys
admin_keys = client.admin_keys.get(resource_group, search_service_name)
print(f"Primary admin key: {admin_keys.primary_key}")
print(f"Secondary admin key: {admin_keys.secondary_key}")

# Get query keys
query_keys = client.query_keys.list_by_search_service(resource_group, search_service_name)
for key in query_keys:
    print(f"Query key '{key.name}': {key.key}")

Reference:SearchManagementClient | AdminKeys | QueryKeys

次のコマンドを実行して、それぞれ管理者キーとクエリ API キーを返します。 PowerShell のヘルプについては、「 PowerShell を使用してAzure AI 検索 サービスを管理する」を参照してください。

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 キーを返します。 Azure CLIのヘルプについては、「 Azure CLIを参照してください。

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

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

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

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

キー認証は既定で有効になっており、インデックス作成やクエリなどのデータ プレーン操作をサポートしていることを思い出してください。

ただし、API キーを無効にするとロールの割り当てを設定すると、Azure ポータルでは代わりにロールの割り当てが使用されます。

要求ヘッダーに管理者キーを設定します。 URI または要求の本文で管理者キーを渡すことはできません。

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

@baseUrl=https://my-demo-search-service.search.windows.net
@adminApiKey=aaaabbbb-0000-cccc-1111-dddd2222eeee

### Create an index
POST {{baseUrl}}/indexes?api-version=2025-09-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=2025-09-01&api-key={{queryApiKey}}

API キーを環境変数として設定することをお勧めしますが、わかりやすくするために、この例では文字列として表示します。 この例では、クエリ操作にクエリ API キーを使用します。

# Import libraries
from azure.search.documents import SearchClient
from azure.core.credentials import AzureKeyCredential
from azure.identity import DefaultAzureCredential, AzureAuthorityHosts

# Variables for endpoint, keys, index
search_endpoint: str = "https://<Put your search service NAME here>.search.windows.net/"
credential = AzureKeyCredential("Your search service query key")
index_name: str = "hotels-quickstart-python"

# Set up the client
search_client = SearchClient(endpoint=search_endpoint,
                      index_name=index_name,
                      credential=credential)

# Run the query
results =  search_client.search(query_type='simple',
    search_text="*" ,
    select='HotelName,Description,Tags',
    include_total_count=True)

print ('Total Documents Matching Query:', results.get_count())
for result in results:
    print(result["@search.score"])
    print(result["HotelName"])
    print(result["Tags"])
    print(f"Description: {result['Description']}")

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

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

変数を使用して、完全修飾クエリを格納します。

$url = '<YOUR-SEARCH-SERVICE>/indexes/hotels-quickstart/docs?api-version=2025-09-01&search=attached restaurant&searchFields=Description,Tags&$select=HotelId,HotelName,Tags,Description&$count=true'

検索サービスに要求を送信します。

Invoke-RestMethod -Uri $url -Headers $headers | ConvertTo-Json

その他の操作のスクリプト例については、「Quickstart: REST API を使用して PowerShell でAzure AI 検索インデックスを作成するを参照してください。

1. Azure ポータルで検索サービスに移動します。

2. 左側のウィンドウで、[設定]>[キー] を選択して API キーを表示します。

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

   

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

API キーを作成または管理するには、有効なロールの割り当てが必要です。 Azure AI 検索 サービスの管理を REST API で行う方法については、REST API を使用したガイダンス を参照してください。

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

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

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