AFDEndpointsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:afd_endpoints> attribute.

Constructor

AFDEndpointsOperations(*args, **kwargs)

Methods

begin_create	Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
begin_delete	Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
begin_purge_content	Removes a content from AzureFrontDoor.
begin_update	Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.
get	Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
list_by_profile	Lists existing AzureFrontDoor endpoints.
list_resource_usage	Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
validate_custom_domain	Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

begin_create

Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint: _models.AFDEndpoint, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AFDEndpoint]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
endpoint Required	AFDEndpoint or IO[bytes] Endpoint properties. Is either a AFDEndpoint type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AFDEndpoint]	An instance of LROPoller that returns either AFDEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

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

begin_delete(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_purge_content

Removes a content from AzureFrontDoor.

begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, contents: _models.AfdPurgeParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
contents Required	AfdPurgeParameters or IO[bytes] The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/>>*<<' which removes all folders and files in the directory. Is either a AfdPurgeParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint_update_properties: _models.AFDEndpointUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AFDEndpoint]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
endpoint_update_properties Required	AFDEndpointUpdateParameters or IO[bytes] Endpoint update properties. Is either a AFDEndpointUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AFDEndpoint]	An instance of LROPoller that returns either AFDEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

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

get(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> AFDEndpoint

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.

Returns

Type	Description
AFDEndpoint	AFDEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_profile

Lists existing AzureFrontDoor endpoints.

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) -> Iterable[AFDEndpoint]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Returns

Type	Description
ItemPaged[AFDEndpoint]	An iterator like instance of either AFDEndpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_resource_usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

list_resource_usage(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> Iterable[Usage]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.

Returns

Type	Description
ItemPaged[Usage]	An iterator like instance of either Usage or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

validate_custom_domain

Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

validate_custom_domain(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_properties: _models.ValidateCustomDomainInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ValidateCustomDomainOutput

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
custom_domain_properties Required	ValidateCustomDomainInput or IO[bytes] Custom domain to be validated. Is either a ValidateCustomDomainInput type or a IO[bytes] type. Required.

Returns

Type	Description
ValidateCustomDomainOutput	ValidateCustomDomainOutput or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cdn.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv77\\Lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>