VirtualNetworkPeeringsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:virtual_network_peerings> attribute.

Inheritance

builtins.object

VirtualNetworkPeeringsOperations

Constructor

VirtualNetworkPeeringsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a peering in the specified virtual network.
begin_delete	Deletes the specified virtual network peering.
get	Gets the specified virtual network peering.
list	Gets all virtual network peerings in a virtual network.

begin_create_or_update

Creates or updates a peering in the specified virtual network.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, virtual_network_peering_parameters: _models.VirtualNetworkPeering, *, sync_remote_address_space: str | _models.SyncRemoteAddressSpace | None = None, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualNetworkPeering]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_name Required	str The name of the virtual network. Required.
virtual_network_peering_name Required	str The name of the peering. Required.
virtual_network_peering_parameters Required	VirtualNetworkPeering or IO[bytes] Parameters supplied to the create or update virtual network peering operation. Is either a VirtualNetworkPeering type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
sync_remote_address_space	str or SyncRemoteAddressSpace Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated. "true" Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified virtual network peering.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_name Required	str The name of the virtual network. Required.
virtual_network_peering_name Required	str The name of the virtual network peering. Required.

Keyword-Only Parameters

Name	Description
sync_remote_address_space	str or SyncRemoteAddressSpace Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated. "true" Default value is None.

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 network peering.

get(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, **kwargs: Any) -> VirtualNetworkPeering

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_name Required	str The name of the virtual network. Required.
virtual_network_peering_name Required	str The name of the virtual network peering. Required.

Keyword-Only Parameters

Name	Description
sync_remote_address_space	str or SyncRemoteAddressSpace Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated. "true" Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets all virtual network peerings in a virtual network.

list(resource_group_name: str, virtual_network_name: str, **kwargs: Any) -> Iterable[VirtualNetworkPeering]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_network_name Required	str The name of the virtual network. Required.

Keyword-Only Parameters

Name	Description
sync_remote_address_space	str or SyncRemoteAddressSpace Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated. "true" Default value is None.

Returns

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