VpnSitesOperations interface

Package:
@azure/arm-network

Interface representing a VpnSites operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate

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

Deletes a VpnSite.
get

Retrieves the details of a VPN site.
list

Lists all the VpnSites in a subscription.
listByResourceGroup

Lists all the vpnSites in a resource group.
updateTags

Updates VpnSite tags.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

createOrUpdate

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

createOrUpdate: (resourceGroupName: string, vpnSiteName: string, vpnSiteParameters: VpnSite, options?: VpnSitesCreateOrUpdateOptionalParams) => PollerLike<OperationState<VpnSite>, VpnSite>

Property Value

(resourceGroupName: string, vpnSiteName: string, vpnSiteParameters: VpnSite, options?: VpnSitesCreateOrUpdateOptionalParams) => PollerLike<OperationState<VpnSite>, VpnSite>

delete

Deletes a VpnSite.

delete: (resourceGroupName: string, vpnSiteName: string, options?: VpnSitesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, vpnSiteName: string, options?: VpnSitesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Retrieves the details of a VPN site.

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

Property Value

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

list

Lists all the VpnSites in a subscription.

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

Property Value

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

listByResourceGroup

Lists all the vpnSites in a resource group.

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

Property Value

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

updateTags

Updates VpnSite tags.

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

Property Value

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