RoutesOperations Class

RoutesOperations 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

RoutesOperations

Constructor

RoutesOperations(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 route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
begin_delete	Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
begin_update	Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
get	Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
list_by_endpoint	Lists all of the existing origins within a profile.

begin_create

Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, route: azure.mgmt.cdn.models._models_py3.Route, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Route]

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.

endpoint_name

str

Required

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

route_name

str

Required

Name of the routing rule.

route

Route

Required

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

Return type

LROPoller[Route]

Exceptions

HttpResponseError

begin_delete

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

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

endpoint_name

str

Required

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

route_name

str

Required

Name of the routing rule.

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 route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, route_update_properties: azure.mgmt.cdn.models._models_py3.RouteUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Route]

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.

endpoint_name

str

Required

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

route_name

str

Required

Name of the routing rule.

route_update_properties

RouteUpdateParameters

Required

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

Return type

LROPoller[Route]

Exceptions

HttpResponseError

get

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

get(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, **kwargs: Any) -> azure.mgmt.cdn.models._models_py3.Route

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.

endpoint_name

str

Required

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

route_name

str

Required

Name of the routing rule.

cls

callable

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

Returns

Route, or the result of cls(response)

Return type

Route

Exceptions

HttpResponseError

list_by_endpoint

Lists all of the existing origins within a profile.

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

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.

endpoint_name

str

Required

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

cls

callable

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

Returns

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

Return type

ItemPaged[RouteListResult]

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