Check Endpoint Name Availability - Check Endpoint Name Availability

Servizio:

Front Door Service

Versione API:

2025-04-15

Controllare la disponibilità di un nome di risorsa. Questa operazione è necessaria per le risorse in cui il nome è globalmente univoco, ad esempio un endpoint afdx.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/checkEndpointNameAvailability?api-version=2025-04-15

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId	path	True	string	ID sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione corrente è 2025-04-15.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
name	True	string	Nome della risorsa da convalidare.
type	True	ResourceType	Tipo della risorsa il cui nome deve essere convalidato.
autoGeneratedDomainNameLabelScope		AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.

Risposte

Nome	Tipo	Descrizione
200 OK	CheckEndpointNameAvailabilityOutput	OK. The request has succeeded.
Other Status Codes	AfdErrorResponse	Risposta di errore di Frontdoor di Azure che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

CheckEndpointNameAvailability

Esempio di richiesta

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/myResourceGroup/providers/Microsoft.Cdn/checkEndpointNameAvailability?api-version=2025-04-15

{
  "name": "sampleName",
  "type": "Microsoft.Cdn/Profiles/AfdEndpoints",
  "autoGeneratedDomainNameLabelScope": "TenantReuse"
}

Risposta di esempio

Codice di stato:

200

{
  "nameAvailable": false,
  "reason": "Name is already in use",
  "message": "Name not available",
  "availableHostname": ""
}

Definizioni

Nome	Descrizione
AfdErrorResponse	Risposta di errore
AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.
CheckEndpointNameAvailabilityInput	Input dell'API CheckNameAvailability.
CheckEndpointNameAvailabilityOutput	Output dell'API di disponibilità del nome check.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ResourceType	Tipo di risorsa della rete CDN usata in CheckNameAvailability.

AfdErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

AutoGeneratedDomainNameLabelScope

Enumerazione

Indicates the endpoint name reuse scope. The default value is TenantReuse.

Valore	Descrizione
NoReuse
ResourceGroupReuse
SubscriptionReuse
TenantReuse

CheckEndpointNameAvailabilityInput

Object

Input dell'API CheckNameAvailability.

Nome	Tipo	Descrizione
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.
name	string	Nome della risorsa da convalidare.
type	ResourceType	Tipo della risorsa il cui nome deve essere convalidato.

CheckEndpointNameAvailabilityOutput

Object

Output dell'API di disponibilità del nome check.

Nome	Tipo	Descrizione
availableHostname	string	Restituisce il nome host disponibile generato in base a AutoGeneratedDomainNameLabelScope quando il nome è disponibile; in caso contrario, restituisce una stringa vuota
message	string	Messaggio di errore dettagliato che descrive il motivo per cui il nome non è disponibile.
nameAvailable	boolean	Indica se il nome è disponibile.
reason	string	Motivo per cui il nome non è disponibile.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ResourceType

Enumerazione

Tipo di risorsa della rete CDN usata in CheckNameAvailability.

Valore	Descrizione
Microsoft.Cdn/Profiles/AfdEndpoints
Microsoft.Cdn/Profiles/Endpoints