Services - Check Name Availability

Service:: Search Management

Version d’API:: 2025-05-01

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=2025-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

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	enum: searchServices	Type de la ressource dont le nom doit être validé. Cette valeur doit toujours être « searchServices ».

Réponses

Nom	Type	Description
200 OK	CheckNameAvailabilityOutput	La demande a réussi.
Other Status Codes	CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

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

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

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/SearchCheckNameAvailability.json
func ExampleServicesClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().CheckNameAvailability(ctx, armsearch.CheckNameAvailabilityInput{
		Name: to.Ptr("mysearchservice"),
		Type: to.Ptr("searchServices"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.ServicesClientCheckNameAvailabilityResponse{
	// 	CheckNameAvailabilityOutput: &armsearch.CheckNameAvailabilityOutput{
	// 		Message: to.Ptr(""),
	// 		IsNameAvailable: to.Ptr(false),
	// 		Reason: to.Ptr(armsearch.UnavailableNameReasonAlreadyExists),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

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

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.
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	enum: searchServices	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).

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.