Admin Keys - Get

Hizmet:

Search Management

API Sürümü:

2026-11-01

Belirtilen Azure Yapay Zeka Arama hizmeti için birincil ve ikincil yönetici API anahtarlarını alır.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?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	AdminKeyResult	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

SearchGetAdminKeys

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:

200

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Tanımlar

Veri Akışı Adı	Description
AdminKeyResult	Verilen bir Azure Yapay Zeka Arama servisi için birincil ve ikincil yönetici API anahtarlarını içeren yanıt.
CloudError	API hatası hakkında bilgi içerir.
CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

AdminKeyResult

Nesne

Verilen bir Azure Yapay Zeka Arama servisi için birincil ve ikincil yönetici API anahtarlarını içeren yanıt.

Veri Akışı Adı	Tür	Description
primaryKey	string	Arama hizmetinin birincil yönetici API anahtarı.
secondaryKey	string	Arama hizmetinin ikincil yönetici API anahtarı.

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ı).