Services - Check Name Availability

Service:: Search Management

Version d’API:: 2024-03-01-preview

Vérifie si le nom du service de recherche donné est disponible ou non. Les noms de service de recherche doivent être uniques à l’échelle mondiale, car ils font partie de l’URI du service (https://< nom.search.windows.net>).

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
api-version	query	True	string	Version de l’API à utiliser pour chaque requête.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	Valeur GUID générée par le client qui identifie cette requête. S’il est spécifié, cela sera inclus dans les informations de réponse comme moyen de suivre la demande.

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom du service de recherche à valider. Les noms de service de recherche ne doivent contenir que des lettres minuscules, des chiffres ou des tirets, ne peuvent pas utiliser de tirets comme premiers ou derniers caractères, ne peuvent pas contenir de tirets consécutifs et doivent être compris entre 2 et 60 caractères.
type	True	ResourceType	Type de la ressource dont le nom doit être validé. Cette valeur doit toujours être « searchServices ».

Réponses

Nom	Type	Description
200 OK	CheckNameAvailabilityOutput	Vérification du nom terminée. La réponse contient des détails sur la validité et la disponibilité du nom. Si le nom n’est pas valide, la réponse contient également un message expliquant pourquoi pas.
Other Status Codes	CloudError	HTTP 400 (requête incorrecte) : le type de ressource donné n’est pas « searchServices ».

Sécurité

azure_auth

Spécifie un flux d’octroi implicite, tel qu’il est pris en charge sur la plateforme Microsoft Identity.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

SearchCheckNameAvailability

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
CheckNameAvailabilityInput	Entrée de l’API de disponibilité du nom de vérification.
CheckNameAvailabilityOutput	Sortie de l’API de disponibilité du nom de vérification.
CloudError	Contient des informations sur une erreur d’API.
CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
ResourceType	Type de la ressource dont le nom doit être validé. Cette valeur doit toujours être « searchServices ».
UnavailableNameReason	Raison pour laquelle le nom n’est pas disponible. 'Invalid' indique que le nom fourni ne correspond pas aux exigences de nommage (longueur incorrecte, caractères non pris en charge, etc.). 'AlreadyExists' indique que le nom est déjà utilisé et n’est donc pas disponible.

CheckNameAvailabilityInput

Objet

Entrée de l’API de disponibilité du nom de vérification.

Nom	Type	Description
name	string	Nom du service de recherche à valider. Les noms de service de recherche ne doivent contenir que des lettres minuscules, des chiffres ou des tirets, ne peuvent pas utiliser de tirets comme premiers ou derniers caractères, ne peuvent pas contenir de tirets consécutifs et doivent être compris entre 2 et 60 caractères.
type	ResourceType	Type de la ressource dont le nom doit être validé. Cette valeur doit toujours être « searchServices ».

CheckNameAvailabilityOutput

Objet

Sortie de l’API de disponibilité du nom de vérification.

Nom	Type	Description
message	string	Message expliquant pourquoi le nom n’est pas valide et fournit des exigences de nommage des ressources. Disponible uniquement si « Non valide » est retourné dans la propriété « reason ».
nameAvailable	boolean	Valeur indiquant si le nom est disponible.
reason	UnavailableNameReason	Raison pour laquelle le nom n’est pas disponible. 'Invalid' indique que le nom fourni ne correspond pas aux exigences de nommage (longueur incorrecte, caractères non pris en charge, etc.). 'AlreadyExists' indique que le nom est déjà utilisé et n’est donc pas disponible.

CloudError

Objet

Contient des informations sur une erreur d’API.

Nom	Type	Description
error	CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
message	string	Brève description de l’erreur qui indique ce qui s’est passé (pour plus d’informations/débogage, reportez-vous à la propriété « error.message »).

CloudErrorBody

Objet

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code d’état HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	CloudErrorBody[]	Contient des erreurs imbriquées liées à cette erreur.
message	string	Message qui décrit en détail l’erreur et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

ResourceType

Énumération

Type de la ressource dont le nom doit être validé. Cette valeur doit toujours être « searchServices ».

Valeur	Description
searchServices	« searchServices » est le seul type de ressource dont le nom peut être validé.

UnavailableNameReason

Énumération

Raison pour laquelle le nom n’est pas disponible. 'Invalid' indique que le nom fourni ne correspond pas aux exigences de nommage (longueur incorrecte, caractères non pris en charge, etc.). 'AlreadyExists' indique que le nom est déjà utilisé et n’est donc pas disponible.

Valeur	Description
Invalid	Le nom du service de recherche ne correspond pas aux exigences de nommage.
AlreadyExists	Le nom du service de recherche est déjà attribué à un autre service de recherche.