Compartilhar via


AFD Custom Domains - Get

Obtém um domínio existente do AzureFrontDoor com o nome de domínio especificado na assinatura, no grupo de recursos e no 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 de URI

Nome Em Obrigatório Tipo Description
customDomainName
path True

string

Nome do domínio no 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 na assinatura do Azure.

subscriptionId
path True

string

ID da 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.

Respostas

Nome Tipo Description
200 OK

AFDDomain

OKEY

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

AFDCustomDomains_Get

Solicitação de exemplo

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

Resposta de exemplo

{
  "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

Nome Description
AfdCertificateType

Define a origem do certificado SSL.

AfdCipherSuiteSetType

tipo de conjunto de criptografias que será usado para Https

AfdCustomizedCipherSuiteForTls12

Pacotes de criptografia para TLS 1.2. Necessário pelo menos um no mínimo TLS 1.2 doTlsVersion.

AfdCustomizedCipherSuiteForTls13

Pacotes de criptografia para TLS 1.3. Exigido pelo menos um no mínimo TLS 1.2, TLS 1.3.

AFDDomain

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

AFDDomainHttpsCustomizedCipherSuiteSet

Objeto de conjunto de criptografia 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 Personalizado.

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 da habilitação/desabilitação do processo HTTPS personalizado passo a passo. DCV significa DomainControlValidation.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

IdentityType

O tipo de identidade que cria/modifica recursos

ResourceReference

Referência a outro recurso.

SystemData

Ler somente dados do sistema

AfdCertificateType

Define a origem do certificado SSL.

Valor Description
AzureFirstPartyManagedCertificate
CustomerCertificate
ManagedCertificate

AfdCipherSuiteSetType

tipo de conjunto de criptografias que será usado para Https

Valor Description
Customized
TLS10_2019
TLS12_2022
TLS12_2023

AfdCustomizedCipherSuiteForTls12

Pacotes de criptografia para TLS 1.2. Necessário pelo menos um no mínimo TLS 1.2 doTlsVersion.

Valor Description
DHE_RSA_AES128_GCM_SHA256
DHE_RSA_AES256_GCM_SHA384
ECDHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES128_SHA256
ECDHE_RSA_AES256_GCM_SHA384
ECDHE_RSA_AES256_SHA384

AfdCustomizedCipherSuiteForTls13

Pacotes de criptografia para TLS 1.3. Exigido pelo menos um no mínimo TLS 1.2, TLS 1.3.

Valor Description
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

AFDDomain

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

Nome 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 da habilitação/desabilitação do processo HTTPS personalizado passo a passo. DCV significa DomainControlValidation.

properties.extendedProperties

object

Key-Value par que representa as 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 para o recurso do Azure em que a propriedade de domínio personalizada foi pré-avaliada

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 do AzureFrontDoor ou o próprio certificado do usuário. Se não for especificado, a habilitação do SSL usará o certificado gerenciado do AzureFrontDoor por padrão.

properties.validationProperties

DomainValidationProperties

Valores que o cliente precisa para validar a propriedade do domínio

systemData

SystemData

Ler somente dados do sistema

type

string

Tipo de recurso.

AFDDomainHttpsCustomizedCipherSuiteSet

Objeto de conjunto de criptografia personalizado que será usado para Https quando cipherSuiteSetType for Personalizado.

Nome Tipo Description
cipherSuiteSetForTls12

AfdCustomizedCipherSuiteForTls12[]

Pacotes de criptografia para TLS 1.2. Necessário pelo menos um no mínimo TLS 1.2 doTlsVersion.

cipherSuiteSetForTls13

AfdCustomizedCipherSuiteForTls13[]

Pacotes de criptografia para TLS 1.3. Exigido pelo menos um no mínimo TLS 1.2, TLS 1.3.

AFDDomainHttpsParameters

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

Nome Tipo Description
certificateType

AfdCertificateType

Define a origem do certificado SSL.

cipherSuiteSetType

AfdCipherSuiteSetType

tipo de conjunto de criptografias que será usado para Https

customizedCipherSuiteSet

AFDDomainHttpsCustomizedCipherSuiteSet

Objeto de conjuntos de criptografia personalizado que será usado para Https quando cipherSuiteSetType for Personalizado.

minimumTlsVersion

AfdMinimumTlsVersion

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

secret

ResourceReference

Referência de recurso ao segredo. Ie. subs/rg/profile/secret

AfdErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

AfdMinimumTlsVersion

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

Valor Description
TLS10
TLS12
TLS13

AfdProvisioningState

Status de provisionamento

Valor Description
Creating
Deleting
Failed
Succeeded
Updating

DeploymentStatus

Valor Description
Failed
InProgress
NotStarted
Succeeded

DomainValidationProperties

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

Nome Tipo Description
expirationDate

string

A hora da data em que o token expira

validationToken

string

Desafio usado para registro TXT DNS ou validação baseada em arquivo

DomainValidationState

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

Valor Description
Approved
InternalError
Pending
PendingRevalidation
RefreshingValidationToken
Rejected
Submitting
TimedOut
Unknown

ErrorAdditionalInfo

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

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.

IdentityType

O tipo de identidade que cria/modifica recursos

Valor Description
application
key
managedIdentity
user

ResourceReference

Referência a outro recurso.

Nome Tipo Description
id

string

ID do recurso.

SystemData

Ler somente dados do sistema

Nome 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