Share via

RoutesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:routes> attribute.

Inheritance
builtins.object
RoutesOperations

Constructor

RoutesOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a route in the specified route table.
begin_delete

Deletes the specified route from a route table.
get

Gets the specified route from a route table.
list

Gets all routes in a route table.

begin_create_or_update

Creates or updates a route in the specified route table.

begin_create_or_update(resource_group_name: str, route_table_name: str, route_name: str, route_parameters: _models.Route, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Route]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
route_table_name
Required
str

The name of the route table. Required.
route_name
Required
str

The name of the route. Required.
route_parameters
Required
Route or IO[bytes]

Parameters supplied to the create or update route operation. 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 the specified route from a route table.

begin_delete(resource_group_name: str, route_table_name: str, route_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
route_table_name
Required
str

The name of the route table. Required.
route_name
Required
str

The name of the route. Required.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the specified route from a route table.

get(resource_group_name: str, route_table_name: str, route_name: str, **kwargs: Any) -> Route

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
route_table_name
Required
str

The name of the route table. Required.
route_name
Required
str

The name of the route. Required.

Returns

Type Description
Route

Route or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all routes in a route table.

list(resource_group_name: str, route_table_name: str, **kwargs: Any) -> Iterable[Route]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
route_table_name
Required
str

The name of the route table. 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.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>