VpnSites interface

Package:

@azure/arm-network

Interface representing a VpnSites.

Methods

beginCreateOrUpdate(string, string, VpnSite, VpnSitesCreateOrUpdateOptionalParams)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
beginCreateOrUpdateAndWait(string, string, VpnSite, VpnSitesCreateOrUpdateOptionalParams)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
beginDelete(string, string, VpnSitesDeleteOptionalParams)	Deletes a VpnSite.
beginDeleteAndWait(string, string, VpnSitesDeleteOptionalParams)	Deletes a VpnSite.
get(string, string, VpnSitesGetOptionalParams)	Retrieves the details of a VPN site.
list(VpnSitesListOptionalParams)	Lists all the VpnSites in a subscription.
listByResourceGroup(string, VpnSitesListByResourceGroupOptionalParams)	Lists all the vpnSites in a resource group.
updateTags(string, string, TagsObject, VpnSitesUpdateTagsOptionalParams)	Updates VpnSite tags.

Method Details

beginCreateOrUpdate(string, string, VpnSite, VpnSitesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(resourceGroupName: string, vpnSiteName: string, vpnSiteParameters: VpnSite, options?: VpnSitesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VpnSite>, VpnSite>>

Parameters

resourceGroupName

string

The resource group name of the VpnSite.

vpnSiteName

string

The name of the VpnSite being created or updated.

vpnSiteParameters

VpnSite

Parameters supplied to create or update VpnSite.

options

VpnSitesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, VpnSite, VpnSitesCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdateAndWait(resourceGroupName: string, vpnSiteName: string, vpnSiteParameters: VpnSite, options?: VpnSitesCreateOrUpdateOptionalParams): Promise<VpnSite>

Parameters

resourceGroupName

string

The resource group name of the VpnSite.

vpnSiteName

string

The name of the VpnSite being created or updated.

vpnSiteParameters

VpnSite

Parameters supplied to create or update VpnSite.

options

VpnSitesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<VpnSite>

beginDelete(string, string, VpnSitesDeleteOptionalParams)

Deletes a VpnSite.

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

Parameters

resourceGroupName

string

The resource group name of the VpnSite.

vpnSiteName

string

The name of the VpnSite being deleted.

options

VpnSitesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, VpnSitesDeleteOptionalParams)

Deletes a VpnSite.

function beginDeleteAndWait(resourceGroupName: string, vpnSiteName: string, options?: VpnSitesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The resource group name of the VpnSite.

vpnSiteName

string

The name of the VpnSite being deleted.

options

VpnSitesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, VpnSitesGetOptionalParams)

Retrieves the details of a VPN site.

function get(resourceGroupName: string, vpnSiteName: string, options?: VpnSitesGetOptionalParams): Promise<VpnSite>

Parameters

resourceGroupName

string

The resource group name of the VpnSite.

vpnSiteName

string

The name of the VpnSite being retrieved.

options

VpnSitesGetOptionalParams

The options parameters.

Returns

Promise<VpnSite>

list(VpnSitesListOptionalParams)

Lists all the VpnSites in a subscription.

function list(options?: VpnSitesListOptionalParams): PagedAsyncIterableIterator<VpnSite, VpnSite[], PageSettings>

Parameters

options

VpnSitesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnSite, VpnSite[], PageSettings>

listByResourceGroup(string, VpnSitesListByResourceGroupOptionalParams)

Lists all the vpnSites in a resource group.

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

Parameters

resourceGroupName

string

The resource group name of the VpnSite.

options

VpnSitesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VpnSite, VpnSite[], PageSettings>

updateTags(string, string, TagsObject, VpnSitesUpdateTagsOptionalParams)

Updates VpnSite tags.

function updateTags(resourceGroupName: string, vpnSiteName: string, vpnSiteParameters: TagsObject, options?: VpnSitesUpdateTagsOptionalParams): Promise<VpnSite>

Parameters

resourceGroupName

string

The resource group name of the VpnSite.

vpnSiteName

string

The name of the VpnSite being updated.

vpnSiteParameters

TagsObject

Parameters supplied to update VpnSite tags.

options

VpnSitesUpdateTagsOptionalParams

The options parameters.

Returns

Promise<VpnSite>