AFD Profiles - Check Host Name Availability

Serviço:

Front Door Service

Versão da API:

2025-04-15

Valida o mapeamento de domínio personalizado para garantir que ele seja mapeado para o ponto de extremidade correto do Azure Front Door no DNS.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Nome do Azure Front Door Standard ou Azure Front Door Premium, que é exclusivo dentro do grupo de recursos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nome do grupo de recursos na assinatura do Azure.
subscriptionId	path	True	string	ID de assinatura do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2025-04-15.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
hostName	True	string	O nome do host a ser validado.

Respostas

Nome	Tipo	Description
200 OK	CheckNameAvailabilityOutput	OKEY. The request has succeeded.
Other Status Codes	AfdErrorResponse	Resposta de erro do Azure Front Door descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

AFDProfiles_CheckHostNameAvailability

Solicitação de exemplo

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/checkHostNameAvailability?api-version=2025-04-15

{
  "hostName": "www.someDomain.net"
}

Resposta de exemplo

Código de status:

200

{
  "nameAvailable": false,
  "reason": "Conflict",
  "message": "The hostname 'www.someDomain.net' is already owned by another profile."
}

Definições

Nome	Description
AfdErrorResponse	Resposta de erro
CheckHostNameAvailabilityInput	Entrada da API CheckHostNameAvailability.
CheckNameAvailabilityOutput	Saída da API de disponibilidade de nome de verificação.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.

AfdErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

CheckHostNameAvailabilityInput

Objeto

Entrada da API CheckHostNameAvailability.

Nome	Tipo	Description
hostName	string	O nome do host a ser validado.

CheckNameAvailabilityOutput

Objeto

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

Nome	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	O motivo pelo qual o nome não está disponível.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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.