Aracılığıyla paylaş


Query Keys - List By Search Service

Verilen arama hizmeti 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=2023-11-01

URI Parametreleri

Name İçinde Gerekli Tür Description
resourceGroupName
path True

string

Geçerli abonelik içindeki kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.

searchServiceName
path True

string

Belirtilen kaynak grubuyla ilişkili arama hizmetinin adı.

subscriptionId
path True

string

Microsoft Azure aboneliğinin benzersiz tanımlayıcısı. Bu değeri Azure Resource Manager API'sinden, komut satırı araçlarından veya portaldan alabilirsiniz.

api-version
query True

string

Her istek için kullanılacak API sürümü.

İstek Başlığı

Name Gerekli Tür Description
x-ms-client-request-id

string

uuid

Bu isteği tanımlayan istemci tarafından oluşturulan GUID değeri. Belirtilirse, isteği izlemenin bir yolu olarak yanıt bilgilerine eklenir.

Yanıtlar

Name Tür Description
200 OK

ListQueryKeysResult

Verilen arama hizmeti için tüm sorgu anahtarları başarıyla alındı ve yanıtta yer alır. Sorgu anahtarlarından herhangi birini veri düzlemi REST API'sindeki 'api-key' parametresinin değeri olarak kullanabilir veya Azure SDK'sını kullanarak arama dizinlerinizin belgeler koleksiyonunda kimlikle belgeleri sorgulama ve arama gibi salt okunur işlemler gerçekleştirebilirsiniz.

Other Status Codes

CloudError

HTTP 404 (Bulunamadı): Abonelik, kaynak grubu veya arama hizmeti bulunamadı. HTTP 409 (Çakışma): Belirtilen abonelik devre dışı bırakıldı.

Güvenlik

azure_auth

OAuth2 yetkilendirme akışını Microsoft Entra ID.

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

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

SearchListQueryKeysBySearchService

Örnek isteği

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

Örnek yanıt

{
  "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

Name 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 arama hizmeti için sorgu API anahtarlarını içeren yanıt.

QueryKey

Belirli bir arama hizmeti için yalnızca sorgu işlemleri için izinlere sahip olan bir API anahtarını açıklar.

CloudError

API hatası hakkında bilgi içerir.

Name Tür Description
error

CloudErrorBody

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

CloudErrorBody

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

Name 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 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, hatadaki özelliğin adı).

ListQueryKeysResult

Belirli bir arama hizmeti için sorgu API anahtarlarını içeren yanıt.

Name 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[]

Arama hizmetinin sorgu anahtarları.

QueryKey

Belirli bir arama hizmeti için yalnızca sorgu işlemleri için izinlere sahip olan bir API anahtarını açıklar.

Name Tür Description
key

string

Sorgu API anahtarının değeri.

name

string

Sorgu API anahtarının adı; boş olabilir.