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=2024-03-01-preview
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
name
|
path | True |
string |
Yeni sorgu API anahtarının adı. |
resource
|
path | True |
string |
Geçerli abonelik içindeki kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz. |
search
|
path | True |
string |
Belirtilen kaynak grubuyla ilişkili Azure AI Arama hizmeti adı. Regex pattern: |
subscription
|
path | True |
string |
Microsoft Azure aboneliğinin benzersiz tanımlayıcısı. Bu değeri Azure Resource Manager API'sinden 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 |
Sorgu anahtarı başarıyla oluşturuldu ve yanıtta. Azure AI Arama hizmeti REST API veya SDK'daki 'api-key' parametresinin değeri olarak sorgu anahtarını kullanarak arama dizinlerinizde kimliğe göre belgeleri sorgulama ve arama gibi salt okunur işlemler gerçekleştirebilirsiniz. |
|
Other Status Codes |
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
Microsoft Identity platformunda desteklendiği gibi örtük bir verme akışı belirtir.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
SearchCreateQueryKey
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2024-03-01-preview
Sample Response
{
"name": "An API key granting read-only access to the documents collection of an index.",
"key": "<a query API key>"
}
Tanımlar
Name | Description |
---|---|
Cloud |
API hatası hakkında bilgi içerir. |
Cloud |
Hata kodu ve ileti içeren belirli bir API hatası açıklanır. |
Query |
Belirli bir Azure AI Arama hizmeti için bir dizinin docs koleksiyonu üzerinde salt okunur izinleri ileten bir API anahtarını açıklar. |
CloudError
API hatası hakkında bilgi içerir.
Name | Tür | Description |
---|---|---|
error |
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
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 |
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
Belirli bir Azure AI Arama hizmeti için bir dizinin docs koleksiyonu üzerinde salt okunur izinleri ileten 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ı. Sorgu adları isteğe bağlıdır, ancak ad atamak nasıl kullanıldığını hatırlamanıza yardımcı olabilir. |