AFDCustomDomainsOperations Class

AFDCustomDomainsOperations 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

AFDCustomDomainsOperations

Constructor

AFDCustomDomainsOperations(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 domain within the specified profile.
begin_delete	Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
begin_refresh_validation_token	Updates the domain validation token.
begin_update	Updates an existing domain within a profile.
get	Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
list_by_profile	Lists existing AzureFrontDoor domains.

begin_create

Creates a new domain within the specified profile.

begin_create(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain: azure.mgmt.cdn.models._models_py3.AFDDomain, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.AFDDomain]

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.

custom_domain_name

str

Required

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

custom_domain

AFDDomain

Required

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

Return type

LROPoller[AFDDomain]

Exceptions

HttpResponseError

begin_delete

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

begin_delete(resource_group_name: str, profile_name: str, custom_domain_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.

custom_domain_name

str

Required

Name of the domain 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_refresh_validation_token

Updates the domain validation token.

begin_refresh_validation_token(resource_group_name: str, profile_name: str, custom_domain_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.

custom_domain_name

str

Required

Name of the domain 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_update

Updates an existing domain within a profile.

begin_update(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain_update_properties: azure.mgmt.cdn.models._models_py3.AFDDomainUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.AFDDomain]

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.

custom_domain_name

str

Required

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

custom_domain_update_properties

AFDDomainUpdateParameters

Required

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

Return type

LROPoller[AFDDomain]

Exceptions

HttpResponseError

get

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

get(resource_group_name: str, profile_name: str, custom_domain_name: str, **kwargs: Any) -> azure.mgmt.cdn.models._models_py3.AFDDomain

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.

custom_domain_name

str

Required

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

cls

callable

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

Returns

AFDDomain, or the result of cls(response)

Return type

AFDDomain

Exceptions

HttpResponseError

list_by_profile

Lists existing AzureFrontDoor domains.

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

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

Return type

ItemPaged[AFDDomainListResult]

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