VirtualRouterPeeringsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:virtual_router_peerings> attribute.

Inheritance

builtins.object

VirtualRouterPeeringsOperations

Constructor

VirtualRouterPeeringsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates the specified Virtual Router Peering.
begin_delete	Deletes the specified peering from a Virtual Router.
get	Gets the specified Virtual Router Peering.
list	Lists all Virtual Router Peerings in a Virtual Router resource.

begin_create_or_update

Creates or updates the specified Virtual Router Peering.

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

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.
peering_name Required	str The name of the Virtual Router Peering. Required.
parameters Required	VirtualRouterPeering or IO[bytes] Parameters supplied to the create or update Virtual Router Peering operation. Is either a VirtualRouterPeering type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified peering from a Virtual Router.

begin_delete(resource_group_name: str, virtual_router_name: str, peering_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.
peering_name Required	str The name of the peering. 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 Peering.

get(resource_group_name: str, virtual_router_name: str, peering_name: str, **kwargs: Any) -> VirtualRouterPeering

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.
peering_name Required	str The name of the Virtual Router Peering. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Lists all Virtual Router Peerings in a Virtual Router resource.

list(resource_group_name: str, virtual_router_name: str, **kwargs: Any) -> Iterable[VirtualRouterPeering]

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