VpnServerConfigurationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:vpn_server_configurations> attribute.

Inheritance

builtins.object

VpnServerConfigurationsOperations

Constructor

VpnServerConfigurationsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.
begin_delete	Deletes a VpnServerConfiguration.
get	Retrieves the details of a VpnServerConfiguration.
list	Lists all the VpnServerConfigurations in a subscription.
list_by_resource_group	Lists all the vpnServerConfigurations in a resource group.
update_tags	Updates VpnServerConfiguration tags.

begin_create_or_update

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

begin_create_or_update(resource_group_name: str, vpn_server_configuration_name: str, vpn_server_configuration_parameters: _models.VpnServerConfiguration, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnServerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VpnServerConfiguration. Required.
vpn_server_configuration_name Required	str The name of the VpnServerConfiguration being created or updated. Required.
vpn_server_configuration_parameters Required	VpnServerConfiguration or IO[bytes] Parameters supplied to create or update VpnServerConfiguration. Is either a VpnServerConfiguration type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a VpnServerConfiguration.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VpnServerConfiguration. Required.
vpn_server_configuration_name Required	str The name of the VpnServerConfiguration 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 VpnServerConfiguration.

get(resource_group_name: str, vpn_server_configuration_name: str, **kwargs: Any) -> VpnServerConfiguration

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VpnServerConfiguration. Required.
vpn_server_configuration_name Required	str The name of the VpnServerConfiguration being retrieved. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Lists all the VpnServerConfigurations in a subscription.

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

Returns

Type	Description
ItemPaged[VpnServerConfiguration]	An iterator like instance of either VpnServerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all the vpnServerConfigurations in a resource group.

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

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VpnServerConfiguration. Required.

Returns

Type	Description
ItemPaged[VpnServerConfiguration]	An iterator like instance of either VpnServerConfiguration or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_tags

Updates VpnServerConfiguration tags.

update_tags(resource_group_name: str, vpn_server_configuration_name: str, vpn_server_configuration_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VpnServerConfiguration

Parameters

Name	Description
resource_group_name Required	str The resource group name of the VpnServerConfiguration. Required.
vpn_server_configuration_name Required	str The name of the VpnServerConfiguration being updated. Required.
vpn_server_configuration_parameters Required	TagsObject or IO[bytes] Parameters supplied to update VpnServerConfiguration tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
VpnServerConfiguration	VpnServerConfiguration 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'>