AFDEndpointsOperations Class

AFDEndpointsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

AFDEndpointsOperations

Constructor

AFDEndpointsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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 CDN profile.
validate_custom_domain	Validates the custom domain mapping to ensure it maps to the correct CDN 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: azure.mgmt.cdn.models._models_py3.AFDEndpoint, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.AFDEndpoint]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

endpoint

AFDEndpoint

Required

Endpoint properties.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either AFDEndpoint or the result of cls(response)

Return type

LROPoller[AFDEndpoint]

Exceptions

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) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_purge_content

Removes a content from AzureFrontDoor.

begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, contents: azure.mgmt.cdn.models._models_py3.AfdPurgeParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

contents

AfdPurgeParameters

Required

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.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

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: azure.mgmt.cdn.models._models_py3.AFDEndpointUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.AFDEndpoint]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

endpoint_update_properties

AFDEndpointUpdateParameters

Required

Endpoint update properties.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either AFDEndpoint or the result of cls(response)

Return type

LROPoller[AFDEndpoint]

Exceptions

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) -> azure.mgmt.cdn.models._models_py3.AFDEndpoint

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

cls

callable

A custom type or function that will be passed the direct response

Returns

AFDEndpoint, or the result of cls(response)

Return type

AFDEndpoint

Exceptions

HttpResponseError

list_by_profile

Lists existing AzureFrontDoor endpoints.

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cdn.models._models_py3.AFDEndpointListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AFDEndpointListResult or the result of cls(response)

Return type

ItemPaged[AFDEndpointListResult]

Exceptions

HttpResponseError

list_resource_usage

Checks the quota and actual usage of endpoints under the given CDN profile.

list_resource_usage(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cdn.models._models_py3.UsagesListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UsagesListResult or the result of cls(response)

Return type

ItemPaged[UsagesListResult]

Exceptions

HttpResponseError

validate_custom_domain

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

validate_custom_domain(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_properties: azure.mgmt.cdn.models._models_py3.ValidateCustomDomainInput, **kwargs: Any) -> azure.mgmt.cdn.models._models_py3.ValidateCustomDomainOutput

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

custom_domain_properties

ValidateCustomDomainInput

Required

Custom domain to be validated.

cls

callable

A custom type or function that will be passed the direct response

Returns

ValidateCustomDomainOutput, or the result of cls(response)

Return type

ValidateCustomDomainOutput

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cdn.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>