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

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

{"openapi":"3.0.0","info":{"description":"REST API for Azure VirtualWAN As a Service.","title":"VirtualWANAsAServiceManagementClient","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/virtualWan.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-virtualWan","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways":{"get":{"description":"Lists all the P2SVpnGateways in a subscription.","operationId":"P2sVpnGateways_List","parameters":[{"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":{"P2SVpnGatewayListBySubscription":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayListBySubscription":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the P2SVpnGateways in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListP2SVpnGatewaysResult"},"examples":{"P2SVpnGatewayListBySubscription":{"$ref":"#/components/examples/P2SVpnGatewayListBySubscription"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs":{"get":{"description":"Lists all the VirtualHubs in a subscription.","operationId":"VirtualHubs_List","parameters":[{"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":{"VirtualHubList":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualHubList":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the VirtualHubs in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVirtualHubsResult"},"examples":{"VirtualHubList":{"$ref":"#/components/examples/VirtualHubList"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans":{"get":{"description":"Lists all the VirtualWANs in a subscription.","operationId":"VirtualWans_List","parameters":[{"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":{"VirtualWANList":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualWANList":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the VirtualWANs in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVirtualWANsResult"},"examples":{"VirtualWANList":{"$ref":"#/components/examples/VirtualWANList"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways":{"get":{"description":"Lists all the VpnGateways in a subscription.","operationId":"VpnGateways_List","parameters":[{"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":{"VpnGatewayListBySubscription":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VpnGatewayListBySubscription":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the VpnGateways in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVpnGatewaysResult"},"examples":{"VpnGatewayListBySubscription":{"$ref":"#/components/examples/VpnGatewayListBySubscription"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites":{"get":{"description":"Lists all the VpnSites in a subscription.","operationId":"VpnSites_List","parameters":[{"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":{"VpnSiteList":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VpnSiteList":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the VpnSites in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVpnSitesResult"},"examples":{"VpnSiteList":{"$ref":"#/components/examples/VpnSiteList"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways":{"get":{"description":"Lists all the P2SVpnGateways in a resource group.","operationId":"P2sVpnGateways_ListByResourceGroup","parameters":[{"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":{"P2SVpnGatewayListByResourceGroup":{"value":"subid"}}},{"description":"The resource group name of the P2SVpnGateway.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayListByResourceGroup":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayListByResourceGroup":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the P2SVpnGateways in the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListP2SVpnGatewaysResult"},"examples":{"P2SVpnGatewayListByResourceGroup":{"$ref":"#/components/examples/P2SVpnGatewayListByResourceGroup"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}":{"delete":{"description":"Deletes a virtual wan p2s vpn gateway.","operationId":"P2sVpnGateways_Delete","parameters":[{"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":{"P2SVpnGatewayDelete":{"value":"subid"}}},{"description":"The resource group name of the P2SVpnGateway.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayDelete":{"value":"rg1"}}},{"description":"The name of the gateway.","in":"path","name":"gatewayName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayDelete":{"value":"p2sVpnGateway1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayDelete":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. P2SVpnGateway deleted."},"202":{"description":"Request received successfully. P2SVpnGateway deletion is in progress; follow the Location header to poll for final outcome."},"204":{"description":"No p2s vpn gateways exist by the name provided."},"default":{"description":"Error.","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"}}}}}}},"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Retrieves the details of a virtual wan p2s vpn gateway.","operationId":"P2sVpnGateways_Get","parameters":[{"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":{"P2SVpnGatewayGet":{"value":"subid"}}},{"description":"The resource group name of the P2SVpnGateway.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayGet":{"value":"rg1"}}},{"description":"The name of the gateway.","in":"path","name":"gatewayName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayGet":{"value":"p2sVpnGateway1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayGet":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnGateway"},"examples":{"P2SVpnGatewayGet":{"$ref":"#/components/examples/P2SVpnGatewayGet"}}}}},"default":{"description":"Error.","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"}}}}}}}},"patch":{"description":"Updates virtual wan p2s vpn gateway tags.","operationId":"P2sVpnGateways_UpdateTags","parameters":[{"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":{"P2SVpnGatewayUpdate":{"value":"subid"}}},{"description":"The resource group name of the P2SVpnGateway.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayUpdate":{"value":"rg1"}}},{"description":"The name of the gateway.","in":"path","name":"gatewayName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayUpdate":{"value":"p2sVpnGateway1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayUpdate":{"value":"2019-07-01"}}}],"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 a virtual wan p2s vpn gateway tags.","required":true},"responses":{"200":{"description":"Request successful. Returns the details of the updated gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnGateway"},"examples":{"P2SVpnGatewayUpdate":{"$ref":"#/components/examples/P2SVpnGatewayUpdate"}}}}},"201":{"description":"Request received successfully. Returns the details of the updated gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnGateway"},"examples":{"P2SVpnGatewayUpdate":{"$ref":"#/components/examples/P2SVpnGatewayUpdate"}}}}},"default":{"description":"Error.","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":["P2SVpnGateways"],"x-ms-long-running-operation":true},"put":{"description":"Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.","operationId":"P2sVpnGateways_CreateOrUpdate","parameters":[{"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":{"P2SVpnGatewayPut":{"value":"subid"}}},{"description":"The resource group name of the P2SVpnGateway.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayPut":{"value":"rg1"}}},{"description":"The name of the gateway.","in":"path","name":"gatewayName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayPut":{"value":"p2sVpnGateway1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayPut":{"value":"2019-07-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnGateway"}}},"description":"Parameters supplied to create or Update a virtual wan p2s vpn gateway.","required":true},"responses":{"200":{"description":"Request successful. Returns the details of the virtual wan p2s vpn Gateway created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnGateway"},"examples":{"P2SVpnGatewayPut":{"$ref":"#/components/examples/P2SVpnGatewayPut"}}}}},"201":{"description":"Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnGateway"},"examples":{"P2SVpnGatewayPut":{"$ref":"#/components/examples/P2SVpnGatewayPut"}}}}},"default":{"description":"Error.","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"}}}}}}},"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/p2svpnGateways/{gatewayName}/generatevpnprofile":{"post":{"description":"Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.","operationId":"P2sVpnGateways_GenerateVpnProfile","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"GenerateP2SVpnGatewayVPNProfile":{"value":"rg1"}}},{"description":"The name of the P2SVpnGateway.","in":"path","name":"gatewayName","required":true,"schema":{"type":"string"},"examples":{"GenerateP2SVpnGatewayVPNProfile":{"value":"p2sVpnGateway1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GenerateP2SVpnGatewayVPNProfile":{"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":{"GenerateP2SVpnGatewayVPNProfile":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnProfileParameters"}}},"description":"Parameters supplied to the generate P2SVpnGateway VPN client package operation.","required":true},"responses":{"200":{"description":"VPN profile package URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnProfileResponse"}}}},"202":{"description":"Accepted and the operation will complete asynchronously."}},"tags":["P2SVpnGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth":{"post":{"description":"Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.","operationId":"P2sVpnGateways_GetP2sVpnConnectionHealth","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayGetConnectionHealth":{"value":"rg1"}}},{"description":"The name of the P2SVpnGateway.","in":"path","name":"gatewayName","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayGetConnectionHealth":{"value":"p2sVpnGateway1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"P2SVpnGatewayGetConnectionHealth":{"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":{"P2SVpnGatewayGetConnectionHealth":{"value":"subid"}}}],"responses":{"200":{"description":"P2S Vpn Gateway with P2S connection health details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/P2SVpnGateway"},"examples":{"P2SVpnGatewayGetConnectionHealth":{"$ref":"#/components/examples/P2SVpnGatewayGetConnectionHealth"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously."}},"tags":["P2SVpnGateways"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs":{"get":{"description":"Lists all the VirtualHubs in a resource group.","operationId":"VirtualHubs_ListByResourceGroup","parameters":[{"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":{"VirtualHubListByResourceGroup":{"value":"subid"}}},{"description":"The resource group name of the VirtualHub.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubListByResourceGroup":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualHubListByResourceGroup":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the VirtualHubs in the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVirtualHubsResult"},"examples":{"VirtualHubListByResourceGroup":{"$ref":"#/components/examples/VirtualHubListByResourceGroup"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}":{"delete":{"description":"Deletes a VirtualHub.","operationId":"VirtualHubs_Delete","parameters":[{"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":{"VirtualHubDelete":{"value":"subid"}}},{"description":"The resource group name of the VirtualHub.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubDelete":{"value":"rg1"}}},{"description":"The name of the VirtualHub.","in":"path","name":"virtualHubName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubDelete":{"value":"virtualHub1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualHubDelete":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. VirtualHub deleted."},"202":{"description":"Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome."},"204":{"description":"No VirtualHubs exist by the name provided."},"default":{"description":"Error.","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"}}}}}}},"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Retrieves the details of a VirtualHub.","operationId":"VirtualHubs_Get","parameters":[{"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":{"VirtualHubGet":{"value":"subid"}}},{"description":"The resource group name of the VirtualHub.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubGet":{"value":"rg1"}}},{"description":"The name of the VirtualHub.","in":"path","name":"virtualHubName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubGet":{"value":"virtualHub1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualHubGet":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of the VirtualHub retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHub"},"examples":{"VirtualHubGet":{"$ref":"#/components/examples/VirtualHubGet"}}}}},"default":{"description":"Error.","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"}}}}}}}},"patch":{"description":"Updates VirtualHub tags.","operationId":"VirtualHubs_UpdateTags","parameters":[{"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":{"VirtualHubUpdate":{"value":"subid"}}},{"description":"The resource group name of the VirtualHub.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubUpdate":{"value":"rg1"}}},{"description":"The name of the VirtualHub.","in":"path","name":"virtualHubName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubUpdate":{"value":"virtualHub2"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualHubUpdate":{"value":"2019-07-01"}}}],"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 VirtualHub tags.","required":true},"responses":{"200":{"description":"Request successful. Returns the details of the VirtualHub updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHub"},"examples":{"VirtualHubUpdate":{"$ref":"#/components/examples/VirtualHubUpdate"}}}}},"201":{"description":"Request received successfully. Returns the details of the VirtualHub updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHub"},"examples":{"VirtualHubUpdate":{"$ref":"#/components/examples/VirtualHubUpdate"}}}}},"default":{"description":"Error.","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":["VirtualWANs"],"x-ms-long-running-operation":true},"put":{"description":"Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.","operationId":"VirtualHubs_CreateOrUpdate","parameters":[{"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":{"VirtualHubPut":{"value":"subid"}}},{"description":"The resource group name of the VirtualHub.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubPut":{"value":"rg1"}}},{"description":"The name of the VirtualHub.","in":"path","name":"virtualHubName","required":true,"schema":{"type":"string"},"examples":{"VirtualHubPut":{"value":"virtualHub2"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualHubPut":{"value":"2019-07-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHub"}}},"description":"Parameters supplied to create or update VirtualHub.","required":true},"responses":{"200":{"description":"Request successful. Returns the details of the VirtualHub created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHub"},"examples":{"VirtualHubPut":{"$ref":"#/components/examples/VirtualHubPut"}}}}},"201":{"description":"Request received successfully. Returns the details of the VirtualHub created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualHub"},"examples":{"VirtualHubPut":{"$ref":"#/components/examples/VirtualHubPut"}}}}},"default":{"description":"Error.","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"}}}}}}},"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/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections":{"get":{"description":"Retrieves the details of all HubVirtualNetworkConnections.","operationId":"HubVirtualNetworkConnections_List","parameters":[{"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":{"HubVirtualNetworkConnectionList":{"value":"subid"}}},{"description":"The resource group name of the VirtualHub.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"HubVirtualNetworkConnectionList":{"value":"rg1"}}},{"description":"The name of the VirtualHub.","in":"path","name":"virtualHubName","required":true,"schema":{"type":"string"},"examples":{"HubVirtualNetworkConnectionList":{"value":"virtualHub1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"HubVirtualNetworkConnectionList":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListHubVirtualNetworkConnectionsResult"},"examples":{"HubVirtualNetworkConnectionList":{"$ref":"#/components/examples/HubVirtualNetworkConnectionList"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}":{"get":{"description":"Retrieves the details of a HubVirtualNetworkConnection.","operationId":"HubVirtualNetworkConnections_Get","parameters":[{"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":{"HubVirtualNetworkConnectionGet":{"value":"subid"}}},{"description":"The resource group name of the VirtualHub.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"HubVirtualNetworkConnectionGet":{"value":"rg1"}}},{"description":"The name of the VirtualHub.","in":"path","name":"virtualHubName","required":true,"schema":{"type":"string"},"examples":{"HubVirtualNetworkConnectionGet":{"value":"virtualHub1"}}},{"description":"The name of the vpn connection.","in":"path","name":"connectionName","required":true,"schema":{"type":"string"},"examples":{"HubVirtualNetworkConnectionGet":{"value":"connection1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"HubVirtualNetworkConnectionGet":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HubVirtualNetworkConnection"},"examples":{"HubVirtualNetworkConnectionGet":{"$ref":"#/components/examples/HubVirtualNetworkConnectionGet"}}}}},"default":{"description":"Error.","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"}}}}}}}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans":{"get":{"description":"Lists all the VirtualWANs in a resource group.","operationId":"VirtualWans_ListByResourceGroup","parameters":[{"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":{"VirtualWANListByResourceGroup":{"value":"subid"}}},{"description":"The resource group name of the VirtualWan.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANListByResourceGroup":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualWANListByResourceGroup":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. Returns the details of all the VirtualWANs in the resource group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVirtualWANsResult"},"examples":{"VirtualWANListByResourceGroup":{"$ref":"#/components/examples/VirtualWANListByResourceGroup"}}}}},"default":{"description":"Error.","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"}}}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}":{"delete":{"description":"Deletes a VirtualWAN.","operationId":"VirtualWans_Delete","parameters":[{"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":{"VirtualWANDelete":{"value":"subid"}}},{"description":"The resource group name of the VirtualWan.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANDelete":{"value":"rg1"}}},{"description":"The name of the VirtualWAN being deleted.","in":"path","name":"VirtualWANName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANDelete":{"value":"virtualWan1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualWANDelete":{"value":"2019-07-01"}}}],"responses":{"200":{"description":"Request successful. VirtualWAN deleted."},"202":{"description":"Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome."},"204":{"description":"No VirtualWANs exist by the name provided."},"default":{"description":"Error.","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"}}}}}}},"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Retrieves the details of a VirtualWAN.","operationId":"VirtualWans_Get","parameters":[{"description":"The resource group name of the VirtualWan.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANGet":{"value":"rg1"}}},{"description":"The name of the VirtualWAN being retrieved.","in":"path","name":"VirtualWANName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANGet":{"value":"wan1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualWANGet":{"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":{"VirtualWANGet":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. Returns the details of the VirtualWAN retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWAN"},"examples":{"VirtualWANGet":{"$ref":"#/components/examples/VirtualWANGet"}}}}},"default":{"description":"Error.","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"}}}}}}}},"patch":{"description":"Updates a VirtualWAN tags.","operationId":"VirtualWans_UpdateTags","parameters":[{"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":{"VirtualWANUpdate":{"value":"subid"}}},{"description":"The resource group name of the VirtualWan.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANUpdate":{"value":"rg1"}}},{"description":"The name of the VirtualWAN being updated.","in":"path","name":"VirtualWANName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANUpdate":{"value":"wan1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualWANUpdate":{"value":"2019-07-01"}}}],"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 VirtualWAN tags.","required":true},"responses":{"200":{"description":"Request successful. Returns the details of the VirtualWAN updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWAN"},"examples":{"VirtualWANUpdate":{"$ref":"#/components/examples/VirtualWANUpdate"}}}}},"201":{"description":"Request received successfully. Returns the details of the VirtualWAN updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWAN"},"examples":{"VirtualWANUpdate":{"$ref":"#/components/examples/VirtualWANUpdate"}}}}},"default":{"description":"Error.","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":["VirtualWANs"],"x-ms-long-running-operation":true},"put":{"description":"Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.","operationId":"VirtualWans_CreateOrUpdate","parameters":[{"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":{"VirtualWANCreate":{"value":"subid"}}},{"description":"The resource group name of the VirtualWan.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANCreate":{"value":"rg1"}}},{"description":"The name of the VirtualWAN being created or updated.","in":"path","name":"VirtualWANName","required":true,"schema":{"type":"string"},"examples":{"VirtualWANCreate":{"value":"wan1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"VirtualWANCreate":{"value":"2019-07-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWAN"}}},"description":"Parameters supplied to create or update VirtualWAN.","required":true},"responses":{"200":{"description":"Request successful. Returns the details of the VirtualWAN created or updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWAN"},"examples":{"VirtualWAN