VirtualNetworksOperations Class

VirtualNetworksOperations 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

VirtualNetworksOperations

Constructor

VirtualNetworksOperations(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 virtual network in the specified resource group.
begin_delete	Deletes the specified virtual network.
begin_update_tags	Updates a virtual network tags.
check_ip_address_availability	Checks whether a private IP address is available for use.
get	Gets the specified virtual network by resource group.
list	Gets all virtual networks in a resource group.
list_all	Gets all virtual networks in a subscription.
list_usage	Lists usage stats.

begin_create_or_update

Creates or updates a virtual network in the specified resource group.

begin_create_or_update(resource_group_name: str, virtual_network_name: str, parameters: azure.mgmt.network.v2018_07_01.models._models_py3.VirtualNetwork, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VirtualNetwork')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_name

str

Required

The name of the virtual network.

parameters

VirtualNetwork

Required

Parameters supplied to the create or update virtual network 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 VirtualNetwork or the result of cls(response)

Return type

AsyncLROPoller[VirtualNetwork]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified virtual network.

begin_delete(resource_group_name: str, virtual_network_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.

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

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates a virtual network tags.

begin_update_tags(resource_group_name: str, virtual_network_name: str, parameters: azure.mgmt.network.v2018_07_01.models._models_py3.TagsObject, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.VirtualNetwork')]

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_name

str

Required

The name of the virtual network.

parameters

TagsObject

Required

Parameters supplied to update virtual network tags.

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 VirtualNetwork or the result of cls(response)

Return type

AsyncLROPoller[VirtualNetwork]

Exceptions

~azure.core.exceptions.HttpResponseError

check_ip_address_availability

Checks whether a private IP address is available for use.

check_ip_address_availability(resource_group_name: str, virtual_network_name: str, ip_address: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2018_07_01.models._models_py3.IPAddressAvailabilityResult

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_name

str

Required

The name of the virtual network.

ip_address

str

Required

The private IP address to be verified.

cls

callable

Required

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

Returns

IPAddressAvailabilityResult, or the result of cls(response)

Return type

IPAddressAvailabilityResult

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified virtual network by resource group.

get(resource_group_name: str, virtual_network_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2018_07_01.models._models_py3.VirtualNetwork

Parameters

resource_group_name

str

Required

The name of the resource group.

virtual_network_name

str

Required

The name of the virtual network.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

VirtualNetwork, or the result of cls(response)

Return type

VirtualNetwork

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all virtual networks in a resource group.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[VirtualNetworkListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all virtual networks in a subscription.

list_all(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.VirtualNetworkListResult')]

Parameters

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[VirtualNetworkListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_usage

Lists usage stats.

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

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 VirtualNetworkListUsageResult or the result of cls(response)

Return type

AsyncItemPaged[VirtualNetworkListUsageResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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