Check Endpoint Name Availability - Check Endpoint Name Availability

Servicio:

Front Door Service

Versión de la API:

2025-04-15

Comprobar la disponibilidad de un nombre de recurso. Esto es necesario para los recursos en los que el nombre es único globalmente, como un punto de conexión afdx.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre del recurso que se va a validar.
type	True	ResourceType	Tipo del recurso cuyo nombre se va a validar.
autoGeneratedDomainNameLabelScope		AutoGeneratedDomainNameLabelScope	Indica el ámbito de reutilización del nombre del punto de conexión. El valor predeterminado es TenantReuse.

Respuestas

Nombre	Tipo	Description
200 OK	CheckEndpointNameAvailabilityOutput	De acuerdo. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error de Azure Front Door que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

CheckEndpointNameAvailability

Solicitud de ejemplo

HTTP

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

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/CheckEndpointNameAvailability.json
// this example is just showing the usage of "CheckEndpointNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "myResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation
EndpointNameAvailabilityContent content = new EndpointNameAvailabilityContent("sampleName", CdnResourceType.FrontDoorEndpoints)
{
    AutoGeneratedDomainNameLabelScope = DomainNameLabelScope.TenantReuse,
};
EndpointNameAvailabilityResult result = await resourceGroupResource.CheckEndpointNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
AutoGeneratedDomainNameLabelScope	Indica el ámbito de reutilización del nombre del punto de conexión. El valor predeterminado es TenantReuse.
CheckEndpointNameAvailabilityInput	Entrada de CheckNameAvailability API.
CheckEndpointNameAvailabilityOutput	Salida de check name availability API.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ResourceType	Tipo de recurso de CDN usado en CheckNameAvailability.

AutoGeneratedDomainNameLabelScope

Enumeración

Indica el ámbito de reutilización del nombre del punto de conexión. El valor predeterminado es TenantReuse.

Valor	Description
NoReuse
ResourceGroupReuse
SubscriptionReuse
TenantReuse

CheckEndpointNameAvailabilityInput

Object

Entrada de CheckNameAvailability API.

Nombre	Tipo	Description
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	Indica el ámbito de reutilización del nombre del punto de conexión. El valor predeterminado es TenantReuse.
name	string	Nombre del recurso que se va a validar.
type	ResourceType	Tipo del recurso cuyo nombre se va a validar.

CheckEndpointNameAvailabilityOutput

Object

Salida de check name availability API.

Nombre	Tipo	Description
availableHostname	string	Devuelve el nombre de host disponible generado en función de AutoGeneratedDomainNameLabelScope cuando el nombre está disponible; de lo contrario, devuelve una cadena vacía.
message	string	Mensaje de error detallado que describe por qué el nombre no está disponible.
nameAvailable	boolean	Indica si el nombre está disponible.
reason	string	Motivo por el que el nombre no está disponible.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ResourceType

Enumeración

Tipo de recurso de CDN usado en CheckNameAvailability.

Valor	Description
Microsoft.Cdn/Profiles/AfdEndpoints
Microsoft.Cdn/Profiles/Endpoints