AFD Custom Domains - Get

Service:

Front Door Service

API Version:

2023-05-01

Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

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

URI Parameters

Name	In	Required	Type	Description
customDomainName	path	True	string	Name of the domain under the profile which is unique globally.
profileName	path	True	string	Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2023-05-01.

Responses

Name	Type	Description
200 OK	AFDDomain	OK
Other Status Codes	AfdErrorResponse	Azure Front Door error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

AFDCustomDomains_Get

Sample request

HTTP

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

Sample response

Status code:

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",
      "minimumTlsVersion": "TLS12",
      "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"
  }
}

Definitions

Name	Description
AfdCertificateType	Defines the source of the SSL certificate.
AFDDomain	Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.
AFDDomainHttpsParameters	The JSON object that contains the properties to secure a domain.
AfdErrorResponse	Error response
AfdMinimumTlsVersion	TLS protocol version that will be used for Https
AfdProvisioningState	Provisioning status
DeploymentStatus
DomainValidationProperties	The JSON object that contains the properties to validate a domain.
DomainValidationState	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
IdentityType	The type of identity that creates/modifies resources
ResourceReference	Reference to another resource.
SystemData	Read only system data

AfdCertificateType

Defines the source of the SSL certificate.

Name	Type	Description
AzureFirstPartyManagedCertificate	string
CustomerCertificate	string
ManagedCertificate	string

AFDDomain

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.azureDnsZone	ResourceReference	Resource reference to the Azure DNS zone
properties.deploymentStatus	DeploymentStatus
properties.domainValidationState	DomainValidationState	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
properties.extendedProperties	object	Key-Value pair representing migration properties for domains.
properties.hostName	string	The host name of the domain. Must be a domain name.
properties.preValidatedCustomDomainResourceId	ResourceReference	Resource reference to the Azure resource where custom domain ownership was prevalidated
properties.profileName	string	The name of the profile which holds the domain.
properties.provisioningState	AfdProvisioningState	Provisioning status
properties.tlsSettings	AFDDomainHttpsParameters	The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
properties.validationProperties	DomainValidationProperties	Values the customer needs to validate domain ownership
systemData	SystemData	Read only system data
type	string	Resource type.

AFDDomainHttpsParameters

The JSON object that contains the properties to secure a domain.

Name	Type	Description
certificateType	AfdCertificateType	Defines the source of the SSL certificate.
minimumTlsVersion	AfdMinimumTlsVersion	TLS protocol version that will be used for Https
secret	ResourceReference	Resource reference to the secret. ie. subs/rg/profile/secret

AfdErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

AfdMinimumTlsVersion

TLS protocol version that will be used for Https

Name	Type	Description
TLS10	string
TLS12	string

AfdProvisioningState

Provisioning status

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

DeploymentStatus

Name	Type	Description
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

DomainValidationProperties

The JSON object that contains the properties to validate a domain.

Name	Type	Description
expirationDate	string	The date time that the token expires
validationToken	string	Challenge used for DNS TXT record or file based validation

DomainValidationState

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.

Name	Type	Description
Approved	string
InternalError	string
Pending	string
PendingRevalidation	string
RefreshingValidationToken	string
Rejected	string
Submitting	string
TimedOut	string
Unknown	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

IdentityType

The type of identity that creates/modifies resources

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

ResourceReference

Reference to another resource.

Name	Type	Description
id	string	Resource ID.

SystemData

Read only system data

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC)
createdBy	string	An identifier for the identity that created the resource
createdByType	IdentityType	The type of identity that created the resource
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	An identifier for the identity that last modified the resource
lastModifiedByType	IdentityType	The type of identity that last modified the resource