AFDProfilesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:afd_profiles> attribute.

Constructor

AFDProfilesOperations(*args, **kwargs)

Methods

begin_upgrade	Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.
check_endpoint_name_availability	Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.
check_host_name_availability	Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.
list_resource_usage	Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
validate_secret	Validate a Secret in the profile.

begin_upgrade

Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.

begin_upgrade(resource_group_name: str, profile_name: str, profile_upgrade_parameters: _models.ProfileUpgradeParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Profile]

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 which is unique within the resource group. Required.
profile_upgrade_parameters Required	ProfileUpgradeParameters or IO[bytes] Profile upgrade input parameter. Is either a ProfileUpgradeParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

check_endpoint_name_availability

Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.

check_endpoint_name_availability(resource_group_name: str, profile_name: str, check_endpoint_name_availability_input: _models.CheckEndpointNameAvailabilityInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckEndpointNameAvailabilityOutput

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 which is unique within the resource group. Required.
check_endpoint_name_availability_input Required	CheckEndpointNameAvailabilityInput or IO[bytes] Input to check. Is either a CheckEndpointNameAvailabilityInput type or a IO[bytes] type. Required.

Returns

Type	Description
CheckEndpointNameAvailabilityOutput	CheckEndpointNameAvailabilityOutput or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

check_host_name_availability

Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.

check_host_name_availability(resource_group_name: str, profile_name: str, check_host_name_availability_input: _models.CheckHostNameAvailabilityInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CheckNameAvailabilityOutput

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.
check_host_name_availability_input Required	CheckHostNameAvailabilityInput or IO[bytes] Custom domain to be validated. Is either a CheckHostNameAvailabilityInput type or a IO[bytes] type. Required.

Returns

Type	Description
CheckNameAvailabilityOutput	CheckNameAvailabilityOutput or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_resource_usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

list_resource_usage(resource_group_name: str, profile_name: str, **kwargs: Any) -> Iterable[Usage]

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[Usage]	An iterator like instance of either Usage or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

validate_secret

Validate a Secret in the profile.

validate_secret(resource_group_name: str, profile_name: str, validate_secret_input: _models.ValidateSecretInput, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ValidateSecretOutput

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 which is unique within the resource group. Required.
validate_secret_input Required	ValidateSecretInput or IO[bytes] The Secret source. Is either a ValidateSecretInput type or a IO[bytes] type. Required.

Returns

Type	Description
ValidateSecretOutput	ValidateSecretOutput 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.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv77\\Lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>