Aracılığıyla paylaş


Query Keys - Create

Belirtilen arama hizmeti için yeni bir sorgu anahtarı oluşturur. Hizmet başına en fazla 50 sorgu anahtarı oluşturabilirsiniz.

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

URI Parametreleri

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

string

Yeni sorgu API anahtarının adı.

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

QueryKey

Sorgu anahtarı başarıyla oluşturuldu ve yanıtta. Sorgu anahtarını veri düzlemi REST API'sindeki 'api-key' parametresinin değeri olarak veya Azure SDK'sını kullanarak Arama dizinlerinizde kimliğe göre 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

SearchCreateQueryKey

Örnek isteği

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/Query key for browser-based clients?api-version=2023-11-01

Örnek yanıt

{
  "name": "Query key for browser-based clients",
  "key": "<a 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.

QueryKey

Yalnızca sorgu işlemleri için izinlere sahip belirli bir arama hizmeti için 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ı).

QueryKey

Yalnızca sorgu işlemleri için izinlere sahip belirli bir arama hizmeti için 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.