openapi-directory/api/azure.com/network-virtualRouter.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-11-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-11-01/virtualRouter.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"network-virtualRouter","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualRouters":{"get":{"description":"Gets all the Virtual Routers in a subscription.","operationId":"VirtualRouters_List","parameters":[{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Virtual Routers for a given subscription":{"value":"2019-11-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":{"List all Virtual Routers for a given subscription":{"value":"subid"}}}],"responses":{"200":{"description":"Success. The operation returns a list of Virtual Router resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouterListResult"},"examples":{"List all Virtual Routers for a given subscription":{"$ref":"#/components/examples/List_all_Virtual_Routers_for_a_given_subscription"}}}}},"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":["VirtualRouters"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters":{"get":{"description":"Lists all Virtual Routers in a resource group.","operationId":"VirtualRouters_ListByResourceGroup","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List all Virtual Router for a given resource group":{"value":"rg1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Virtual Router for a given resource group":{"value":"2019-11-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":{"List all Virtual Router for a given resource group":{"value":"subid"}}}],"responses":{"200":{"description":"Success. The operation returns a list of Virtual Router resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouterListResult"},"examples":{"List all Virtual Router for a given resource group":{"$ref":"#/components/examples/List_all_Virtual_Router_for_a_given_resource_group"}}}}},"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":["VirtualRouters"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}":{"delete":{"description":"Deletes the specified Virtual Router.","operationId":"VirtualRouters_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete VirtualRouter":{"value":"rg1"}}},{"description":"The name of the Virtual Router.","in":"path","name":"virtualRouterName","required":true,"schema":{"type":"string"},"examples":{"Delete VirtualRouter":{"value":"virtualRouter"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete VirtualRouter":{"value":"2019-11-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":{"Delete VirtualRouter":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Request successful. Resource with the specified name does not exist."},"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":["VirtualRouters"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified Virtual Router.","operationId":"VirtualRouters_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get VirtualRouter":{"value":"rg1"}}},{"description":"The name of the Virtual Router.","in":"path","name":"virtualRouterName","required":true,"schema":{"type":"string"},"examples":{"Get VirtualRouter":{"value":"virtualRouter"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get VirtualRouter":{"value":"2019-11-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":{"Get VirtualRouter":{"value":"subid"}}},{"description":"Expands referenced resources.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request successful. The operation returns a Virtual Router resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouter"},"examples":{"Get VirtualRouter":{"$ref":"#/components/examples/Get_VirtualRouter"}}}}},"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":["VirtualRouters"]},"put":{"description":"Creates or updates the specified Virtual Router.","operationId":"VirtualRouters_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create VirtualRouter":{"value":"rg1"}}},{"description":"The name of the Virtual Router.","in":"path","name":"virtualRouterName","required":true,"schema":{"type":"string"},"examples":{"Create VirtualRouter":{"value":"virtualRouter"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create VirtualRouter":{"value":"2019-11-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":{"Create VirtualRouter":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouter"}}},"description":"Parameters supplied to the create or update Virtual Router.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the resulting Virtual Router resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouter"},"examples":{"Create VirtualRouter":{"$ref":"#/components/examples/Create_VirtualRouter"}}}}},"201":{"description":"Request received successfully. The operation returns the resulting Virtual Router resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouter"},"examples":{"Create VirtualRouter":{"$ref":"#/components/examples/Create_VirtualRouter"}}}}},"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":["VirtualRouters"],"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/virtualRouters/{virtualRouterName}/peerings":{"get":{"description":"Lists all Virtual Router Peerings in a Virtual Router resource.","operationId":"VirtualRouterPeerings_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"List all Virtual Router Peerings for a given Virtual Router":{"value":"rg1"}}},{"description":"The name of the Virtual Router.","in":"path","name":"virtualRouterName","required":true,"schema":{"type":"string"},"examples":{"List all Virtual Router Peerings for a given Virtual Router":{"value":"virtualRouter"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Virtual Router Peerings for a given Virtual Router":{"value":"2019-11-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":{"List all Virtual Router Peerings for a given Virtual Router":{"value":"subid"}}}],"responses":{"200":{"description":"Success. The operation returns a list of Virtual Router Peering resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouterPeeringListResult"},"examples":{"List all Virtual Router Peerings for a given Virtual Router":{"$ref":"#/components/examples/List_all_Virtual_Router_Peerings_for_a_given_Virtual_Router"}}}}},"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":["VirtualRouterPeerings"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}":{"delete":{"description":"Deletes the specified peering from a Virtual Router.","operationId":"VirtualRouterPeerings_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Delete VirtualRouterPeering":{"value":"rg1"}}},{"description":"The name of the Virtual Router.","in":"path","name":"virtualRouterName","required":true,"schema":{"type":"string"},"examples":{"Delete VirtualRouterPeering":{"value":"virtualRouter"}}},{"description":"The name of the peering.","in":"path","name":"peeringName","required":true,"schema":{"type":"string"},"examples":{"Delete VirtualRouterPeering":{"value":"peering1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete VirtualRouterPeering":{"value":"2019-11-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":{"Delete VirtualRouterPeering":{"value":"subid"}}}],"responses":{"200":{"description":"Delete successful."},"202":{"description":"Accepted and the operation will complete asynchronously."},"204":{"description":"Request successful. Resource with the specified name does not exist."},"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":["VirtualRouterPeerings"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"location"}},"get":{"description":"Gets the specified Virtual Router Peering.","operationId":"VirtualRouterPeerings_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Get Virtual Router Peering":{"value":"rg1"}}},{"description":"The name of the Virtual Router.","in":"path","name":"virtualRouterName","required":true,"schema":{"type":"string"},"examples":{"Get Virtual Router Peering":{"value":"virtualRouter"}}},{"description":"The name of the Virtual Router Peering.","in":"path","name":"peeringName","required":true,"schema":{"type":"string"},"examples":{"Get Virtual Router Peering":{"value":"peering1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Virtual Router Peering":{"value":"2019-11-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":{"Get Virtual Router Peering":{"value":"subid"}}}],"responses":{"200":{"description":"Request successful. The operation returns a Virtual Router Peering resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouterPeering"},"examples":{"Get Virtual Router Peering":{"$ref":"#/components/examples/Get_Virtual_Router_Peering"}}}}},"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":["VirtualRouterPeerings"]},"put":{"description":"Creates or updates the specified Virtual Router Peering.","operationId":"VirtualRouterPeerings_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"schema":{"type":"string"},"examples":{"Create Virtual Router Peering":{"value":"rg1"}}},{"description":"The name of the Virtual Router.","in":"path","name":"virtualRouterName","required":true,"schema":{"type":"string"},"examples":{"Create Virtual Router Peering":{"value":"virtualRouter"}}},{"description":"The name of the Virtual Router Peering.","in":"path","name":"peeringName","required":true,"schema":{"type":"string"},"examples":{"Create Virtual Router Peering":{"value":"peering1"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create Virtual Router Peering":{"value":"2019-11-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":{"Create Virtual Router Peering":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouterPeering"}}},"description":"Parameters supplied to the create or update Virtual Router Peering operation.","required":true},"responses":{"200":{"description":"Request successful. The operation returns the resulting Virtual Router Peering resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouterPeering"},"examples":{"Create Virtual Router Peering":{"$ref":"#/components/examples/Create_Virtual_Router_Peering"}}}}},"201":{"description":"Request received successfully. The operation returns the resulting Virtual Router Peering resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualRouterPeering"},"examples":{"Create Virtual Router Peering":{"$ref":"#/components/examples/Create_Virtual_Router_Peering"}}}}},"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":["VirtualRouterPeerings"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_all_Virtual_Routers_for_a_given_subscription":{"value":{"value":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter","location":"West US","name":"virtualRouter","properties":{"hostedGateway":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway"},"peerings":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1"}],"provisioningState":"Succeeded","virtualRouterAsn":10000,"virtualRouterIps":["192.168.1.1","192.168.1.2"]},"tags":{"key1":"value1"},"type":"Microsoft.Network/virtualRouters"}]}},"List_all_Virtual_Router_for_a_given_resource_group":{"value":{"value":[{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter","location":"West US","name":"virtualRouter","properties":{"hostedGateway":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway"},"peerings":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1"}],"provisioningState":"Succeeded","virtualRouterAsn":10000,"virtualRouterIps":["192.168.1.1","192.168.1.2"]},"tags":{"key1":"value1"},"type":"Microsoft.Network/virtualRouters"}]}},"Get_VirtualRouter":{"value":{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter","location":"West US","name":"virtualRouter","properties":{"hostedGateway":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway"},"peerings":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1"}],"provisioningState":"Succeeded","virtualRouterAsn":10000,"virtualRouterIps":["192.168.1.1","192.168.1.2"]},"tags":{"key1":"value1"},"type":"Microsoft.Network/virtualRouters"}},"Create_VirtualRouter":{"value":{"etag":"w/\\00000000-0000-0000-0000-000000000000\\","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter","location":"West US","name":"virtualRouter","properties":{"hostedGateway":{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway"},"peerings":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1"}],"provisioningState":"Succeeded","virtualRouterAsn":10000,"virtualRouterIps":["192.168.1.1","192.168.1.2"]},"tags":{"key1":"value1"},"type":"Microsoft.Network/virtualRouters"}},"List_all_Virtual_Router_Peerings_for_a_given_Virtual_Router":{"value":{"value":[{"etag":"W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1","name":"peering1","properties":{"peerAsn":20000,"peerIp":"192.168.1.5","provisioningState":"Succeeded"}}]}},"Get_Virtual_Router_Peering":{"value":{"etag":"W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1","name":"peering1","properties":{"peerAsn":20000,"peerIp":"192.168.1.5","provisioningState":"Succeeded"}}},"Create_Virtual_Router_Peering":{"value":{"etag":"W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"","id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1","name":"peering1","properties":{"peerAsn":20000,"peerIp":"192.168.1.5","provisioningState":"Succeeded"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"VirtualRouter":{"allOf":[{"description":"Common resource representation.","properties":{"id":{"description":"Resource ID.","type":"string"},"location":{"description":"Resource location.","type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"VirtualRouter Resource.","properties":{"etag":{"description":"A unique read-only string that changes whenever the resource is updated.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/VirtualRouterPropertiesFormat"}}},"VirtualRouterListResult":{"description":"Response for ListVirtualRouters API service call.","properties":{"nextLink":{"description":"URL to get the next set of results.","type":"string"},"value":{"description":"List of Virtual Routers.","items":{"$ref":"#/components/schemas/VirtualRouter"},"type":"array"}}},"VirtualRouterPeering":{"allOf":[{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true}],"description":"Virtual Router Peering resource.","properties":{"etag":{"description":"A unique read-only string that changes whenever the resource is updated.","readOnly":true,"type":"string"},"name":{"description":"Name of the virtual router peering that is unique within a virtual router.","type":"string"},"properties":{"$ref":"#/components/schemas/VirtualRouterPeeringProperties"},"type":{"description":"Peering type.","readOnly":true,"type":"string"}}},"VirtualRouterPeeringListResult":{"description":"Response for ListVirtualRouterPeerings API service call.","properties":{"nextLink":{"description":"URL to get the next set of results.","type":"string"},"value":{"description":"List of VirtualRouterPeerings in a VirtualRouter.","items":{"$ref":"#/components/schemas/VirtualRouterPeering"},"type":"array"}}},"VirtualRouterPeeringProperties":{"description":"Properties of the rule group.","properties":{"peerAsn":{"description":"Peer ASN.","format":"int64","maximum":4294967295,"minimum":0,"readOnly":false,"type":"integer"},"peerIp":{"description":"Peer IP.","readOnly":false,"type":"string"},"provisioningState":{"description":"The current provisioning state.","enum":["Succeeded","Updating","Deleting","Failed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}}}},"VirtualRouterPropertiesFormat":{"description":"Virtual Router definition.","properties":{"hostedGateway":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"hostedSubnet":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"peerings":{"description":"List of references to VirtualRouterPeerings.","items":{"description":"Reference to another subresource.","properties":{"id":{"description":"Resource ID.","type":"string"}},"x-ms-azure-resource":true},"readOnly":true,"type":"array"},"provisioningState":{"description":"The current provisioning state.","enum":["Succeeded","Updating","Deleting","Failed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"virtualRouterAsn":{"description":"VirtualRouter ASN.","format":"int64","maximum":4294967295,"minimum":0,"readOnly":false,"type":"integer"},"virtualRouterIps":{"description":"VirtualRouter IPs.","items":{"type":"string"},"readOnly":false,"type":"array"}}}}}}