VpnServerConfigurations interface

Package:

@azure/arm-network

Interface representing a VpnServerConfigurations.

Methods

beginCreateOrUpdate(string, string, VpnServerConfiguration, VpnServerConfigurationsCreateOrUpdateOptionalParams)	Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.
beginCreateOrUpdateAndWait(string, string, VpnServerConfiguration, VpnServerConfigurationsCreateOrUpdateOptionalParams)	Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.
beginDelete(string, string, VpnServerConfigurationsDeleteOptionalParams)	Deletes a VpnServerConfiguration.
beginDeleteAndWait(string, string, VpnServerConfigurationsDeleteOptionalParams)	Deletes a VpnServerConfiguration.
get(string, string, VpnServerConfigurationsGetOptionalParams)	Retrieves the details of a VpnServerConfiguration.
list(VpnServerConfigurationsListOptionalParams)	Lists all the VpnServerConfigurations in a subscription.
listByResourceGroup(string, VpnServerConfigurationsListByResourceGroupOptionalParams)	Lists all the vpnServerConfigurations in a resource group.
updateTags(string, string, TagsObject, VpnServerConfigurationsUpdateTagsOptionalParams)	Updates VpnServerConfiguration tags.

Method Details

beginCreateOrUpdate(string, string, VpnServerConfiguration, VpnServerConfigurationsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, vpnServerConfigurationName: string, vpnServerConfigurationParameters: VpnServerConfiguration, options?: VpnServerConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VpnServerConfiguration>, VpnServerConfiguration>>

Parameters

resourceGroupName

string

The resource group name of the VpnServerConfiguration.

vpnServerConfigurationName

string

The name of the VpnServerConfiguration being created or updated.

vpnServerConfigurationParameters

VpnServerConfiguration

Parameters supplied to create or update VpnServerConfiguration.

options

VpnServerConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnServerConfiguration>, VpnServerConfiguration>>

beginCreateOrUpdateAndWait(string, string, VpnServerConfiguration, VpnServerConfigurationsCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, vpnServerConfigurationName: string, vpnServerConfigurationParameters: VpnServerConfiguration, options?: VpnServerConfigurationsCreateOrUpdateOptionalParams): Promise<VpnServerConfiguration>

Parameters

resourceGroupName

string

The resource group name of the VpnServerConfiguration.

vpnServerConfigurationName

string

The name of the VpnServerConfiguration being created or updated.

vpnServerConfigurationParameters

VpnServerConfiguration

Parameters supplied to create or update VpnServerConfiguration.

options

VpnServerConfigurationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VpnServerConfiguration>

beginDelete(string, string, VpnServerConfigurationsDeleteOptionalParams)

Deletes a VpnServerConfiguration.

function beginDelete(resourceGroupName: string, vpnServerConfigurationName: string, options?: VpnServerConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The resource group name of the VpnServerConfiguration.

vpnServerConfigurationName

string

The name of the VpnServerConfiguration being deleted.

options

VpnServerConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, VpnServerConfigurationsDeleteOptionalParams)

Deletes a VpnServerConfiguration.

function beginDeleteAndWait(resourceGroupName: string, vpnServerConfigurationName: string, options?: VpnServerConfigurationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name of the VpnServerConfiguration.

vpnServerConfigurationName

string

The name of the VpnServerConfiguration being deleted.

options

VpnServerConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, VpnServerConfigurationsGetOptionalParams)

Retrieves the details of a VpnServerConfiguration.

function get(resourceGroupName: string, vpnServerConfigurationName: string, options?: VpnServerConfigurationsGetOptionalParams): Promise<VpnServerConfiguration>

Parameters

resourceGroupName

string

The resource group name of the VpnServerConfiguration.

vpnServerConfigurationName

string

The name of the VpnServerConfiguration being retrieved.

options

VpnServerConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<VpnServerConfiguration>

list(VpnServerConfigurationsListOptionalParams)

Lists all the VpnServerConfigurations in a subscription.

function list(options?: VpnServerConfigurationsListOptionalParams): PagedAsyncIterableIterator<VpnServerConfiguration, VpnServerConfiguration[], PageSettings>

Parameters

options

VpnServerConfigurationsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnServerConfiguration, VpnServerConfiguration[], PageSettings>

listByResourceGroup(string, VpnServerConfigurationsListByResourceGroupOptionalParams)

Lists all the vpnServerConfigurations in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: VpnServerConfigurationsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VpnServerConfiguration, VpnServerConfiguration[], PageSettings>

Parameters

resourceGroupName

string

The resource group name of the VpnServerConfiguration.

options

VpnServerConfigurationsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnServerConfiguration, VpnServerConfiguration[], PageSettings>

updateTags(string, string, TagsObject, VpnServerConfigurationsUpdateTagsOptionalParams)

Updates VpnServerConfiguration tags.

function updateTags(resourceGroupName: string, vpnServerConfigurationName: string, vpnServerConfigurationParameters: TagsObject, options?: VpnServerConfigurationsUpdateTagsOptionalParams): Promise<VpnServerConfiguration>

Parameters

resourceGroupName

string

The resource group name of the VpnServerConfiguration.

vpnServerConfigurationName

string

The name of the VpnServerConfiguration being updated.

vpnServerConfigurationParameters

TagsObject

Parameters supplied to update VpnServerConfiguration tags.

options

VpnServerConfigurationsUpdateTagsOptionalParams

The options parameters.

Returns

Promise<VpnServerConfiguration>