AFDCustomDomainsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:afd_custom_domains> attribute.

Constructor

AFDCustomDomainsOperations(*args, **kwargs)

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.

async begin_create(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain: _models.AFDDomain, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.AFDDomain]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
custom_domain_name Required	str Name of the domain under the profile which is unique globally. Required.
custom_domain Required	AFDDomain or AFDDomain or IO[bytes] Domain properties. Is either a AFDDomain type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[AFDDomain]	An instance of AsyncLROPoller that returns AFDDomain. The AFDDomain is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

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

async begin_delete(resource_group_name: str, profile_name: str, custom_domain_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
custom_domain_name Required	str Name of the domain under the profile which is unique globally. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_refresh_validation_token

Updates the domain validation token.

async begin_refresh_validation_token(resource_group_name: str, profile_name: str, custom_domain_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
custom_domain_name Required	str Name of the domain under the profile which is unique globally. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an existing domain within a profile.

async begin_update(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain_update_properties: _models.AFDDomainUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.AFDDomain]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
custom_domain_name Required	str Name of the domain under the profile which is unique globally. Required.
custom_domain_update_properties Required	AFDDomainUpdateParameters or AFDDomainUpdateParameters or IO[bytes] Domain properties. Is either a AFDDomainUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[AFDDomain]	An instance of AsyncLROPoller that returns AFDDomain. The AFDDomain is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

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

async get(resource_group_name: str, profile_name: str, custom_domain_name: str, **kwargs: Any) -> AFDDomain

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
custom_domain_name Required	str Name of the domain under the profile which is unique globally. Required.

Returns

Type	Description
AFDDomain	AFDDomain. The AFDDomain is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_profile

Lists existing AzureFrontDoor domains.

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) -> AsyncItemPaged[AFDDomain]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

Returns

Type	Description
AsyncItemPaged[AFDDomain]	An iterator like instance of AFDDomain

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?