Check Name Availability With Subscription - Check Name Availability With Subscription

Serviço:

CDN

Versão da API:

2025-04-15

Verifique a disponibilidade de um nome de recurso. Isso é necessário para recursos em que o nome é globalmente exclusivo, como um ponto de extremidade CDN.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome do recurso a validar.
type	True	ResourceType	O tipo do recurso cujo nome deve ser validado.

Respostas

Name	Tipo	Description
200 OK	CheckNameAvailabilityOutput	OK. O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Resposta de erro CDN descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

CheckNameAvailabilityWithSubscription

Pedido de amostra

HTTP

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

{
  "name": "sampleName",
  "type": "Microsoft.Cdn/Profiles/Endpoints"
}

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.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/CheckNameAvailabilityWithSubscription.json
// this example is just showing the usage of "CheckNameAvailabilityWithSubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
CdnNameAvailabilityContent content = new CdnNameAvailabilityContent("sampleName", CdnResourceType.Endpoints);
CdnNameAvailabilityResult result = await subscriptionResource.CheckCdnNameAvailabilityWithSubscriptionAsync(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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
CheckNameAvailabilityInput	Entrada da API CheckNameAvailability.
CheckNameAvailabilityOutput	Saída da API de disponibilidade de nome de verificação.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ResourceType	Tipo de recurso CDN usado em CheckNameAvailability.

CheckNameAvailabilityInput

Object

Entrada da API CheckNameAvailability.

Name	Tipo	Description
name	string	O nome do recurso a validar.
type	ResourceType	O tipo do recurso cujo nome deve ser validado.

CheckNameAvailabilityOutput

Object

Saída da API de disponibilidade de nome de verificação.

Name	Tipo	Description
message	string	A mensagem de erro detalhada que descreve por que o nome não está disponível.
nameAvailable	boolean	Indica se o nome está disponível.
reason	string	A razão pela qual o nome não está disponível.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ResourceType

Enumeração

Tipo de recurso CDN usado em CheckNameAvailability.

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