Query Keys - List By Search Service

Hizmet:: Search Management

API Sürümü:: 2026-11-01

Verilen Azure Yapay Zeka Arama servisi için sorgu API anahtarlarının listesini döndürür.

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

URI Parametreleri

Veri Akışı Adı	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Belirtilen kaynak grubuyla ilişkili Azure Yapay Zeka Arama hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Veri Akışı Adı	Gerekli	Tür	Description
x-ms-client-request-id		string (uuid)	Bu isteği tanımlayan istemci tarafından oluşturulan BIR GUID değeri. Belirtilirse, isteği izlemenin bir yolu olarak yanıt bilgilerine eklenir.

Yanıtlar

Veri Akışı Adı	Tür	Description
200 OK	ListQueryKeysResult	Azure işlemi başarıyla tamamlandı.
Other Status Codes	CloudError	Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Veri Akışı Adı	Description
user_impersonation	kullanıcı hesabınızı taklit etme

Örnekler

SearchListQueryKeysBySearchService

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2026-11-01

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to returns the list of query API keys for the given Azure AI Search service.
 *
 * @summary returns the list of query API keys for the given Azure AI Search service.
 * x-ms-original-file: 2026-11-01/SearchListQueryKeysBySearchService.json
 */
async function searchListQueryKeysBySearchService() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.queryKeys.listBySearchService("rg1", "mysearchservice")) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:: 200

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another query API key>"
    }
  ]
}

Tanımlar

Veri Akışı Adı	Description
CloudError	API hatası hakkında bilgi içerir.
CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
ListQueryKeysResult	Belirli bir Azure Yapay Zeka Arama hizmeti için sorgu API anahtarlarını içeren yanıt.
QueryKey	Bir indeksin docs koleksiyonunda yalnızca okunma izinlerini ileten belirli bir Azure Yapay Zeka Arama hizmeti için API anahtarını tanımlar.

CloudError

Nesne

API hatası hakkında bilgi içerir.

Veri Akışı Adı	Tür	Description
error	CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
message	string	Neyin yanlış gittiğini gösteren hatanın kısa bir açıklaması (ayrıntılar/hata ayıklama bilgileri için 'error.message' özelliğine bakın).

CloudErrorBody

Nesne

Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

Veri Akışı Adı	Tür	Description
code	string	Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	CloudErrorBody[]	Bu hatayla ilgili iç içe yerleştirilmiş hatalar içerir.
message	string	Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
target	string	Belirli bir hatanın hedefi (örneğin, hatalı özelliğin adı).

ListQueryKeysResult

Nesne

Belirli bir Azure Yapay Zeka Arama hizmeti için sorgu API anahtarlarını içeren yanıt.

Veri Akışı Adı	Tür	Description
nextLink	string	Sorgu anahtarlarının sonraki sayfasını sorgulamak için kullanılabilecek istek URL'si. İstenen sorgu anahtarlarının toplam sayısı sayfa boyutu üst sınırını aştığında döndürülür.
value	QueryKey[]	Azure Yapay Zeka Arama hizmetinin sorgu anahtarları.

QueryKey

Nesne

Bir indeksin docs koleksiyonunda yalnızca okunma izinlerini ileten belirli bir Azure Yapay Zeka Arama hizmeti için API anahtarını tanımlar.

Veri Akışı Adı	Tür	Description
key	string	Sorgu API anahtarının değeri.
name	string	Sorgu API anahtarının adı. Sorgu adları isteğe bağlıdır, ancak ad atamak nasıl kullanıldığını hatırlamanıza yardımcı olabilir.