Подключение к Поиск с использованием ИИ Azure с помощью ключей

1. Перейдите в службу поиска на портале Azure.

2. В левой области выберите Параметры>Ключи, чтобы просмотреть ключи администратора и ключи запроса.

   

Выполните следующие команды, чтобы вернуть ключи API администратора и запроса соответственно. Справку по REST см. в статье Управление вашей службой Поиск с использованием ИИ Azure с помощью REST API.

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
   

Справочник:Ключи администратора— получение, ключи запросов — список по службе поиска

Используйте Azure SDK для Python для программного получения ключей 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}")

Справочник:SearchManagementClient | AdminKeys | QueryKeys

Выполните следующие команды, чтобы вернуть ключи API администратора и запроса соответственно. См. статью «Управление службой Поиск с использованием ИИ Azure с помощью PowerShell» для получения справки по PowerShell.

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, см. статью Manage службы Поиск с использованием ИИ Azure с помощью 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=2026-04-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 или URI для GET. Ключи запросов используются для операций, предназначенных для коллекции index/docs, таких как Поиск документов, Автозаполнение, Предложение или GET документа.

Ниже приведен пример использования ключа API запроса для запроса "Документы поиска" (GET):

### Query an index
GET /indexes/my-new-index/docs?search=*&api-version=2026-04-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=2026-04-01&search=attached restaurant&searchFields=Description,Tags&$select=HotelId,HotelName,Tags,Description&$count=true'

Отправьте запрос в службу поиска:

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

Дополнительные примеры скриптов для других операций можно найти в Quickstart: создание индекса Поиск с использованием ИИ Azure в PowerShell с помощью REST API.

1. Перейдите в службу поиска на портале Azure.

2. На панели слева выберите"Ключи параметров", чтобы просмотреть > API.

3. В разделе "Управление ключами запросов" используйте ключ запроса, уже созданный для службы, или создайте новые ключи запроса. Ключ запроса по умолчанию не называется, но другие созданные ключи запросов можно назвать для управления.

   

Используйте создание ключей запросов в REST API управления.

Необходимо иметь допустимое назначение роли для создания ключей API или управления ими. Ознакомьтесь с Управляйте службой Поиск с использованием ИИ Azure с помощью 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, можно найти в разделе "Создание или удаление ключей запросов".

Пример скрипта, показывающий использование ключа запроса, можно найти в разделе "Создание или удаление ключей запросов".