VpnServerConfigurationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:vpn_server_configurations> attribute.

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.
list_radius_secrets	List all Radius servers with respective radius secrets from VpnServerConfiguration.
update_tags	Updates VpnServerConfiguration tags.

begin_create_or_update

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

async 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) -> AsyncLROPoller[_models.VpnServerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vpn_server_configuration_name Required	str The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
vpn_server_configuration_parameters Required	VpnServerConfiguration or 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
AsyncLROPoller[VpnServerConfiguration]	An instance of AsyncLROPoller that returns VpnServerConfiguration. The VpnServerConfiguration is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a VpnServerConfiguration.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vpn_server_configuration_name Required	str The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

Exceptions

Type	Description
HttpResponseError

get

Retrieves the details of a VpnServerConfiguration.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vpn_server_configuration_name Required	str The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.

Returns

Type	Description
VpnServerConfiguration	VpnServerConfiguration. The VpnServerConfiguration is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Lists all the VpnServerConfigurations in a subscription.

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

Returns

Type	Description
AsyncItemPaged[VpnServerConfiguration]	An iterator like instance of VpnServerConfiguration

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) -> AsyncItemPaged[VpnServerConfiguration]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
AsyncItemPaged[VpnServerConfiguration]	An iterator like instance of VpnServerConfiguration

Exceptions

Type	Description
HttpResponseError

list_radius_secrets

List all Radius servers with respective radius secrets from VpnServerConfiguration.

async list_radius_secrets(resource_group_name: str, vpn_server_configuration_name: str, **kwargs: Any) -> RadiusAuthServerListResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
vpn_server_configuration_name Required	str The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.

Returns

Type	Description
RadiusAuthServerListResult	RadiusAuthServerListResult. The RadiusAuthServerListResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

update_tags

Updates VpnServerConfiguration tags.

async 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 name of the resource group. The name is case insensitive. Required.
vpn_server_configuration_name Required	str The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
vpn_server_configuration_parameters Required	TagsObject or 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. The VpnServerConfiguration is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

意見反應

此頁面對您有幫助嗎？