{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-network-virtualnetworkgateway","description":"NetworkManagementClient","version":"2019-07-01","base_url":"https://management.azure.com","endpoints":36,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api NetworkManagementClient\n@base https://management.azure.com\n@version 2019-07-01\n@auth OAuth2\n@common_fields {resourceGroupName: any # The name of the resource group.}\n@endpoints 36\n@hint download_for_search\n@toc subscriptions(36)\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}\n@desc Creates or updates a virtual network gateway in the specified resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway., parameters: any # Parameters supplied to create or update virtual network gateway operation.}\n@returns(200) Update successful. The operation returns the resulting VirtualNetworkGateway resource.\n@returns(201) Create successful. The operation returns the resulting VirtualNetworkGateway resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}\n@desc Gets the specified virtual network gateway by resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) Request successful. The operation returns a VirtualNetworkGateway resource.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}\n@desc Deletes the specified virtual network gateway.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) Delete successful.\n@returns(202) Accepted and the operation will complete asynchronously.\n@returns(204) Delete successful.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}\n@desc Updates a virtual network gateway tags.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway., parameters: any # Parameters supplied to update virtual network gateway tags.}\n@returns(200) Update successful. The operation returns the resulting VirtualNetworkGateway resource.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways\n@desc Gets all virtual network gateways by resource group.\n@returns(200) Request successful. The operation returns a list of VirtualNetworkGateway resources.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections\n@desc Gets all the connections in a virtual network gateway.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset\n@desc Resets the primary of the virtual network gateway in the specified resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@optional {gatewayVip: any # Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway.}\n@returns(200) Request successful. The operation reset the primary of the virtual network gateway.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/resetvpnclientsharedkey\n@desc Resets the VPN client shared key of the virtual network gateway in the specified resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) Request successful. The operation reset the vpn client shared key of the virtual network gateway.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage\n@desc Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway., parameters: any # Parameters supplied to the generate virtual network gateway VPN client package operation.}\n@returns(200) VPN client package URL.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile\n@desc Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway., parameters: any # Parameters supplied to the generate virtual network gateway VPN client package operation.}\n@returns(200) VPN profile package URL.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl\n@desc 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.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) VPN profile package URL.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus\n@desc The GetBgpPeerStatus operation retrieves the status of all BGP peers.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@optional {peer: any # The IP address of the peer to retrieve the status of.}\n@returns(200) List of BGP peer statuses.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices\n@desc Gets a xml format representation for supported vpn devices.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) Xml format representation for supported vpn devices.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes\n@desc This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) List of advertised BGP routes.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes\n@desc This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway., peer: any # The IP address of the peer.}\n@returns(200) List of learned BGP routes.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters\n@desc The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway., vpnclientIpsecParams: any # Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider.}\n@returns(200) Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters\n@desc The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.\n@required {virtualNetworkGatewayName: any # The virtual network gateway name.}\n@returns(200) Request successful. The operation returns the set vpnclient ipsec parameters for P2S client of VirtualNetworkGateway resource.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/vpndeviceconfigurationscript\n@desc Gets a xml format representation for vpn device configuration script.\n@required {virtualNetworkGatewayConnectionName: any # The name of the virtual network gateway connection for which the configuration script is generated., parameters: any # Parameters supplied to the generate vpn device script operation.}\n@returns(200) Xml format representation for vpn device configuration script.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startPacketCapture\n@desc Starts packet capture on virtual network gateway in the specified resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@optional {parameters: any # Virtual network gateway packet capture parameters supplied to start packet capture on gateway.}\n@returns(200) Request successful. The operation packet capture started on virtual network gateway.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopPacketCapture\n@desc Stops packet capture on virtual network gateway in the specified resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway., parameters: any # Virtual network gateway packet capture parameters supplied to stop packet capture on gateway.}\n@returns(200) Request successful. The operation packet capture stopped on virtual network gateway.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}\n@desc Creates or updates a virtual network gateway connection in the specified resource group.\n@required {virtualNetworkGatewayConnectionName: any # The name of the virtual network gateway connection., parameters: any # Parameters supplied to the create or update virtual network gateway connection operation.}\n@returns(200) Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.\n@returns(201) Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}\n@desc Gets the specified virtual network gateway connection by resource group.\n@required {virtualNetworkGatewayConnectionName: any # The name of the virtual network gateway connection.}\n@returns(200) Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}\n@desc Deletes the specified virtual network Gateway connection.\n@required {virtualNetworkGatewayConnectionName: any # The name of the virtual network gateway connection.}\n@returns(200) Delete successful.\n@returns(202) Accepted and the operation will complete asynchronously.\n@returns(204) Delete successful.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}\n@desc Updates a virtual network gateway connection tags.\n@required {virtualNetworkGatewayConnectionName: any # The name of the virtual network gateway connection., parameters: any # Parameters supplied to update virtual network gateway connection tags.}\n@returns(200) Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey\n@desc The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.\n@required {virtualNetworkGatewayConnectionName: any # The virtual network gateway connection name., parameters: any # Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider.}\n@returns(200) Request successful. The operation returns the resulting ConnectionSharedKey resource.\n@returns(201) Request successful. The operation returns the resulting ConnectionSharedKey resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey\n@desc The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.\n@required {virtualNetworkGatewayConnectionName: any # The virtual network gateway connection shared key name.}\n@returns(200) Request successful. The operation returns a list of VirtualNetworkGatewayConnection resources.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections\n@desc The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.\n@returns(200) Request successful. The operation resets the virtual network gateway connection shared key.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset\n@desc The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.\n@required {virtualNetworkGatewayConnectionName: any # The virtual network gateway connection reset shared key Name., parameters: any # Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider.}\n@returns(200) Request successful. The operation sets the virtual network gateway connection shared key.\n@returns(202) Request successful. The operation sets the virtual network gateway connection shared key.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/startPacketCapture\n@desc Starts packet capture on virtual network gateway connection in the specified resource group.\n@required {virtualNetworkGatewayConnectionName: any # The name of the virtual network gateway connection.}\n@optional {parameters: any # Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection.}\n@returns(200) Request successful. The operation packet capture started on virtual network gateway connection.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/stopPacketCapture\n@desc Stops packet capture on virtual network gateway connection in the specified resource group.\n@required {virtualNetworkGatewayConnectionName: any # The name of the virtual network gateway Connection., parameters: any # Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection.}\n@returns(200) Request successful. The operation packet capture stopped on virtual network gateway connection.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}\n@desc Creates or updates a local network gateway in the specified resource group.\n@required {localNetworkGatewayName: any # The name of the local network gateway., parameters: any # Parameters supplied to the create or update local network gateway operation.}\n@returns(200) Update successful. The operation returns the resulting LocalNetworkGateway resource.\n@returns(201) Create successful. The operation returns the resulting LocalNetworkGateway resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}\n@desc Gets the specified local network gateway in a resource group.\n@required {localNetworkGatewayName: any # The name of the local network gateway.}\n@returns(200) Request successful. The operation returns the resulting LocalNetworkGateway resource.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}\n@desc Deletes the specified local network gateway.\n@required {localNetworkGatewayName: any # The name of the local network gateway.}\n@returns(200) Delete successful.\n@returns(202) Accepted and the operation will complete asynchronously.\n@returns(204) Delete successful.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}\n@desc Updates a local network gateway tags.\n@required {localNetworkGatewayName: any # The name of the local network gateway., parameters: any # Parameters supplied to update local network gateway tags.}\n@returns(200) Update successful. The operation returns the resulting LocalNetworkGateway resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways\n@desc Gets all the local network gateways in a resource group.\n@returns(200) Request successful. The operation returns a list of LocalNetworkGateway resources.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth\n@desc Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.\n@required {virtualNetworkGatewayName: any # The name of the virtual network gateway.}\n@returns(200) List of VPN client connection health details.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@end\n"}