Share via

AFDEndpoint Class

  • Reference

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.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.cdn.models._models_py3.TrackedResource
AFDEndpoint

Constructor

AFDEndpoint(*, location: str, tags: Dict[str, str] | None = None, enabled_state: str | _models.EnabledState | None = None, auto_generated_domain_name_label_scope: str | _models.AutoGeneratedDomainNameLabelScope | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
enabled_state
str or EnabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".
auto_generated_domain_name_label_scope
str or AutoGeneratedDomainNameLabelScope

Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse".

Variables

Name Description
id
str

Resource ID.
name
str

Resource name.
type
str

Resource type.
system_data
SystemData

Read only system data.
location
str

Resource location. Required.
tags
dict[str, str]

Resource tags.
profile_name
str

The name of the profile which holds the endpoint.
enabled_state
str or EnabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Known values are: "Enabled" and "Disabled".
provisioning_state
str or AfdProvisioningState

Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating".
deployment_status
str or DeploymentStatus

Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed".
host_name
str

The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
auto_generated_domain_name_label_scope
str or AutoGeneratedDomainNameLabelScope

Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values are: "TenantReuse", "SubscriptionReuse", "ResourceGroupReuse", and "NoReuse".