CustomDomainsOperations Class

CustomDomainsOperations 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

CustomDomainsOperations

Constructor

CustomDomainsOperations(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 custom domain within an endpoint.
begin_delete	Deletes an existing custom domain within an endpoint.
disable_custom_https	Disable https delivery of the custom domain.
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: azure.mgmt.cdn.models._models_py3.CustomDomainParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.CustomDomain]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN 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_name

str

Required

Name of the custom domain within an endpoint.

custom_domain_properties

CustomDomainParameters

Required

Properties required to create a new custom domain.

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

Return type

LROPoller[CustomDomain]

Exceptions

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) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.CustomDomain]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN 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_name

str

Required

Name of the custom domain within an endpoint.

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

Return type

LROPoller[CustomDomain]

Exceptions

HttpResponseError

disable_custom_https

Disable https delivery of the custom domain.

disable_custom_https(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, **kwargs: Any) -> Optional[azure.mgmt.cdn.models._models_py3.CustomDomain]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN 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_name

str

Required

Name of the custom domain within an endpoint.

cls

callable

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

Returns

CustomDomain, or the result of cls(response)

Return type

CustomDomain,

None

Exceptions

HttpResponseError

enable_custom_https

Enable https delivery of the custom domain.

enable_custom_https(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, custom_domain_https_parameters: Optional[azure.mgmt.cdn.models._models_py3.CustomDomainHttpsParameters] = None, **kwargs: Any) -> Optional[azure.mgmt.cdn.models._models_py3.CustomDomain]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN 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_name

str

Required

Name of the custom domain within an endpoint.

custom_domain_https_parameters

CustomDomainHttpsParameters

Required

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.

cls

callable

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

Returns

CustomDomain, or the result of cls(response)

Return type

CustomDomain,

None

Exceptions

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

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN 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_name

str

Required

Name of the custom domain within an endpoint.

cls

callable

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

Returns

CustomDomain, or the result of cls(response)

Return type

CustomDomain

Exceptions

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[azure.mgmt.cdn.models._models_py3.CustomDomainListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

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

Return type

ItemPaged[CustomDomainListResult]

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'>