Share via

VirtualRoutersOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:virtual_routers> attribute.

Inheritance
builtins.object
VirtualRoutersOperations

Constructor

VirtualRoutersOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates the specified Virtual Router.
begin_delete

Deletes the specified Virtual Router.
get

Gets the specified Virtual Router.
list

Gets all the Virtual Routers in a subscription.
list_by_resource_group

Lists all Virtual Routers in a resource group.

begin_create_or_update

Creates or updates the specified Virtual Router.

begin_create_or_update(resource_group_name: str, virtual_router_name: str, parameters: _models.VirtualRouter, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualRouter]

Parameters

Name Description
resource_group_name
Required
str

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

The name of the Virtual Router. Required.
parameters
Required
VirtualRouter or IO[bytes]

Parameters supplied to the create or update Virtual Router. Is either a VirtualRouter type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[VirtualRouter]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified Virtual Router.

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

Parameters

Name Description
resource_group_name
Required
str

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

The name of the Virtual Router. 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 Virtual Router.

get(resource_group_name: str, virtual_router_name: str, *, expand: str | None = None, **kwargs: Any) -> VirtualRouter

Parameters

Name Description
resource_group_name
Required
str

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

The name of the Virtual Router. Required.

Keyword-Only Parameters

Name Description
expand
str

Expands referenced resources. Default value is None.

Returns

Type Description
VirtualRouter

VirtualRouter or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all the Virtual Routers in a subscription.

list(**kwargs: Any) -> Iterable[VirtualRouter]

Returns

Type Description
ItemPaged[VirtualRouter]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists all Virtual Routers in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualRouter]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[VirtualRouter]

An iterator like instance of either VirtualRouter 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'>