AFD Custom Domains - Get

Serviço:: Front Door Service

Versão da API:: 2025-04-15

Obtém um domínio existente do AzureFrontDoor com o nome de domínio especificado sob a assinatura, o grupo de recursos e o perfil especificados.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
customDomainName	path	True	string	Nome do domínio sob o perfil que é exclusivo globalmente.
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 dentro da assinatura do Azure.
subscriptionId	path	True	string	ID de Subscrição 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.

Respostas

Name	Tipo	Description
200 OK	AFDDomain	OK
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 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

AFDCustomDomains_Get

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1",
  "name": "domain1",
  "type": "Microsoft.Cdn/profiles/customdomains",
  "properties": {
    "profileName": "profile1",
    "hostName": "www.contoso.com",
    "tlsSettings": {
      "certificateType": "ManagedCertificate",
      "cipherSuiteSetType": "Customized",
      "minimumTlsVersion": "TLS12",
      "customizedCipherSuiteSet": {
        "cipherSuiteSetForTls12": [
          "ECDHE_RSA_AES128_GCM_SHA256"
        ],
        "cipherSuiteSetForTls13": [
          "TLS_AES_128_GCM_SHA256",
          "TLS_AES_256_GCM_SHA384"
        ]
      },
      "secret": {
        "id": ""
      }
    },
    "azureDnsZone": {
      "id": ""
    },
    "preValidatedCustomDomainResourceId": {
      "id": ""
    },
    "validationProperties": {
      "validationToken": "8c9912db-c615-4eeb-8465",
      "expirationDate": "2009-06-15T13:45:43.0000000Z"
    },
    "domainValidationState": "Pending",
    "provisioningState": "Updating",
    "deploymentStatus": "NotStarted"
  }
}

Definições

Name	Description
AfdCertificateType	Define a origem do certificado SSL.
AfdCipherSuiteSetType	tipo de conjunto de codificação que será usado para Https
AfdCustomizedCipherSuiteForTls12	Pacotes de codificação para TLS 1.2. Necessário pelo menos um no mínimoTlsVersion TLS 1.2.
AfdCustomizedCipherSuiteForTls13	Pacotes de codificação para TLS 1.3. Necessário pelo menos um no mínimoTlsVersion TLS 1.2, TLS 1.3.
AFDDomain	Mapeamento amigável de nome de domínio para o nome de host do ponto final que o cliente fornece para fins de marca, por exemplo. `www.contoso.com`
AFDDomainHttpsCustomizedCipherSuiteSet	Objeto de conjunto de conjunto de codificação personalizado que será usado para Https quando cipherSuiteSetType for Personalizado.
AFDDomainHttpsParameters	O objeto JSON que contém as propriedades para proteger um domínio.
AfdErrorResponse	Resposta de erro
AfdMinimumTlsVersion	Versão do protocolo TLS que será usada para Https quando cipherSuiteSetType for Customized.
AfdProvisioningState	Status de provisionamento
DeploymentStatus
DomainValidationProperties	O objeto JSON que contém as propriedades para validar um domínio.
DomainValidationState	O subestado de provisionamento mostra o progresso do processo de habilitação/desativação de HTTPS personalizado passo a passo. DCV significa DomainControlValidation.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
IdentityType	O tipo de identidade que cria/modifica recursos
ResourceReference	Referência a outro recurso.
SystemData	Dados do sistema somente leitura

AfdCertificateType

Enumeração

Define a origem do certificado SSL.

Valor	Description
CustomerCertificate
ManagedCertificate
AzureFirstPartyManagedCertificate

AfdCipherSuiteSetType

Enumeração

tipo de conjunto de codificação que será usado para Https

Valor	Description
Customized
TLS10_2019
TLS12_2022
TLS12_2023

AfdCustomizedCipherSuiteForTls12

Enumeração

Pacotes de codificação para TLS 1.2. Necessário pelo menos um no mínimoTlsVersion TLS 1.2.

Valor	Description
ECDHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES256_GCM_SHA384
DHE_RSA_AES256_GCM_SHA384
DHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES128_SHA256
ECDHE_RSA_AES256_SHA384

AfdCustomizedCipherSuiteForTls13

Enumeração

Pacotes de codificação para TLS 1.3. Necessário pelo menos um no mínimoTlsVersion TLS 1.2, TLS 1.3.

Valor	Description
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

AFDDomain

Object

Mapeamento amigável de nome de domínio para o nome de host do ponto final que o cliente fornece para fins de marca, por exemplo. www.contoso.com

Name	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.azureDnsZone	ResourceReference	Referência de recurso para a zona DNS do Azure
properties.deploymentStatus	DeploymentStatus
properties.domainValidationState	DomainValidationState	O subestado de provisionamento mostra o progresso do processo de habilitação/desativação de HTTPS personalizado passo a passo. DCV significa DomainControlValidation.
properties.extendedProperties	object	Key-Value par que representa propriedades de migração para domínios.
properties.hostName	string	O nome do host do domínio. Deve ser um nome de domínio.
properties.preValidatedCustomDomainResourceId	ResourceReference	Referência de recurso ao recurso do Azure onde a propriedade de domínio personalizado foi pré-validada
properties.profileName	string	O nome do perfil que contém o domínio.
properties.provisioningState	AfdProvisioningState	Status de provisionamento
properties.tlsSettings	AFDDomainHttpsParameters	A configuração que especifica como habilitar HTTPS para o domínio - usando o certificado gerenciado AzureFrontDoor ou o próprio certificado do usuário. Se não for especificado, habilitar o ssl usa o certificado gerenciado AzureFrontDoor por padrão.
properties.validationProperties	DomainValidationProperties	Valores que o cliente precisa para validar a propriedade do domínio
systemData	SystemData	Dados do sistema somente leitura
type	string	Tipo de recurso.

AFDDomainHttpsCustomizedCipherSuiteSet

Object

Objeto de conjunto de conjunto de codificação personalizado que será usado para Https quando cipherSuiteSetType for Personalizado.

Name	Tipo	Description
cipherSuiteSetForTls12	AfdCustomizedCipherSuiteForTls12[]	Pacotes de codificação para TLS 1.2. Necessário pelo menos um no mínimoTlsVersion TLS 1.2.
cipherSuiteSetForTls13	AfdCustomizedCipherSuiteForTls13[]	Pacotes de codificação para TLS 1.3. Necessário pelo menos um no mínimoTlsVersion TLS 1.2, TLS 1.3.

AFDDomainHttpsParameters

Object

O objeto JSON que contém as propriedades para proteger um domínio.

Name	Tipo	Description
certificateType	AfdCertificateType	Define a origem do certificado SSL.
cipherSuiteSetType	AfdCipherSuiteSetType	tipo de conjunto de codificação que será usado para Https
customizedCipherSuiteSet	AFDDomainHttpsCustomizedCipherSuiteSet	Objeto de pacotes de codificação personalizados que será usado para Https quando cipherSuiteSetType for Personalizado.
minimumTlsVersion	AfdMinimumTlsVersion	Versão do protocolo TLS que será usada para Https quando cipherSuiteSetType for Customized.
secret	ResourceReference	Referência de recurso ao segredo. ou seja. subs/rg/perfil/segredo

AfdErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

AfdMinimumTlsVersion

Enumeração

Versão do protocolo TLS que será usada para Https quando cipherSuiteSetType for Customized.

Valor	Description
TLS10
TLS12
TLS13

AfdProvisioningState

Enumeração

Status de provisionamento

Valor	Description
Succeeded
Failed
Updating
Deleting
Creating

DeploymentStatus

Enumeração

Valor	Description
NotStarted
InProgress
Succeeded
Failed

DomainValidationProperties

Object

O objeto JSON que contém as propriedades para validar um domínio.

Name	Tipo	Description
expirationDate	string	A data e hora em que o token expira
validationToken	string	Desafio usado para registro TXT DNS ou validação baseada em arquivo

DomainValidationState

Enumeração

O subestado de provisionamento mostra o progresso do processo de habilitação/desativação de HTTPS personalizado passo a passo. DCV significa DomainControlValidation.

Valor	Description
Unknown
Submitting
Pending
Rejected
TimedOut
PendingRevalidation
Approved
RefreshingValidationToken
InternalError

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.

IdentityType

Enumeração

O tipo de identidade que cria/modifica recursos

Valor	Description
user
application
managedIdentity
key

ResourceReference

Object

Referência a outro recurso.

Name	Tipo	Description
id	string	ID do recurso.

SystemData

Object

Dados do sistema somente leitura

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC)
createdBy	string	Um identificador para a identidade que criou o recurso
createdByType	IdentityType	O tipo de identidade que criou o recurso
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	Um identificador para a identidade que modificou o recurso pela última vez
lastModifiedByType	IdentityType	O tipo de identidade que modificou o recurso pela última vez

Partilhar via

AFD Custom Domains - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

AFDCustomDomains_Get

Pedido de amostra

Resposta da amostra

Definições

AfdCertificateType

AfdCipherSuiteSetType

AfdCustomizedCipherSuiteForTls12

AfdCustomizedCipherSuiteForTls13

AFDDomain

AFDDomainHttpsCustomizedCipherSuiteSet

AFDDomainHttpsParameters

AfdErrorResponse

AfdMinimumTlsVersion

AfdProvisioningState

DeploymentStatus

DomainValidationProperties

DomainValidationState

ErrorAdditionalInfo

ErrorDetail

IdentityType

ResourceReference

SystemData