AFDCustomDomainsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:afd_custom_domains> attribute.

Inheritance

builtins.object

AFDCustomDomainsOperations

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.

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

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 Azure Front Door Standard or Azure Front Door Premium 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 IO[bytes] Domain properties. Is either a AFDDomain type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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) -> 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 Azure Front Door Standard or Azure Front Door Premium 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
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
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) -> 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 Azure Front Door Standard or Azure Front Door Premium 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
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
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: _models.AFDDomainUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AFDDomain]

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 Azure Front Door Standard or Azure Front Door Premium 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 IO[bytes] Domain properties. Is either a AFDDomainUpdateParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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) -> AFDDomain

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 Azure Front Door Standard or Azure Front Door Premium 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 or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_profile

Lists existing AzureFrontDoor domains.

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

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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Returns

Type	Description
ItemPaged[AFDDomain]	An iterator like instance of either AFDDomain 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'>