RoutesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:routes> attribute.
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
|
The name of the resource group. The name is case insensitive. Required. |
|
route_table_name
Required
|
The name of the route table. Required. |
|
route_name
Required
|
The name of the route. Required. |
|
route_parameters
Required
|
Parameters supplied to the create or update route operation. Is one of the following types: Route, JSON, IO[bytes] Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns Route. The Route is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. The name is case insensitive. Required. |
|
route_table_name
Required
|
The name of the route table. Required. |
|
route_name
Required
|
The name of the route. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns None |
Exceptions
| Type | Description |
|---|---|
get
Gets the specified route from a route table.
get(resource_group_name: str, route_table_name: str, route_name: str, **kwargs: Any) -> RouteParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
route_table_name
Required
|
The name of the route table. Required. |
|
route_name
Required
|
The name of the route. Required. |
Returns
| Type | Description |
|---|---|
|
Route. The Route is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list
Gets all routes in a route table.
list(resource_group_name: str, route_table_name: str, **kwargs: Any) -> ItemPaged[Route]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
route_table_name
Required
|
The name of the route table. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of Route |
Exceptions
| Type | Description |
|---|---|
