Partager via


Communication Services - Check Name Availability

Vérifier la disponibilité du nom
Vérifie que le nom communicationService est valide et n’est pas déjà utilisé.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-04-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

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Obligatoire Type Description
name True

string

Nom de la ressource pour laquelle la disponibilité doit être vérifiée.

type True

string

Type de ressource.

Réponses

Nom Type Description
200 OK

CheckNameAvailabilityResponse

Succès. La réponse décrit la disponibilité du nom.

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Exemples

Check name availability available
Check name availability unavailable

Check name availability available

Exemple de requête

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-04-01

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

Exemple de réponse

{
  "nameAvailable": true,
  "reason": "NameAvailable",
  "message": "Requested name is available for the requested type"
}

Check name availability unavailable

Exemple de requête

POST https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/checkNameAvailability?api-version=2023-04-01

{
  "type": "Microsoft.Communication/CommunicationServices",
  "name": "MyCommunicationService"
}

Exemple de réponse

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Requested name is unavailable for the requested type"
}

Définitions

Nom Description
CheckNameAvailabilityReason

Raison pour laquelle le nom donné n’est pas disponible.

CheckNameAvailabilityResponse

Résultat de la vérification de la disponibilité.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

NameAvailabilityParameters

Données POST-ed à l’action nameAvailability

CheckNameAvailabilityReason

Raison pour laquelle le nom donné n’est pas disponible.

Nom Type Description
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

Résultat de la vérification de la disponibilité.

Nom Type Description
message

string

Raison détaillée pour laquelle le nom donné est disponible.

nameAvailable

boolean

Indique si le nom de la ressource est disponible.

reason

CheckNameAvailabilityReason

Raison pour laquelle le nom donné n’est pas disponible.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

NameAvailabilityParameters

Données POST-ed à l’action nameAvailability

Nom Type Description
name

string

Nom de la ressource pour laquelle la disponibilité doit être vérifiée.

type

string

Type de ressource.