Services - Check Name Availability

Hizmet:: Search Management

API Sürümü:: 2023-11-01

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=2023-11-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
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 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	ResourceType	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	Ad denetimi tamamlandı. Yanıt, adın geçerli ve kullanılabilir olup olmadığına ilişkin ayrıntıları içerir. Ad geçersizse, yanıtta neden olmadığını açıklayan bir ileti de bulunur.
Other Status Codes	CloudError	HTTP 400 (Hatalı İstek): Verilen kaynak türü 'searchServices' değil.

Güvenlik

azure_auth

Microsoft Entra Id OAuth2 yetkilendirme 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

HTTP

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/checkNameAvailability?api-version=2023-11-01

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

Örnek yanıt

Durum kodu:: 200

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

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.
ResourceType	Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdı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

Nesne

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	ResourceType	Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdır.

CheckNameAvailabilityOutput

Nesne

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

Nesne

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

Nesne

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

ResourceType

Numaralandırma

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

Değer	Description
searchServices	Adı doğrulanabilen tek kaynak türü 'searchServices'tir.

UnavailableNameReason

Numaralandırma

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