Share via

VirtualWansOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:virtual_wans> attribute.

Inheritance
builtins.object
VirtualWansOperations

Constructor

VirtualWansOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.
begin_delete

Deletes a VirtualWAN.
get

Retrieves the details of a VirtualWAN.
list

Lists all the VirtualWANs in a subscription.
list_by_resource_group

Lists all the VirtualWANs in a resource group.
update_tags

Updates a VirtualWAN tags.

begin_create_or_update

Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.

begin_create_or_update(resource_group_name: str, virtual_wan_name: str, wan_parameters: _models.VirtualWAN, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualWAN]

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VirtualWan. Required.
virtual_wan_name
Required
str

The name of the VirtualWAN being created or updated. Required.
wan_parameters
Required
VirtualWAN or IO[bytes]

Parameters supplied to create or update VirtualWAN. Is either a VirtualWAN type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[VirtualWAN]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a VirtualWAN.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VirtualWan. Required.
virtual_wan_name
Required
str

The name of the VirtualWAN being deleted. 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

Retrieves the details of a VirtualWAN.

get(resource_group_name: str, virtual_wan_name: str, **kwargs: Any) -> VirtualWAN

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VirtualWan. Required.
virtual_wan_name
Required
str

The name of the VirtualWAN being retrieved. Required.

Returns

Type Description
VirtualWAN

VirtualWAN or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all the VirtualWANs in a subscription.

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

Returns

Type Description
ItemPaged[VirtualWAN]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists all the VirtualWANs in a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VirtualWan. Required.

Returns

Type Description
ItemPaged[VirtualWAN]

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

Exceptions

Type Description
HttpResponseError

update_tags

Updates a VirtualWAN tags.

update_tags(resource_group_name: str, virtual_wan_name: str, wan_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VirtualWAN

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VirtualWan. Required.
virtual_wan_name
Required
str

The name of the VirtualWAN being updated. Required.
wan_parameters
Required
TagsObject or IO[bytes]

Parameters supplied to Update VirtualWAN tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type Description
VirtualWAN

VirtualWAN 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'>