P2SVpnGateways interface
Interface representing a P2SVpnGateways.
Methods
Method Details
beginCreateOrUpdate(string, string, P2SVpnGateway, P2SVpnGatewaysCreateOrUpdateOptionalParams)
Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.
function beginCreateOrUpdate(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
- p2SVpnGatewayParameters
- P2SVpnGateway
Parameters supplied to create or Update a virtual wan p2s vpn gateway.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>
beginCreateOrUpdateAndWait(string, string, P2SVpnGateway, P2SVpnGatewaysCreateOrUpdateOptionalParams)
Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.
function beginCreateOrUpdateAndWait(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: P2SVpnGateway, options?: P2SVpnGatewaysCreateOrUpdateOptionalParams): Promise<P2SVpnGateway>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
- p2SVpnGatewayParameters
- P2SVpnGateway
Parameters supplied to create or Update a virtual wan p2s vpn gateway.
The options parameters.
Returns
Promise<P2SVpnGateway>
beginDelete(string, string, P2SVpnGatewaysDeleteOptionalParams)
Deletes a virtual wan p2s vpn gateway.
function beginDelete(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, P2SVpnGatewaysDeleteOptionalParams)
Deletes a virtual wan p2s vpn gateway.
function beginDeleteAndWait(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
The options parameters.
Returns
Promise<void>
beginDisconnectP2SVpnConnections(string, string, P2SVpnConnectionRequest, P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams)
Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.
function beginDisconnectP2SVpnConnections(resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- p2SVpnGatewayName
-
string
The name of the P2S Vpn Gateway.
- request
- P2SVpnConnectionRequest
The parameters are supplied to disconnect p2s vpn connections.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDisconnectP2SVpnConnectionsAndWait(string, string, P2SVpnConnectionRequest, P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams)
Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.
function beginDisconnectP2SVpnConnectionsAndWait(resourceGroupName: string, p2SVpnGatewayName: string, request: P2SVpnConnectionRequest, options?: P2SVpnGatewaysDisconnectP2SVpnConnectionsOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- p2SVpnGatewayName
-
string
The name of the P2S Vpn Gateway.
- request
- P2SVpnConnectionRequest
The parameters are supplied to disconnect p2s vpn connections.
The options parameters.
Returns
Promise<void>
beginGenerateVpnProfile(string, string, P2SVpnProfileParameters, P2SVpnGatewaysGenerateVpnProfileOptionalParams)
Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
function beginGenerateVpnProfile(resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams): Promise<SimplePollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the P2SVpnGateway.
- parameters
- P2SVpnProfileParameters
Parameters supplied to the generate P2SVpnGateway VPN client package operation.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>>
beginGenerateVpnProfileAndWait(string, string, P2SVpnProfileParameters, P2SVpnGatewaysGenerateVpnProfileOptionalParams)
Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
function beginGenerateVpnProfileAndWait(resourceGroupName: string, gatewayName: string, parameters: P2SVpnProfileParameters, options?: P2SVpnGatewaysGenerateVpnProfileOptionalParams): Promise<VpnProfileResponse>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the P2SVpnGateway.
- parameters
- P2SVpnProfileParameters
Parameters supplied to the generate P2SVpnGateway VPN client package operation.
The options parameters.
Returns
Promise<VpnProfileResponse>
beginGetP2SVpnConnectionHealth(string, string, P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams)
Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
function beginGetP2SVpnConnectionHealth(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams): Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the P2SVpnGateway.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>
beginGetP2SVpnConnectionHealthAndWait(string, string, P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams)
Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
function beginGetP2SVpnConnectionHealthAndWait(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthOptionalParams): Promise<P2SVpnGateway>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the P2SVpnGateway.
The options parameters.
Returns
Promise<P2SVpnGateway>
beginGetP2SVpnConnectionHealthDetailed(string, string, P2SVpnConnectionHealthRequest, P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams)
Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
function beginGetP2SVpnConnectionHealthDetailed(resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams): Promise<SimplePollerLike<OperationState<P2SVpnConnectionHealth>, P2SVpnConnectionHealth>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the P2SVpnGateway.
- request
- P2SVpnConnectionHealthRequest
Request parameters supplied to get p2s vpn connections detailed health.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<P2SVpnConnectionHealth>, P2SVpnConnectionHealth>>
beginGetP2SVpnConnectionHealthDetailedAndWait(string, string, P2SVpnConnectionHealthRequest, P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams)
Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
function beginGetP2SVpnConnectionHealthDetailedAndWait(resourceGroupName: string, gatewayName: string, request: P2SVpnConnectionHealthRequest, options?: P2SVpnGatewaysGetP2SVpnConnectionHealthDetailedOptionalParams): Promise<P2SVpnConnectionHealth>Parameters
- resourceGroupName
-
string
The name of the resource group.
- gatewayName
-
string
The name of the P2SVpnGateway.
- request
- P2SVpnConnectionHealthRequest
Request parameters supplied to get p2s vpn connections detailed health.
The options parameters.
Returns
Promise<P2SVpnConnectionHealth>
beginReset(string, string, P2SVpnGatewaysResetOptionalParams)
Resets the primary of the p2s vpn gateway in the specified resource group.
function beginReset(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams): Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>
beginResetAndWait(string, string, P2SVpnGatewaysResetOptionalParams)
Resets the primary of the p2s vpn gateway in the specified resource group.
function beginResetAndWait(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysResetOptionalParams): Promise<P2SVpnGateway>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
The options parameters.
Returns
Promise<P2SVpnGateway>
beginUpdateTags(string, string, TagsObject, P2SVpnGatewaysUpdateTagsOptionalParams)
Updates virtual wan p2s vpn gateway tags.
function beginUpdateTags(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
- p2SVpnGatewayParameters
- TagsObject
Parameters supplied to update a virtual wan p2s vpn gateway tags.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<P2SVpnGateway>, P2SVpnGateway>>
beginUpdateTagsAndWait(string, string, TagsObject, P2SVpnGatewaysUpdateTagsOptionalParams)
Updates virtual wan p2s vpn gateway tags.
function beginUpdateTagsAndWait(resourceGroupName: string, gatewayName: string, p2SVpnGatewayParameters: TagsObject, options?: P2SVpnGatewaysUpdateTagsOptionalParams): Promise<P2SVpnGateway>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
- p2SVpnGatewayParameters
- TagsObject
Parameters supplied to update a virtual wan p2s vpn gateway tags.
The options parameters.
Returns
Promise<P2SVpnGateway>
get(string, string, P2SVpnGatewaysGetOptionalParams)
Retrieves the details of a virtual wan p2s vpn gateway.
function get(resourceGroupName: string, gatewayName: string, options?: P2SVpnGatewaysGetOptionalParams): Promise<P2SVpnGateway>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
- gatewayName
-
string
The name of the gateway.
- options
- P2SVpnGatewaysGetOptionalParams
The options parameters.
Returns
Promise<P2SVpnGateway>
list(P2SVpnGatewaysListOptionalParams)
Lists all the P2SVpnGateways in a subscription.
function list(options?: P2SVpnGatewaysListOptionalParams): PagedAsyncIterableIterator<P2SVpnGateway, P2SVpnGateway[], PageSettings>Parameters
- options
- P2SVpnGatewaysListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, P2SVpnGatewaysListByResourceGroupOptionalParams)
Lists all the P2SVpnGateways in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: P2SVpnGatewaysListByResourceGroupOptionalParams): PagedAsyncIterableIterator<P2SVpnGateway, P2SVpnGateway[], PageSettings>Parameters
- resourceGroupName
-
string
The resource group name of the P2SVpnGateway.
The options parameters.