Delen via


Communication Services - Check Name Availability

Beschikbaarheid van naam controleren
Controleert of de CommunicationService-naam geldig is en nog niet in gebruik is.

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

URI-parameters

Name In Vereist Type Description
subscriptionId
path True

string (uuid)

De id van het doelabonnement. De waarde moet een UUID zijn.

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
name True

string

De naam van de resource waarvoor de beschikbaarheid moet worden gecontroleerd.

type True

string

Het resourcetype.

Antwoorden

Name Type Description
200 OK

CheckNameAvailabilityResponse

Succes. In het antwoord wordt de beschikbaarheid van de naam beschreven.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

Check name availability available
Check name availability unavailable

Check name availability available

Voorbeeldaanvraag

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"
}

Voorbeeldrespons

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

Check name availability unavailable

Voorbeeldaanvraag

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"
}

Voorbeeldrespons

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

Definities

Name Description
CheckNameAvailabilityReason

De reden waarom de opgegeven naam niet beschikbaar is.

CheckNameAvailabilityResponse

Het resultaat van de beschikbaarheid controleren.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

NameAvailabilityParameters

Gegevens die zijn verzonden naar de actie NameAvailability

CheckNameAvailabilityReason

De reden waarom de opgegeven naam niet beschikbaar is.

Waarde Description
AlreadyExists
Invalid

CheckNameAvailabilityResponse

Het resultaat van de beschikbaarheid controleren.

Name Type Description
message

string

Gedetailleerde reden waarom de opgegeven naam beschikbaar is.

nameAvailable

boolean

Geeft aan of de resourcenaam beschikbaar is.

reason

CheckNameAvailabilityReason

De reden waarom de opgegeven naam niet beschikbaar is.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

NameAvailabilityParameters

Gegevens die zijn verzonden naar de actie NameAvailability

Name Type Description
name

string

De naam van de resource waarvoor de beschikbaarheid moet worden gecontroleerd.

type

string

Het resourcetype.