openapi-directory/api/azure.com/network-virtualNetworkGateway.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.","title":"NetworkManagementClient","version":"2019-07-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/virtualNetworkGateway.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-virtualNetworkGateway","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections":{"get":{"description":"The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.","operationId":"VirtualNetworkGatewayConnections_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"ListVirtualNetworkGatewayConnectionsinResourceGroup":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ListVirtualNetworkGatewayConnectionsinResourceGroup":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ListVirtualNetworkGatewayConnectionsinResourceGroup":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation resets the virtual network gateway connection shared key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayConnectionListResult"},"examples":{"ListVirtualNetworkGatewayConnectionsinResourceGroup":{"$ref":"#/components/examples/ListVirtualNetworkGatewayConnectionsinResourceGroup"}}}}}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}":{"delete":{"description":"Deletes the specified virtual network Gateway connection.","operationId":"VirtualNetworkGatewayConnections_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGatewayConnection":{"value":"rg1"}}},{"description":"The name of the virtual network gateway connection.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGatewayConnection":{"value":"conn1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGatewayConnection":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGatewayConnection":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Delete successful."}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified virtual network gateway connection by resource group.","operationId":"VirtualNetworkGatewayConnections_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnection":{"value":"rg1"}}},{"description":"The name of the virtual network gateway connection.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnection":{"value":"connS2S"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnection":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnection":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayConnection"},"examples":{"GetVirtualNetworkGatewayConnection":{"$ref":"#/components/examples/GetVirtualNetworkGatewayConnection"}}}}}},"tags":["VirtualNetworkGatewayConnections"]},"patch":{"description":"Updates a virtual network gateway connection tags.","operationId":"VirtualNetworkGatewayConnections_UpdateTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayConnectionTags":{"value":"rg1"}}},{"description":"The name of the virtual network gateway connection.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayConnectionTags":{"value":"test"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayConnectionTags":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayConnectionTags":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Tags object for patch operations.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}}}}},"description":"Parameters supplied to update virtual network gateway connection tags.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayConnection"},"examples":{"UpdateVirtualNetworkGatewayConnectionTags":{"$ref":"#/components/examples/UpdateVirtualNetworkGatewayConnectionTags"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously."}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}},"put":{"description":"Creates or updates a virtual network gateway connection in the specified resource group.","operationId":"VirtualNetworkGatewayConnections_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"CreateVirtualNetworkGatewayConnection_S2S":{"value":"rg1"}}},{"description":"The name of the virtual network gateway connection.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"CreateVirtualNetworkGatewayConnection_S2S":{"value":"connS2S"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"CreateVirtualNetworkGatewayConnection_S2S":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"CreateVirtualNetworkGatewayConnection_S2S":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayConnection"}}},"description":"Parameters supplied to the create or update virtual network gateway connection operation.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayConnection"},"examples":{"CreateVirtualNetworkGatewayConnection_S2S":{"$ref":"#/components/examples/CreateVirtualNetworkGatewayConnection_S2S"}}}}},"201":{"description":"Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayConnection"},"examples":{"CreateVirtualNetworkGatewayConnection_S2S":{"$ref":"#/components/examples/CreateVirtualNetworkGatewayConnection_S2S"}}}}}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey":{"get":{"description":"The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.","operationId":"VirtualNetworkGatewayConnections_GetSharedKey","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnectionSharedKey":{"value":"rg1"}}},{"description":"The virtual network gateway connection shared key name.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnectionSharedKey":{"value":"connS2S"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnectionSharedKey":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayConnectionSharedKey":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of VirtualNetworkGatewayConnection resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSharedKey"},"examples":{"GetVirtualNetworkGatewayConnectionSharedKey":{"$ref":"#/components/examples/GetVirtualNetworkGatewayConnectionSharedKey"}}}}}},"tags":["VirtualNetworkGatewayConnections"]},"put":{"description":"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.","operationId":"VirtualNetworkGatewayConnections_SetSharedKey","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"SetVirtualNetworkGatewayConnectionSharedKey":{"value":"rg1"}}},{"description":"The virtual network gateway connection name.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"SetVirtualNetworkGatewayConnectionSharedKey":{"value":"connS2S"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"SetVirtualNetworkGatewayConnectionSharedKey":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"SetVirtualNetworkGatewayConnectionSharedKey":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSharedKey"}}},"description":"Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the resulting ConnectionSharedKey resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSharedKey"},"examples":{"SetVirtualNetworkGatewayConnectionSharedKey":{"$ref":"#/components/examples/SetVirtualNetworkGatewayConnectionSharedKey"}}}}},"201":{"description":"Request successful. The operation returns the resulting ConnectionSharedKey resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionSharedKey"},"examples":{"SetVirtualNetworkGatewayConnectionSharedKey":{"$ref":"#/components/examples/SetVirtualNetworkGatewayConnectionSharedKey"}}}}}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset":{"post":{"description":"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.","operationId":"VirtualNetworkGatewayConnections_ResetSharedKey","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"ResetVirtualNetworkGatewayConnectionSharedKey":{"value":"rg1"}}},{"description":"The virtual network gateway connection reset shared key Name.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"ResetVirtualNetworkGatewayConnectionSharedKey":{"value":"conn1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ResetVirtualNetworkGatewayConnectionSharedKey":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ResetVirtualNetworkGatewayConnectionSharedKey":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResetSharedKey"}}},"description":"Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider.","required":true},"responses":{"200":{"description":"Request successful. The operation sets the virtual network gateway connection shared key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResetSharedKey"},"examples":{"ResetVirtualNetworkGatewayConnectionSharedKey":{"$ref":"#/components/examples/ResetVirtualNetworkGatewayConnectionSharedKey"}}}}},"202":{"description":"Request successful. The operation sets the virtual network gateway connection shared key."}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/startPacketCapture":{"post":{"description":"Starts packet capture on virtual network gateway connection in the specified resource group.","operationId":"VirtualNetworkGatewayConnections_StartPacketCapture","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Start packet capture on virtual network gateway connection with filter":{"value":"rg1"},"Start packet capture on virtual network gateway connection without filter":{"value":"rg1"}}},{"description":"The name of the virtual network gateway connection.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"Start packet capture on virtual network gateway connection with filter":{"value":"vpngwcn1"},"Start packet capture on virtual network gateway connection without filter":{"value":"vpngwcn1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Start packet capture on virtual network gateway connection with filter":{"value":"2019-07-01"},"Start packet capture on virtual network gateway connection without filter":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Start packet capture on virtual network gateway connection with filter":{"value":"subid"},"Start packet capture on virtual network gateway connection without filter":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnPacketCaptureStartParameters"}}},"description":"Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection."},"responses":{"200":{"description":"Request successful. The operation packet capture started on virtual network gateway connection.","content":{"application/json":{"schema":{"type":"string"},"examples":{"Start packet capture on virtual network gateway connection with filter":{"$ref":"#/components/examples/Start_packet_capture_on_virtual_network_gateway_connection_with_filter"},"Start packet capture on virtual network gateway connection without filter":{"$ref":"#/components/examples/Start_packet_capture_on_virtual_network_gateway_connection_without_filter"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/stopPacketCapture":{"post":{"description":"Stops packet capture on virtual network gateway connection in the specified resource group.","operationId":"VirtualNetworkGatewayConnections_StopPacketCapture","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture on virtual network gateway connection":{"value":"rg1"}}},{"description":"The name of the virtual network gateway Connection.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture on virtual network gateway connection":{"value":"vpngwcn1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture on virtual network gateway connection":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Stop packet capture on virtual network gateway connection":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnPacketCaptureStopParameters"}}},"description":"Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection.","required":true},"responses":{"200":{"description":"Request successful. The operation packet capture stopped on virtual network gateway connection.","content":{"application/json":{"schema":{"type":"string"},"examples":{"Stop packet capture on virtual network gateway connection":{"$ref":"#/components/examples/Stop_packet_capture_on_virtual_network_gateway_connection"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Common error representation.","properties":{"code":{"description":"Error code.","type":"string"},"details":{"description":"Error details.","items":{"description":"Common error details representation.","properties":{"code":{"description":"Error code.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}},"type":"array"},"innerError":{"description":"Inner error message.","type":"string"},"message":{"description":"Error message.","type":"string"},"target":{"description":"Error target.","type":"string"}}}}}}},"tags":["VirtualNetworkGatewayConnections"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/vpndeviceconfigurationscript":{"post":{"description":"Gets a xml format representation for vpn device configuration script.","operationId":"VirtualNetworkGateways_VpnDeviceConfigurationScript","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GetVPNDeviceConfigurationScript":{"value":"rg1"}}},{"description":"The name of the virtual network gateway connection for which the configuration script is generated.","in":"path","name":"virtualNetworkGatewayConnectionName","required":true,"schema":{"type":"string"},"examples":{"GetVPNDeviceConfigurationScript":{"value":"vpngw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetVPNDeviceConfigurationScript":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetVPNDeviceConfigurationScript":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnDeviceScriptParameters"}}},"description":"Parameters supplied to the generate vpn device script operation.","required":true},"responses":{"200":{"description":"Xml format representation for vpn device configuration script.","content":{"application/json":{"schema":{"type":"string"},"examples":{"GetVPNDeviceConfigurationScript":{"$ref":"#/components/examples/GetVPNDeviceConfigurationScript"}}}}}},"tags":["VirtualNetworkGateways"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways":{"get":{"description":"Gets all the local network gateways in a resource group.","operationId":"LocalNetworkGateways_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"ListLocalNetworkGateways":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ListLocalNetworkGateways":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ListLocalNetworkGateways":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of LocalNetworkGateway resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalNetworkGatewayListResult"},"examples":{"ListLocalNetworkGateways":{"$ref":"#/components/examples/ListLocalNetworkGateways"}}}}}},"tags":["LocalNetworkGateways"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}":{"delete":{"description":"Deletes the specified local network gateway.","operationId":"LocalNetworkGateways_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"DeleteLocalNetworkGateway":{"value":"rg1"}}},{"description":"The name of the local network gateway.","in":"path","name":"localNetworkGatewayName","required":true,"schema":{"type":"string","minLength":1},"examples":{"DeleteLocalNetworkGateway":{"value":"localgw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"DeleteLocalNetworkGateway":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"DeleteLocalNetworkGateway":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Delete successful."}},"tags":["LocalNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified local network gateway in a resource group.","operationId":"LocalNetworkGateways_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GetLocalNetworkGateway":{"value":"rg1"}}},{"description":"The name of the local network gateway.","in":"path","name":"localNetworkGatewayName","required":true,"schema":{"type":"string","minLength":1},"examples":{"GetLocalNetworkGateway":{"value":"localgw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetLocalNetworkGateway":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetLocalNetworkGateway":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns the resulting LocalNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalNetworkGateway"},"examples":{"GetLocalNetworkGateway":{"$ref":"#/components/examples/GetLocalNetworkGateway"}}}}}},"tags":["LocalNetworkGateways"]},"patch":{"description":"Updates a local network gateway tags.","operationId":"LocalNetworkGateways_UpdateTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"UpdateLocalNetworkGatewayTags":{"value":"rg1"}}},{"description":"The name of the local network gateway.","in":"path","name":"localNetworkGatewayName","required":true,"schema":{"type":"string","minLength":1},"examples":{"UpdateLocalNetworkGatewayTags":{"value":"lgw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"UpdateLocalNetworkGatewayTags":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"UpdateLocalNetworkGatewayTags":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Tags object for patch operations.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}}}}},"description":"Parameters supplied to update local network gateway tags.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting LocalNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalNetworkGateway"},"examples":{"UpdateLocalNetworkGatewayTags":{"$ref":"#/components/examples/UpdateLocalNetworkGatewayTags"}}}}}},"tags":["LocalNetworkGateways"],"x-ms-long-running-operation":true},"put":{"description":"Creates or updates a local network gateway in the specified resource group.","operationId":"LocalNetworkGateways_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"CreateLocalNetworkGateway":{"value":"rg1"}}},{"description":"The name of the local network gateway.","in":"path","name":"localNetworkGatewayName","required":true,"schema":{"type":"string","minLength":1},"examples":{"CreateLocalNetworkGateway":{"value":"localgw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"CreateLocalNetworkGateway":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"CreateLocalNetworkGateway":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalNetworkGateway"}}},"description":"Parameters supplied to the create or update local network gateway operation.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting LocalNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalNetworkGateway"},"examples":{"CreateLocalNetworkGateway":{"$ref":"#/components/examples/CreateLocalNetworkGateway"}}}}},"201":{"description":"Create successful. The operation returns the resulting LocalNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalNetworkGateway"},"examples":{"CreateLocalNetworkGateway":{"$ref":"#/components/examples/CreateLocalNetworkGateway"}}}}}},"tags":["LocalNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways":{"get":{"description":"Gets all virtual network gateways by resource group.","operationId":"VirtualNetworkGateways_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"ListVirtualNetworkGatewaysinResourceGroup":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ListVirtualNetworkGatewaysinResourceGroup":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ListVirtualNetworkGatewaysinResourceGroup":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of VirtualNetworkGateway resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayListResult"},"examples":{"ListVirtualNetworkGatewaysinResourceGroup":{"$ref":"#/components/examples/ListVirtualNetworkGatewaysinResourceGroup"}}}}}},"tags":["VirtualNetworkGateways"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}":{"delete":{"description":"Deletes the specified virtual network gateway.","operationId":"VirtualNetworkGateways_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGateway":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGateway":{"value":"vpngw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGateway":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"DeleteVirtualNetworkGateway":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Delete successful."}},"tags":["VirtualNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified virtual network gateway by resource group.","operationId":"VirtualNetworkGateways_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGateway":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGateway":{"value":"vpngw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGateway":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGateway":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a VirtualNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGateway"},"examples":{"GetVirtualNetworkGateway":{"$ref":"#/components/examples/GetVirtualNetworkGateway"}}}}}},"tags":["VirtualNetworkGateways"]},"patch":{"description":"Updates a virtual network gateway tags.","operationId":"VirtualNetworkGateways_UpdateTags","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayTags":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayTags":{"value":"vpngw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayTags":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGatewayTags":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Tags object for patch operations.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}}}}},"description":"Parameters supplied to update virtual network gateway tags.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting VirtualNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGateway"},"examples":{"UpdateVirtualNetworkGatewayTags":{"$ref":"#/components/examples/UpdateVirtualNetworkGatewayTags"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously."}},"tags":["VirtualNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}},"put":{"description":"Creates or updates a virtual network gateway in the specified resource group.","operationId":"VirtualNetworkGateways_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGateway":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGateway":{"value":"vpngw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGateway":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"UpdateVirtualNetworkGateway":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGateway"}}},"description":"Parameters supplied to create or update virtual network gateway operation.","required":true},"responses":{"200":{"description":"Update successful. The operation returns the resulting VirtualNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGateway"},"examples":{"UpdateVirtualNetworkGateway":{"$ref":"#/components/examples/UpdateVirtualNetworkGateway"}}}}},"201":{"description":"Create successful. The operation returns the resulting VirtualNetworkGateway resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGateway"},"examples":{"UpdateVirtualNetworkGateway":{"$ref":"#/components/examples/UpdateVirtualNetworkGateway"}}}}}},"tags":["VirtualNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections":{"get":{"description":"Gets all the connections in a virtual network gateway.","operationId":"VirtualNetworkGateways_ListConnections","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualNetworkGatewaysListConnections":{"value":"testrg"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"VirtualNetworkGatewaysListConnections":{"value":"test-vpn-gateway-1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualNetworkGatewaysListConnections":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"VirtualNetworkGatewaysListConnections":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualNetworkGatewayListConnectionsResult"},"examples":{"VirtualNetworkGatewaysListConnections":{"$ref":"#/components/examples/VirtualNetworkGatewaysListConnections"}}}}}},"tags":["VirtualNetworkGateways"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage":{"post":{"description":"Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.","operationId":"VirtualNetworkGateways_Generatevpnclientpackage","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GenerateVPNClientPackage":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"GenerateVPNClientPackage":{"value":"vpngw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GenerateVPNClientPackage":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GenerateVPNClientPackage":{"value":"subid"}}}],"requestBody":{"$ref":"#/components/requestBodies/VpnClientParameters"},"responses":{"200":{"description":"VPN client package URL.","content":{"application/json":{"schema":{"type":"string"}}}},"202":{"description":"Accepted and the operation will complete asynchronously."}},"tags":["VirtualNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile":{"post":{"description":"Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.","operationId":"VirtualNetworkGateways_GenerateVpnProfile","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GenerateVirtualNetworkGatewayVPNProfile":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"GenerateVirtualNetworkGatewayVPNProfile":{"value":"vpngw"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GenerateVirtualNetworkGatewayVPNProfile":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GenerateVirtualNetworkGatewayVPNProfile":{"value":"subid"}}}],"requestBody":{"$ref":"#/components/requestBodies/VpnClientParameters"},"responses":{"200":{"description":"VPN profile package URL.","content":{"application/json":{"schema":{"type":"string"}}}},"202":{"description":"Accepted and the operation will complete asynchronously."}},"tags":["VirtualNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes":{"post":{"description":"This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.","operationId":"VirtualNetworkGateways_GetAdvertisedRoutes","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayAdvertisedRoutes":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayAdvertisedRoutes":{"value":"vpngw"}}},{"description":"The IP address of the peer.","in":"query","name":"peer","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayAdvertisedRoutes":{"value":"test"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayAdvertisedRoutes":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayAdvertisedRoutes":{"value":"subid"}}}],"responses":{"200":{"description":"List of learned BGP routes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayRouteListResult"},"examples":{"GetVirtualNetworkGatewayAdvertisedRoutes":{"$ref":"#/components/examples/GetVirtualNetworkGatewayAdvertisedRoutes"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously."}},"tags":["VirtualNetworkGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus":{"post":{"description":"The GetBgpPeerStatus operation retrieves the status of all BGP peers.","operationId":"VirtualNetworkGateways_GetBgpPeerStatus","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayBGPPeerStatus":{"value":"rg1"}}},{"description":"The name of the virtual network gateway.","in":"path","name":"virtualNetworkGatewayName","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayBGPPeerStatus":{"value":"vpngw"}}},{"description":"The IP address of the peer to retrieve the status of.","in":"query","name":"peer","required":false,"schema":{"type":"string"}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayBGPPeerStatus":{"value":"2019-07-01"}}},{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetVirtualNetworkGatewayBGPPeerStatus":{"value":"subid"}}}],"responses":{"200":{"description":"List of BGP peer statuses.","content":{"applica