CustomDomainsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:custom_domains> attribute.

Inheritance
builtins.object
CustomDomainsOperations

Constructor

CustomDomainsOperations(*args, **kwargs)

Methods

begin_create

Creates a new custom domain within an endpoint.
begin_delete

Deletes an existing custom domain within an endpoint.
begin_disable_custom_https

Disable https delivery of the custom domain.
begin_enable_custom_https

Enable https delivery of the custom domain.
get

Gets an existing custom domain within an endpoint.
list_by_endpoint

Lists all of the existing custom domains within an endpoint.

begin_create

Creates a new custom domain within an endpoint.

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

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_name
Required
str

Name of the custom domain within an endpoint. Required.
custom_domain_properties
Required
CustomDomainParameters or IO[bytes]

Properties required to create a new custom domain. Is either a CustomDomainParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[CustomDomain]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes an existing custom domain within an endpoint.

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

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_name
Required
str

Name of the custom domain within an endpoint. Required.

Returns

Type Description
LROPoller[CustomDomain]

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

Exceptions

Type Description
HttpResponseError

begin_disable_custom_https

Disable https delivery of the custom domain.

begin_disable_custom_https(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, **kwargs: Any) -> LROPoller[CustomDomain]

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_name
Required
str

Name of the custom domain within an endpoint. Required.

Returns

Type Description
LROPoller[CustomDomain]

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

Exceptions

Type Description
HttpResponseError

begin_enable_custom_https

Enable https delivery of the custom domain.

begin_enable_custom_https(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, custom_domain_https_parameters: _models.CustomDomainHttpsParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CustomDomain]

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_name
Required
str

Name of the custom domain within an endpoint. Required.
custom_domain_https_parameters
Required
CustomDomainHttpsParameters or IO[bytes]

The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default. Is either a CustomDomainHttpsParameters type or a IO[bytes] type. Default value is None.

Returns

Type Description
LROPoller[CustomDomain]

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

Exceptions

Type Description
HttpResponseError

get

Gets an existing custom domain within an endpoint.

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

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_name
Required
str

Name of the custom domain within an endpoint. Required.

Returns

Type Description
CustomDomain

CustomDomain or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_endpoint

Lists all of the existing custom domains within an endpoint.

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

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[CustomDomain]

An iterator like instance of either CustomDomain 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'>