Share via

VpnSitesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:vpn_sites> attribute.

Inheritance
builtins.object
VpnSitesOperations

Constructor

VpnSitesOperations(*args, **kwargs)

Methods

begin_create_or_update

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

Deletes a VpnSite.
get

Retrieves the details of a VPN site.
list

Lists all the VpnSites in a subscription.
list_by_resource_group

Lists all the vpnSites in a resource group.
update_tags

Updates VpnSite tags.

begin_create_or_update

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

begin_create_or_update(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: _models.VpnSite, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnSite]

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnSite. Required.
vpn_site_name
Required
str

The name of the VpnSite being created or updated. Required.
vpn_site_parameters
Required
VpnSite or IO[bytes]

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

Returns

Type Description
LROPoller[VpnSite]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a VpnSite.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnSite. Required.
vpn_site_name
Required
str

The name of the VpnSite 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 VPN site.

get(resource_group_name: str, vpn_site_name: str, **kwargs: Any) -> VpnSite

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnSite. Required.
vpn_site_name
Required
str

The name of the VpnSite being retrieved. Required.

Returns

Type Description
VpnSite

VpnSite or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all the VpnSites in a subscription.

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

Returns

Type Description
ItemPaged[VpnSite]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists all the vpnSites in a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnSite. Required.

Returns

Type Description
ItemPaged[VpnSite]

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

Exceptions

Type Description
HttpResponseError

update_tags

Updates VpnSite tags.

update_tags(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VpnSite

Parameters

Name Description
resource_group_name
Required
str

The resource group name of the VpnSite. Required.
vpn_site_name
Required
str

The name of the VpnSite being updated. Required.
vpn_site_parameters
Required
TagsObject or IO[bytes]

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

Returns

Type Description
VpnSite

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