Dela via


Communication Services - Check Name Availability

Kontrollera namntillgänglighet
Kontrollerar att Namnet på CommunicationService är giltigt och inte redan används.

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

URI-parametrar

Name I Obligatorisk Typ Description
subscriptionId
path True

string

uuid

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
name True

string

Namnet på den resurs som tillgängligheten måste kontrolleras för.

type True

string

Resurstypen.

Svar

Name Typ Description
200 OK

CheckNameAvailabilityResponse

Åtgärden lyckades. Svaret beskriver namnets tillgänglighet.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Exempel

Check name availability available
Check name availability unavailable

Check name availability available

Exempelbegäran

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

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

Exempelsvar

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

Check name availability unavailable

Exempelbegäran

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

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

Exempelsvar

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

Definitioner

Name Description
CheckNameAvailabilityReason

Anledningen till att det angivna namnet inte är tillgängligt.

CheckNameAvailabilityResponse

Kontrollera tillgänglighetsresultatet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

NameAvailabilityParameters

Post-ed-data till nameAvailability-åtgärden

CheckNameAvailabilityReason

Anledningen till att det angivna namnet inte är tillgängligt.

Name Typ Description
AlreadyExists

string

Invalid

string

CheckNameAvailabilityResponse

Kontrollera tillgänglighetsresultatet.

Name Typ Description
message

string

Detaljerad anledning till varför det angivna namnet är tillgängligt.

nameAvailable

boolean

Anger om resursnamnet är tillgängligt.

reason

CheckNameAvailabilityReason

Anledningen till att det angivna namnet inte är tillgängligt.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

NameAvailabilityParameters

Post-ed-data till nameAvailability-åtgärden

Name Typ Description
name

string

Namnet på den resurs som tillgängligheten måste kontrolleras för.

type

string

Resurstypen.