AFD Custom Domains - Get

Служба:: Front Door Service

Версия API:: 2025-04-15

Возвращает существующий домен AzureFrontDoor с указанным доменным именем в указанной подписке, группе ресурсов и профиле.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
customDomainName	path	True	string	Имя домена в профиле, уникальное глобально.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Имя Azure Front Door Standard или Azure Front Door Premium, уникальное в группе ресурсов.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Имя группы ресурсов в подписке Azure.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования с клиентским запросом. Текущая версия — 2025-04-15.

Ответы

Имя	Тип	Описание
200 OK	AFDDomain	ХОРОШО
Other Status Codes	AfdErrorResponse	Ответ об ошибке Azure Front Door, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

AFDCustomDomains_Get

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
  }
}

Определения

Имя	Описание
AfdCertificateType	Определяет источник SSL-сертификата.
AfdCipherSuiteSetType	Тип набора шифров, который будет использоваться для Https
AfdCustomizedCipherSuiteForTls12	Наборы шифров для TLS 1.2. Требуется по крайней мере один в минимуме TLS 1.2TlsVersion.
AfdCustomizedCipherSuiteForTls13	Наборы шифров для TLS 1.3. Требуется по крайней мере один в минимальном протоколе TLS 1.2, TLS 1.3.
AFDDomain	Дружественное сопоставление доменного имени с именем хоста конечной точки, которое клиент предоставляет для целей брендинга, например, `www.contoso.com`.
AFDDomainHttpsCustomizedCipherSuiteSet	Настроенный объект набора шифров, который будет использоваться для Https при настройке cipherSuiteSetType.
AFDDomainHttpsParameters	Объект JSON, содержащий свойства для защиты домена.
AfdErrorResponse	Ответ на ошибку
AfdMinimumTlsVersion	Версия протокола TLS, которая будет использоваться для https при настройке cipherSuiteSetType.
AfdProvisioningState	Состояние обеспечения
DeploymentStatus
DomainValidationProperties	Объект JSON, содержащий свойства для проверки домена.
DomainValidationState	Подсостояние подготовки показывает ход выполнения пользовательского процесса включения и отключения HTTPS пошаговые шаги. DCV — domainControlValidation.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
IdentityType	Тип удостоверения, создающего или изменяющего ресурсы
ResourceReference	Ссылка на другой ресурс.
SystemData	Чтение только системных данных

AfdCertificateType

Перечисление

Определяет источник SSL-сертификата.

Значение	Описание
CustomerCertificate
ManagedCertificate
AzureFirstPartyManagedCertificate

AfdCipherSuiteSetType

Перечисление

Тип набора шифров, который будет использоваться для Https

Значение	Описание
Customized
TLS10_2019
TLS12_2022
TLS12_2023

AfdCustomizedCipherSuiteForTls12

Перечисление

Наборы шифров для TLS 1.2. Требуется по крайней мере один в минимуме TLS 1.2TlsVersion.

Значение	Описание
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

Перечисление

Наборы шифров для TLS 1.3. Требуется по крайней мере один в минимальном протоколе TLS 1.2, TLS 1.3.

Значение	Описание
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

AFDDomain

Object

Дружественное сопоставление доменного имени с именем хоста конечной точки, которое клиент предоставляет для целей брендинга, например, www.contoso.com.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.azureDnsZone	ResourceReference	Ссылка на ресурс в зону Azure DNS
properties.deploymentStatus	DeploymentStatus
properties.domainValidationState	DomainValidationState	Подсостояние подготовки показывает ход выполнения пользовательского процесса включения и отключения HTTPS пошаговые шаги. DCV — domainControlValidation.
properties.extendedProperties	object	Key-Value пара, представляющая свойства миграции для доменов.
properties.hostName	string	Имя узла домена. Должно быть доменным именем.
properties.preValidatedCustomDomainResourceId	ResourceReference	Ссылка на ресурс Azure, на который была предварительно оценена владение личным доменом
properties.profileName	string	Имя профиля, в котором хранится домен.
properties.provisioningState	AfdProvisioningState	Состояние обеспечения
properties.tlsSettings	AFDDomainHttpsParameters	Конфигурация, указывающая, как включить HTTPS для домена с помощью управляемого сертификата AzureFrontDoor или собственного сертификата пользователя. Если это не указано, включение ssl использует управляемый сертификат AzureFrontDoor по умолчанию.
properties.validationProperties	DomainValidationProperties	Значения, которые клиент должен проверить владение доменом
systemData	SystemData	Чтение только системных данных
type	string	Тип ресурса.

AFDDomainHttpsCustomizedCipherSuiteSet

Object

Настроенный объект набора шифров, который будет использоваться для Https при настройке cipherSuiteSetType.

Имя	Тип	Описание
cipherSuiteSetForTls12	AfdCustomizedCipherSuiteForTls12[]	Наборы шифров для TLS 1.2. Требуется по крайней мере один в минимуме TLS 1.2TlsVersion.
cipherSuiteSetForTls13	AfdCustomizedCipherSuiteForTls13[]	Наборы шифров для TLS 1.3. Требуется по крайней мере один в минимальном протоколе TLS 1.2, TLS 1.3.

AFDDomainHttpsParameters

Object

Объект JSON, содержащий свойства для защиты домена.

Имя	Тип	Описание
certificateType	AfdCertificateType	Определяет источник SSL-сертификата.
cipherSuiteSetType	AfdCipherSuiteSetType	Тип набора шифров, который будет использоваться для Https
customizedCipherSuiteSet	AFDDomainHttpsCustomizedCipherSuiteSet	Настроенный объект наборов шифров, который будет использоваться для Https при настройке cipherSuiteSetType.
minimumTlsVersion	AfdMinimumTlsVersion	Версия протокола TLS, которая будет использоваться для https при настройке cipherSuiteSetType.
secret	ResourceReference	Ссылка на ресурс секрета. т. е. subs/rg/profile/secret

AfdErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

AfdMinimumTlsVersion

Перечисление

Версия протокола TLS, которая будет использоваться для https при настройке cipherSuiteSetType.

Значение	Описание
TLS10
TLS12
TLS13

AfdProvisioningState

Перечисление

Состояние обеспечения

Значение	Описание
Succeeded
Failed
Updating
Deleting
Creating

DeploymentStatus

Перечисление

Значение	Описание
NotStarted
InProgress
Succeeded
Failed

DomainValidationProperties

Object

Объект JSON, содержащий свойства для проверки домена.

Имя	Тип	Описание
expirationDate	string	Дата истечения срока действия маркера
validationToken	string	Проблема, используемая для записи DNS TXT или проверки на основе файлов

DomainValidationState

Перечисление

Подсостояние подготовки показывает ход выполнения пользовательского процесса включения и отключения HTTPS пошаговые шаги. DCV — domainControlValidation.

Значение	Описание
Unknown
Submitting
Pending
Rejected
TimedOut
PendingRevalidation
Approved
RefreshingValidationToken
InternalError

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

IdentityType

Перечисление

Тип удостоверения, создающего или изменяющего ресурсы

Значение	Описание
user
application
managedIdentity
key

ResourceReference

Object

Ссылка на другой ресурс.

Имя	Тип	Описание
id	string	Идентификатор ресурса.

SystemData

Object

Чтение только системных данных

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC)
createdBy	string	Идентификатор удостоверения, создавшего ресурс
createdByType	IdentityType	Тип удостоверения, создавшего ресурс
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор удостоверения, который последний раз изменил ресурс
lastModifiedByType	IdentityType	Тип удостоверения, который последний раз изменил ресурс

Поделиться через

AFD Custom Domains - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

AFDCustomDomains_Get

Образец запроса

Пример ответа

Определения

AfdCertificateType

AfdCipherSuiteSetType

AfdCustomizedCipherSuiteForTls12

AfdCustomizedCipherSuiteForTls13

AFDDomain

AFDDomainHttpsCustomizedCipherSuiteSet

AFDDomainHttpsParameters

AfdErrorResponse

AfdMinimumTlsVersion

AfdProvisioningState

DeploymentStatus

DomainValidationProperties

DomainValidationState

ErrorAdditionalInfo

ErrorDetail

IdentityType

ResourceReference

SystemData