Virtual Hubs - Get Outbound Routes

Reference

Service:: Virtual WAN

API Version:: 2024-05-01

Gets the outbound routes configured for the Virtual Hub on a particular connection.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The resource group name of the VirtualHub.
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
virtualHubName	path	True	string	The name of the VirtualHub.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
connectionType	string	The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection.
resourceUri	string	The connection resource whose outbound routes are being requested.

Responses

Name	Type	Description
200 OK	EffectiveRouteMapRouteList	Request successful. Returns the list of the effective route map routes or follow the location header for the outbound routes list.
202 Accepted		Accepted and the operation will complete asynchronously.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Outbound Routes for the Virtual Hub on a Particular Connection

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/outboundRoutes?api-version=2024-05-01

{
  "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1",
  "connectionType": "ExpressRouteConnection"
}

Sample response

Status code:: 200

{
  "value": [
    {
      "prefix": "192.168.50.0/24",
      "asPath": "65520-65520",
      "bgpCommunities": "4293853166,12076,51004"
    },
    {
      "prefix": "10.200.0.0/16",
      "asPath": "65520-65520-12076-12076",
      "bgpCommunities": "4293787629,12076,51027,4293734188"
    }
  ]
}

Status code:: 202

location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
EffectiveRouteMapRoute	The effective RouteMap route configured on the connection resource.
EffectiveRouteMapRouteList	EffectiveRouteMapRoute List.
GetOutboundRoutesParameters	The parameters specifying the connection resource whose outbound routes are being requested.

CloudError

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

An error response from the service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

EffectiveRouteMapRoute

The effective RouteMap route configured on the connection resource.

Name	Type	Description
asPath	string	The ASPath of this route.
bgpCommunities	string	BGP communities of the route.
prefix	string	The address prefix of the route.

EffectiveRouteMapRouteList

EffectiveRouteMapRoute List.

Name	Type	Description
value	EffectiveRouteMapRoute[]	The list of Effective RouteMap Routes configured on the connection resource.

GetOutboundRoutesParameters

The parameters specifying the connection resource whose outbound routes are being requested.

Name	Type	Description
connectionType	string	The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection.
resourceUri	string	The connection resource whose outbound routes are being requested.

다음을 통해 공유