VirtualNetworkGateways | @azure/arm-network-profile-2019-03-01-hybrid

Class representing a VirtualNetworkGateways.

Hierarchy

VirtualNetworkGateways

Constructors

constructor

new VirtualNetworkGateways(client: NetworkManagementClientContext): VirtualNetworkGateways

- Defined in operations/virtualNetworkGateways.ts:20
Create a VirtualNetworkGateways.

Parameters
- client: NetworkManagementClientContext
  
  Reference to the service client.
Returns VirtualNetworkGateways

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:358
Creates or updates a virtual network gateway in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: VirtualNetworkGateway
  
  Parameters supplied to create or update virtual network gateway operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:377
Deletes the specified virtual network gateway.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginGeneratevpnclientpackage

beginGeneratevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:436
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: VpnClientParameters
  
  Parameters supplied to the generate virtual network gateway VPN client package operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginGetAdvertisedRoutes

beginGetAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:513
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- peer: string
  
  The IP address of the peer
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginGetBgpPeerStatus

beginGetBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: Models.VirtualNetworkGatewaysBeginGetBgpPeerStatusOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:474
The GetBgpPeerStatus operation retrieves the status of all BGP peers.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: Models.VirtualNetworkGatewaysBeginGetBgpPeerStatusOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginGetLearnedRoutes

beginGetLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:493
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginGetVpnProfilePackageUrl

beginGetVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:456
Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginReset

beginReset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: Models.VirtualNetworkGatewaysBeginResetOptionalParams): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:415
Resets the primary of the virtual network gateway in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: Models.VirtualNetworkGatewaysBeginResetOptionalParams
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdateTags

beginUpdateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworkGateways.ts:396
Updates a virtual network gateway tags.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: TagsObject
  
  Parameters supplied to update virtual network gateway tags.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate

createOrUpdate(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VirtualNetworkGateway, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysCreateOrUpdateResponse>

- Defined in operations/virtualNetworkGateways.ts:38
Creates or updates a virtual network gateway in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: VirtualNetworkGateway
  
  Parameters supplied to create or update virtual network gateway operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysCreateOrUpdateResponse>

Promise<Models.VirtualNetworkGatewaysCreateOrUpdateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/virtualNetworkGateways.ts:82
Deletes the specified virtual network gateway.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

generateVpnProfile

generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysGenerateVpnProfileResponse>
generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, callback: msRest.ServiceCallback<string>): void
generateVpnProfile(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<string>): void

- Defined in operations/virtualNetworkGateways.ts:197
Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: VpnClientParameters
  
  Parameters supplied to the generate virtual network gateway VPN client package operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysGenerateVpnProfileResponse>

Promise<Models.VirtualNetworkGatewaysGenerateVpnProfileResponse>
- Defined in operations/virtualNetworkGateways.ts:205
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: VpnClientParameters
  
  Parameters supplied to the generate virtual network gateway VPN client package operation.
- callback: msRest.ServiceCallback<string>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:214
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: VpnClientParameters
  
  Parameters supplied to the generate virtual network gateway VPN client package operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<string>
  
  The callback
Returns void

generatevpnclientpackage

generatevpnclientpackage(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: VpnClientParameters, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysGeneratevpnclientpackageResponse>

- Defined in operations/virtualNetworkGateways.ts:182
Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: VpnClientParameters
  
  Parameters supplied to the generate virtual network gateway VPN client package operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysGeneratevpnclientpackageResponse>

Promise<Models.VirtualNetworkGatewaysGeneratevpnclientpackageResponse>

get

get(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysGetResponse>
get(resourceGroupName: string, virtualNetworkGatewayName: string, callback: msRest.ServiceCallback<VirtualNetworkGateway>): void
get(resourceGroupName: string, virtualNetworkGatewayName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGateway>): void

- Defined in operations/virtualNetworkGateways.ts:50
Gets the specified virtual network gateway by resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysGetResponse>

Promise<Models.VirtualNetworkGatewaysGetResponse>
- Defined in operations/virtualNetworkGateways.ts:56
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- callback: msRest.ServiceCallback<VirtualNetworkGateway>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:63
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGateway>
  
  The callback
Returns void

getAdvertisedRoutes

getAdvertisedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, peer: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysGetAdvertisedRoutesResponse>

- Defined in operations/virtualNetworkGateways.ts:306
This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- peer: string
  
  The IP address of the peer
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysGetAdvertisedRoutesResponse>

Promise<Models.VirtualNetworkGatewaysGetAdvertisedRoutesResponse>

getBgpPeerStatus

getBgpPeerStatus(resourceGroupName: string, virtualNetworkGatewayName: string, options?: Models.VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams): Promise<Models.VirtualNetworkGatewaysGetBgpPeerStatusResponse>

- Defined in operations/virtualNetworkGateways.ts:247
The GetBgpPeerStatus operation retrieves the status of all BGP peers.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: Models.VirtualNetworkGatewaysGetBgpPeerStatusOptionalParams
Returns Promise<Models.VirtualNetworkGatewaysGetBgpPeerStatusResponse>

Promise<Models.VirtualNetworkGatewaysGetBgpPeerStatusResponse>

getLearnedRoutes

getLearnedRoutes(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysGetLearnedRoutesResponse>

- Defined in operations/virtualNetworkGateways.ts:292
This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysGetLearnedRoutesResponse>

Promise<Models.VirtualNetworkGatewaysGetLearnedRoutesResponse>

getVpnProfilePackageUrl

getVpnProfilePackageUrl(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>

- Defined in operations/virtualNetworkGateways.ts:235
Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>

Promise<Models.VirtualNetworkGatewaysGetVpnProfilePackageUrlResponse>

list

list(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysListResponse>
list(resourceGroupName: string, callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>): void
list(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>): void

- Defined in operations/virtualNetworkGateways.ts:106
Gets all virtual network gateways by resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysListResponse>

Promise<Models.VirtualNetworkGatewaysListResponse>
- Defined in operations/virtualNetworkGateways.ts:111
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:117
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>
  
  The callback
Returns void

listConnections

listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysListConnectionsResponse>
listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>): void
listConnections(resourceGroupName: string, virtualNetworkGatewayName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>): void

- Defined in operations/virtualNetworkGateways.ts:135
Gets all the connections in a virtual network gateway.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysListConnectionsResponse>

Promise<Models.VirtualNetworkGatewaysListConnectionsResponse>
- Defined in operations/virtualNetworkGateways.ts:141
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:148
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>
  
  The callback
Returns void

listConnectionsNext

listConnectionsNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysListConnectionsNextResponse>
listConnectionsNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>): void
listConnectionsNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>): void

- Defined in operations/virtualNetworkGateways.ts:559
Gets all the connections in a virtual network gateway.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysListConnectionsNextResponse>

Promise<Models.VirtualNetworkGatewaysListConnectionsNextResponse>
- Defined in operations/virtualNetworkGateways.ts:564
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:570
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListConnectionsResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>): void

- Defined in operations/virtualNetworkGateways.ts:531
Gets all virtual network gateways by resource group.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysListNextResponse>

Promise<Models.VirtualNetworkGatewaysListNextResponse>
- Defined in operations/virtualNetworkGateways.ts:536
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:542
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkGatewayListResult>
  
  The callback
Returns void

reset

reset(resourceGroupName: string, virtualNetworkGatewayName: string, options?: Models.VirtualNetworkGatewaysResetOptionalParams): Promise<Models.VirtualNetworkGatewaysResetResponse>

- Defined in operations/virtualNetworkGateways.ts:167
Resets the primary of the virtual network gateway in the specified resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: Models.VirtualNetworkGatewaysResetOptionalParams
Returns Promise<Models.VirtualNetworkGatewaysResetResponse>

Promise<Models.VirtualNetworkGatewaysResetResponse>

supportedVpnDevices

supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysSupportedVpnDevicesResponse>
supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, callback: msRest.ServiceCallback<string>): void
supportedVpnDevices(resourceGroupName: string, virtualNetworkGatewayName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<string>): void

- Defined in operations/virtualNetworkGateways.ts:259
Gets a xml format representation for supported vpn devices.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysSupportedVpnDevicesResponse>

Promise<Models.VirtualNetworkGatewaysSupportedVpnDevicesResponse>
- Defined in operations/virtualNetworkGateways.ts:265
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- callback: msRest.ServiceCallback<string>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:272
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<string>
  
  The callback
Returns void

updateTags

updateTags(resourceGroupName: string, virtualNetworkGatewayName: string, parameters: TagsObject, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysUpdateTagsResponse>

- Defined in operations/virtualNetworkGateways.ts:95
Updates a virtual network gateway tags.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayName: string
  
  The name of the virtual network gateway.
- parameters: TagsObject
  
  Parameters supplied to update virtual network gateway tags.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysUpdateTagsResponse>

Promise<Models.VirtualNetworkGatewaysUpdateTagsResponse>

vpnDeviceConfigurationScript

vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>
vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, callback: msRest.ServiceCallback<string>): void
vpnDeviceConfigurationScript(resourceGroupName: string, virtualNetworkGatewayConnectionName: string, parameters: VpnDeviceScriptParameters, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<string>): void

- Defined in operations/virtualNetworkGateways.ts:320
Gets a xml format representation for vpn device configuration script.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection for which the configuration script is generated.
- parameters: VpnDeviceScriptParameters
  
  Parameters supplied to the generate vpn device script operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>

Promise<Models.VirtualNetworkGatewaysVpnDeviceConfigurationScriptResponse>
- Defined in operations/virtualNetworkGateways.ts:328
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection for which the configuration script is generated.
- parameters: VpnDeviceScriptParameters
  
  Parameters supplied to the generate vpn device script operation.
- callback: msRest.ServiceCallback<string>
  
  The callback
Returns void
- Defined in operations/virtualNetworkGateways.ts:337
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkGatewayConnectionName: string
  
  The name of the virtual network gateway connection for which the configuration script is generated.
- parameters: VpnDeviceScriptParameters
  
  Parameters supplied to the generate vpn device script operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<string>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: NetworkManagementClientContext

Returns VirtualNetworkGateways

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

parameters: VirtualNetworkGateway

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginGeneratevpnclientpackage

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

parameters: VpnClientParameters

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginGetAdvertisedRoutes

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

peer: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginGetBgpPeerStatus

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

Optional options: Models.VirtualNetworkGatewaysBeginGetBgpPeerStatusOptionalParams

Returns Promise<msRestAzure.LROPoller>

beginGetLearnedRoutes

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginGetVpnProfilePackageUrl

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginReset

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

Optional options: Models.VirtualNetworkGatewaysBeginResetOptionalParams

Returns Promise<msRestAzure.LROPoller>

beginUpdateTags

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

parameters: TagsObject

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

createOrUpdate

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

parameters: VirtualNetworkGateway

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualNetworkGatewaysCreateOrUpdateResponse>

deleteMethod

Parameters

resourceGroupName: string

virtualNetworkGatewayName: string

Optional options: msRest.RequestOptionsBase