Services - Check Name Availability

Verilen arama hizmeti adının kullanılabilir olup olmadığını denetler. Arama hizmeti adları, hizmet URI'sinin (https://< name.search.windows.net>) bir parçası oldukları için genel olarak benzersiz olmalıdır.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01

URI Parametreleri

Name İçinde Gerekli Tür Description
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ığı

Name 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.

İstek Gövdesi

Name Gerekli Tür Description
name True

string

Doğrulanması gereken arama hizmeti adı. Arama hizmeti adları yalnızca küçük harf, rakam veya kısa çizgi içermeli, ilk iki veya son bir karakter olarak tire kullanamaz, ardışık tire içeremez ve 2 ile 60 karakter uzunluğunda olmalıdır.

type True enum:

searchServices

Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdır.

Yanıtlar

Name Tür Description
200 OK

CheckNameAvailabilityOutput

İstek başarılı oldu.

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

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

Örnekler

SearchCheckNameAvailability

Örnek isteği

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01

{
  "name": "mysearchservice",
  "type": "searchServices"
}

Örnek yanıt

{
  "message": "",
  "nameAvailable": false,
  "reason": "AlreadyExists"
}

Tanımlar

Name Description
CheckNameAvailabilityInput

Denetim adı kullanılabilirlik API'sinin girişi.

CheckNameAvailabilityOutput

Denetim adı kullanılabilirlik API'sinin çıktısı.

CloudError

API hatası hakkında bilgi içerir.

CloudErrorBody

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

UnavailableNameReason

Adın kullanılamama nedeni. 'Geçersiz', sağlanan adın adlandırma gereksinimleriyle (yanlış uzunluk, desteklenmeyen karakterler vb.) eşleşmediğini gösterir. 'AlreadyExists' adın zaten kullanımda olduğunu ve bu nedenle kullanılamadığını gösterir.

CheckNameAvailabilityInput

Denetim adı kullanılabilirlik API'sinin girişi.

Name Tür Description
name

string

Doğrulanması gereken arama hizmeti adı. Arama hizmeti adları yalnızca küçük harf, rakam veya kısa çizgi içermeli, ilk iki veya son bir karakter olarak tire kullanamaz, ardışık tire içeremez ve 2 ile 60 karakter uzunluğunda olmalıdır.

type enum:

searchServices

Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdır.

CheckNameAvailabilityOutput

Denetim adı kullanılabilirlik API'sinin çıktısı.

Name Tür Description
message

string

Adın neden geçersiz olduğunu açıklayan ve kaynak adlandırma gereksinimleri sağlayan bir ileti. Yalnızca 'reason' özelliğinde 'Invalid' döndürülürse kullanılabilir.

nameAvailable

boolean

Adın kullanılabilir olup olmadığını gösteren değer.

reason

UnavailableNameReason

Adın kullanılamama nedeni. 'Geçersiz', sağlanan adın adlandırma gereksinimleriyle (yanlış uzunluk, desteklenmeyen karakterler vb.) eşleşmediğini gösterir. 'AlreadyExists' adın zaten kullanımda olduğunu ve bu nedenle kullanılamadığını gösterir.

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.

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

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

UnavailableNameReason

Adın kullanılamama nedeni. 'Geçersiz', sağlanan adın adlandırma gereksinimleriyle (yanlış uzunluk, desteklenmeyen karakterler vb.) eşleşmediğini gösterir. 'AlreadyExists' adın zaten kullanımda olduğunu ve bu nedenle kullanılamadığını gösterir.

Değer Description
Invalid

Arama hizmeti adı adlandırma gereksinimleriyle eşleşmiyor.

AlreadyExists

Arama hizmeti adı zaten farklı bir arama hizmetine atanmış.