AFD Endpoints - Get

Service:

Front Door Service

API Version:

2025-04-15

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

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

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string	Name of the endpoint under the profile which is unique globally.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Name of the Resource group within the Azure subscription.
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 2025-04-15.

Responses

Name	Type	Description
200 OK	AFDEndpoint	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

AFDEndpoints_Get

Sample request

HTTP

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

Sample response

Status code:

200

{
  "name": "endpoint1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/afdendpoints",
  "tags": {},
  "location": "global",
  "properties": {
    "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net",
    "enabledState": "Enabled",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted",
    "autoGeneratedDomainNameLabelScope": "TenantReuse"
  }
}

Definitions

Name	Description
AFDEndpoint	Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format <endpointname>.azureedge.net.
AfdErrorResponse	Error response
AfdProvisioningState	Provisioning status
AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.
DeploymentStatus
EnabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
IdentityType	The type of identity that creates/modifies resources
SystemData	Read only system data

AFDEndpoint

Object

Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format <endpointname>.azureedge.net.

Name	Type	Description
id	string	Resource ID.
location	string	Resource location.
name	string	Resource name.
properties.autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	Indicates the endpoint name reuse scope. The default value is TenantReuse.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
properties.hostName	string	The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
properties.profileName	string	The name of the profile which holds the endpoint.
properties.provisioningState	AfdProvisioningState	Provisioning status
systemData	SystemData	Read only system data
tags	object	Resource tags.
type	string	Resource type.

AfdErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

AfdProvisioningState

Enumeration

Provisioning status

Value	Description
Succeeded
Failed
Updating
Deleting
Creating

AutoGeneratedDomainNameLabelScope

Enumeration

Indicates the endpoint name reuse scope. The default value is TenantReuse.

Value	Description
TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

DeploymentStatus

Enumeration

Value	Description
NotStarted
InProgress
Succeeded
Failed

EnabledState

Enumeration

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'

Value	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Enumeration

The type of identity that creates/modifies resources

Value	Description
user
application
managedIdentity
key

SystemData

Object

Read only system data

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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