Aracılığıyla paylaş


Admin Keys - Get

Belirtilen 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=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

AdminKeyResult

Yönetici anahtarları başarıyla alındı ve yanıtta. Birincil veya ikincil anahtarı veri düzlemi REST API'sindeki 'api-key' parametresinin değeri olarak veya azure SDK'sını kullanarak ayrıcalıklı işlemler de dahil olmak üzere arama hizmetinizde herhangi bir işlem gerçekleştirebilirsiniz. Ayrıcalıklı işlemler dizinler ve veri kaynakları gibi kaynakların yönetilmesinin yanı sıra dizinlerinizdeki verileri karşıya yükleme, değiştirme veya silme işlemlerini içerir.

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

SearchGetAdminKeys

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Name Description
AdminKeyResult

Belirli bir arama hizmeti 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

Belirli bir arama hizmeti için birincil ve ikincil yönetici API anahtarlarını içeren yanıt.

Name Tür Description
primaryKey

string

Arama hizmetinin birincil yönetici API anahtarı.

secondaryKey

string

Arama hizmetinin ikincil yönetici API anahtarı.

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