RoutesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:routes> attribute.

Inheritance

builtins.object

RoutesOperations

Constructor

RoutesOperations(*args, **kwargs)

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

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.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
route_name Required	str Name of the routing rule. Required.
route Required	Route or IO[bytes] Route properties. Is either a Route type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
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) -> 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.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
route_name Required	str Name of the routing rule. 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 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: _models.RouteUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Route]

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.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
route_name Required	str Name of the routing rule. Required.
route_update_properties Required	RouteUpdateParameters or IO[bytes] Route update properties. Is either a RouteUpdateParameters type or a IO[bytes] type. Required.

Returns

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

Exceptions

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

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.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.
route_name Required	str Name of the routing rule. Required.

Returns

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

Exceptions

Type	Description
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[Route]

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.
endpoint_name Required	str Name of the endpoint under the profile which is unique globally. Required.

Returns

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