Verbinding maken met Azure AI Search met behulp van sleutels

1. Meld u aan bij Azure Portal en zoek uw zoekservice.

2. Selecteer vanuit het linkerdeelvenster Instellingen>Sleutels om beheerders- en querysleutels weer te geven.

   

Voer de volgende opdrachten uit om respectievelijk beheerders- en query-API-sleutels te retourneren. Zie Uw Azure AI Search-service beheren met REST API's voor hulp bij REST.

1. Beheerderssleutels retourneren:

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

2. Querysleutels retourneren:

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

Verwijzing:Beheersleutels - Ophalen, Querysleutels - Lijst op basis van zoekservice

Gebruik de Azure SDK voor Python om API-sleutels programmatisch op te halen. Installeer de beheer-SDK:

pip install azure-mgmt-search azure-identity

Voer de volgende code uit om beheerders- en query-API-sleutels te retourneren:

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

Naslaginformatie:SearchManagementClient | AdminKeys | QueryKeys

Voer de volgende opdrachten uit om respectievelijk beheerders- en query-API-sleutels te retourneren. Zie voor hulp bij PowerShell Uw Azure AI Search-service beheren met behulp van PowerShell.

1. Installeer de Az.Search module:

   Install-Module Az.Search
   

2. Beheerderssleutels retourneren:

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

3. Querysleutels retourneren:

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

Voer de volgende opdrachten uit om respectievelijk beheerders- en query-API-sleutels te retourneren. Zie Uw Azure AI Search-service beheren met behulp van de Azure CLI voor hulp bij de Azure CLI.

1. Beheerderssleutels retourneren:

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

2. Querysleutels retourneren:

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

Zoals u weet, is sleutelverificatie standaard ingeschakeld en worden bewerkingen in het gegevensvlak ondersteund, zoals indexering en query's.

Als u ECHTER API-sleutels uitschakelt en roltoewijzingen instelt, gebruikt Azure Portal in plaats daarvan roltoewijzingen.

Stel een beheerderssleutel in de aanvraagheader in. U kunt geen beheerderssleutels doorgeven aan de URI of in de hoofdtekst van de aanvraag.

Hier volgt een voorbeeld van het gebruik van beheerders-API-sleutels voor een indexaanvraag maken:

@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 }
         ]
   }

Stel een querysleutel in een aanvraagheader in voor POST of op de URI voor GET. Querysleutels worden gebruikt voor bewerkingen die gericht zijn op de index/docs verzameling: Documenten doorzoeken, Automatisch aanvullen, Voorstellen of GET-document.

Hier volgt een voorbeeld van het gebruik van query-API-sleutels voor een GET-aanvraag (Search Documents):

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

Het is een best practice om de API-sleutel in te stellen als een omgevingsvariabele, maar in dit voorbeeld wordt deze als een tekenreeks weergegeven. In het voorbeeld wordt een query-API-sleutel gebruikt voor een querybewerking.

# 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']}")

Stel API-sleutels in de aanvraagheader in met behulp van de volgende syntaxis:

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

Gebruik een variabele om de volledig gekwalificeerde query te bevatten:

$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'

Verzend de aanvraag naar de zoekservice:

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

Meer scriptvoorbeelden voor andere bewerkingen vindt u in quickstart: Een Azure AI Search-index maken in PowerShell met behulp van REST API's.

1. Meld u aan bij Azure Portal en zoek uw zoekservice.

2. Vanuit het linkerdeelvenster selecteer Instellingen>enSleutels om API-sleutels weer te geven.

3. Gebruik onder Querysleutels beheren de querysleutel die al is gegenereerd voor uw service of maak nieuwe querysleutels. De standaardquerysleutel heeft geen naam, maar andere gegenereerde querysleutels kunnen worden benoemd voor beheerbaarheid.

   

Gebruik Querysleutels maken in de REST API voor beheer.

U moet een geldige roltoewijzing hebben om API-sleutels te maken of te beheren. Zie Uw Azure AI-Search-service beheren met REST API's voor hulp bij het voldoen aan rolvereisten met behulp van de REST API's.

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

Een voorbeeld van een script met api-sleutelgebruik vindt u in Querysleutels maken of verwijderen.

Een voorbeeld van een script waarin het gebruik van querysleutels wordt weergegeven, vindt u in Querysleutels maken of verwijderen.