FrontDoorsOperations Class

FrontDoorsOperations async 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

FrontDoorsOperations

Constructor

FrontDoorsOperations(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_or_update	Creates a new Front Door with a Front Door name under the specified subscription and resource group.
begin_delete	Deletes an existing Front Door with the specified parameters.
get	Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
list	Lists all of the Front Doors within an Azure subscription.
list_by_resource_group	Lists all of the Front Doors within a resource group under a subscription.
validate_custom_domain	Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.

begin_create_or_update

Creates a new Front Door with a Front Door name under the specified subscription and resource group.

async begin_create_or_update(resource_group_name: str, front_door_name: str, front_door_parameters: azure.mgmt.frontdoor.models._models_py3.FrontDoor, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.frontdoor.models._models_py3.FrontDoor]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

front_door_name

str

Required

Name of the Front Door which is globally unique.

front_door_parameters

FrontDoor

Required

Front Door properties needed to create a new Front Door.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either FrontDoor or the result of cls(response)

Return type

AsyncLROPoller[FrontDoor]

Exceptions

HttpResponseError

begin_delete

Deletes an existing Front Door with the specified parameters.

async begin_delete(resource_group_name: str, front_door_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

front_door_name

str

Required

Name of the Front Door which is globally unique.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Gets a Front Door with the specified Front Door name under the specified subscription and resource group.

async get(resource_group_name: str, front_door_name: str, **kwargs: Any) -> azure.mgmt.frontdoor.models._models_py3.FrontDoor

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

front_door_name

str

Required

Name of the Front Door which is globally unique.

cls

callable

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

Returns

FrontDoor, or the result of cls(response)

Return type

FrontDoor

Exceptions

HttpResponseError

list

Lists all of the Front Doors within an Azure subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.frontdoor.models._models_py3.FrontDoorListResult]

Parameters

cls

callable

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

Returns

An iterator like instance of either FrontDoorListResult or the result of cls(response)

Return type

AsyncItemPaged[FrontDoorListResult]

Exceptions

HttpResponseError

list_by_resource_group

Lists all of the Front Doors within a resource group under a subscription.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.frontdoor.models._models_py3.FrontDoorListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

cls

callable

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

Returns

An iterator like instance of either FrontDoorListResult or the result of cls(response)

Return type

AsyncItemPaged[FrontDoorListResult]

Exceptions

HttpResponseError

validate_custom_domain

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

async validate_custom_domain(resource_group_name: str, front_door_name: str, custom_domain_properties: azure.mgmt.frontdoor.models._models_py3.ValidateCustomDomainInput, **kwargs: Any) -> azure.mgmt.frontdoor.models._models_py3.ValidateCustomDomainOutput

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

front_door_name

str

Required

Name of the Front Door which is globally unique.

custom_domain_properties

ValidateCustomDomainInput

Required

Custom domain to be validated.

cls

callable

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

Returns

ValidateCustomDomainOutput, or the result of cls(response)

Return type

ValidateCustomDomainOutput

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.frontdoor.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\frontdoor\\models\\__init__.py'>