Partager via


Services - Check Name Availability

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

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

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, des outils en ligne de commande 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 demande. S’il est spécifié, il est inclus dans les informations de réponse afin de suivre la demande.

Corps de la demande

Nom Obligatoire Type Description
name True

string

Nom du service de recherche à valider. service Search noms doivent contenir uniquement des lettres minuscules, des chiffres ou des tirets, ne peuvent pas utiliser le tiret comme les deux premiers ou derniers caractères, ne peuvent pas contenir de tirets consécutifs et doivent comporter 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

Le nom case activée terminé. La réponse indique si le nom est valide et disponible. 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

Microsoft Entra ID flux d’autorisation OAuth2.

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

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

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

Exemple de réponse

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

Définitions

Nom Description
CheckNameAvailabilityInput

Entrée de case activée’API de disponibilité du nom.

CheckNameAvailabilityOutput

Sortie de case activée’API de disponibilité de nom.

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. « Non valide » 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

Entrée de case activée’API de disponibilité du nom.

Nom Type Description
name

string

Nom du service de recherche à valider. service Search noms doivent contenir uniquement des lettres minuscules, des chiffres ou des tirets, ne peuvent pas utiliser le tiret comme les deux premiers ou derniers caractères, ne peuvent pas contenir de tirets consécutifs et doivent comporter 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

Sortie de case activée’API de disponibilité de nom.

Nom Type Description
message

string

Message qui explique pourquoi le nom n’est pas valide et fournit les exigences de nommage des ressources. Disponible uniquement si « Invalid » 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. « Non valide » 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

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.

CloudErrorBody

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 status 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 l’erreur en détail et fournit des informations de débogage.

target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

ResourceType

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

Nom Type Description
searchServices

string

'searchServices' est le seul type de ressource dont le nom peut être validé.

UnavailableNameReason

Raison pour laquelle le nom n’est pas disponible. « Non valide » 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.

Nom Type Description
AlreadyExists

string

Le nom du service de recherche est déjà attribué à un autre service de recherche.

Invalid

string

Le nom du service de recherche ne correspond pas aux exigences de nommage.