VirtualNetworkPeeringsOperations Class

VirtualNetworkPeeringsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
VirtualNetworkPeeringsOperations

Constructor

VirtualNetworkPeeringsOperations(client, config, serializer, deserializer) -> None

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.network.v2018_01_01.models._models_py3.VirtualNetworkPeering, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VirtualNetworkPeering')]

Parameters

resource_group_name
str
Required

The name of the resource group.

virtual_network_name
str
Required

The name of the virtual network.

virtual_network_peering_name
str
Required

The name of the peering.

virtual_network_peering_parameters
VirtualNetworkPeering
Required

Parameters supplied to the create or update virtual network peering operation.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either VirtualNetworkPeering or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group.

virtual_network_name
str
Required

The name of the virtual network.

virtual_network_peering_name
str
Required

The name of the virtual network peering.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified virtual network peering.

get(resource_group_name: str, virtual_network_name: str, virtual_network_peering_name: str, **kwargs) -> azure.mgmt.network.v2018_01_01.models._models_py3.VirtualNetworkPeering

Parameters

resource_group_name
str
Required

The name of the resource group.

virtual_network_name
str
Required

The name of the virtual network.

virtual_network_peering_name
str
Required

The name of the virtual network peering.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

VirtualNetworkPeering, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all virtual network peerings in a virtual network.

list(resource_group_name: str, virtual_network_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.VirtualNetworkPeeringListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

virtual_network_name
str
Required

The name of the virtual network.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2018_01_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2018_01_01\\models\\__init__.py'>