EndpointsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:endpoints> attribute.

Inheritance

builtins.object

EndpointsOperations

Constructor

EndpointsOperations(*args, **kwargs)

Methods

begin_create	Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
begin_delete	Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
begin_load_content	Pre-loads a content to CDN. Available for Verizon Profiles.
begin_purge_content	Removes a content from CDN.
begin_start	Starts an existing CDN endpoint that is on a stopped state.
begin_stop	Stops an existing running CDN endpoint.
begin_update	Updates an existing CDN 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 custom domains, use the Update Custom Domain operation.
get	Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
list_by_profile	Lists existing CDN endpoints.
list_resource_usage	Checks the quota and usage of geo filters and custom domains under the given endpoint.
validate_custom_domain	Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

begin_create

Creates a new CDN 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.Endpoint, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Endpoint]

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 CDN 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	Endpoint or IO[bytes] Endpoint properties. Is either a Endpoint type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes an existing CDN 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 CDN 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_load_content

Pre-loads a content to CDN. Available for Verizon Profiles.

begin_load_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: _models.LoadParameters, *, 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 CDN 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.
content_file_paths Required	LoadParameters or IO[bytes] The path to the content to be loaded. Path should be a full URL, e.g. '/pictures/city.png' which loads a single file. Is either a LoadParameters 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_purge_content

Removes a content from CDN.

begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: _models.PurgeParameters, *, 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 CDN 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.
content_file_paths Required	PurgeParameters or IO[bytes] The path to the content 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 PurgeParameters 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_start

Starts an existing CDN endpoint that is on a stopped state.

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

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 CDN 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[Endpoint]	An instance of LROPoller that returns either Endpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop

Stops an existing running CDN endpoint.

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

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 CDN 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[Endpoint]	An instance of LROPoller that returns either Endpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an existing CDN 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 custom domains, use the Update Custom Domain operation.

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

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 CDN 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	EndpointUpdateParameters or IO[bytes] Endpoint update properties. Is either a EndpointUpdateParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets an existing CDN 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) -> Endpoint

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 CDN 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
Endpoint	Endpoint or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_profile

Lists existing CDN endpoints.

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

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 CDN profile which is unique within the resource group. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_resource_usage

Checks the quota and usage of geo filters and custom domains under the given endpoint.

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

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 CDN 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[ResourceUsage]	An iterator like instance of either ResourceUsage 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 CDN 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 CDN 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.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>