VpnServerConfigurationsOperations Class

VpnServerConfigurationsOperations 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

VpnServerConfigurationsOperations

Constructor

VpnServerConfigurationsOperations(client, config, serializer, deserializer)

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 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, vpn_server_configuration_name, vpn_server_configuration_parameters, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VpnServerConfiguration.

vpn_server_configuration_name

str

Required

The name of the VpnServerConfiguration being created or updated.

vpn_server_configuration_parameters

VpnServerConfiguration

Required

Parameters supplied to create or update VpnServerConfiguration.

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 PollingMethod

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 LROPoller that returns either VpnServerConfiguration or the result of cls(response)

Return type

LROPoller[VpnServerConfiguration]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes a VpnServerConfiguration.

begin_delete(resource_group_name, vpn_server_configuration_name, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VpnServerConfiguration.

vpn_server_configuration_name

str

Required

The name of the VpnServerConfiguration being deleted.

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 PollingMethod

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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Retrieves the details of a VpnServerConfiguration.

get(resource_group_name, vpn_server_configuration_name, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VpnServerConfiguration.

vpn_server_configuration_name

str

Required

The name of the VpnServerConfiguration being retrieved.

cls

callable

Required

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

Returns

VpnServerConfiguration, or the result of cls(response)

Return type

VpnServerConfiguration

Exceptions

~azure.core.exceptions.HttpResponseError

list

Lists all the VpnServerConfigurations in a subscription.

list(**kwargs)

Parameters

cls

callable

Required

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

Returns

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

Return type

ItemPaged[ListVpnServerConfigurationsResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists all the vpnServerConfigurations in a resource group.

list_by_resource_group(resource_group_name, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VpnServerConfiguration.

cls

callable

Required

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

Returns

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

Return type

ItemPaged[ListVpnServerConfigurationsResult]

Exceptions

~azure.core.exceptions.HttpResponseError

update_tags

Updates VpnServerConfiguration tags.

update_tags(resource_group_name, vpn_server_configuration_name, vpn_server_configuration_parameters, **kwargs)

Parameters

resource_group_name

str

Required

The resource group name of the VpnServerConfiguration.

vpn_server_configuration_name

str

Required

The name of the VpnServerConfiguration being updated.

vpn_server_configuration_parameters

TagsObject

Required

Parameters supplied to update VpnServerConfiguration tags.

cls

callable

Required

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

Returns

VpnServerConfiguration, or the result of cls(response)

Return type

VpnServerConfiguration

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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