virtual_hubs_outbound_routes
Creates, updates, deletes, gets or lists a virtual_hubs_outbound_routes resource.
Overview
| Name | virtual_hubs_outbound_routes |
| Type | Resource |
| Id | azure.network.virtual_hubs_outbound_routes |
Fields
The following fields are returned by SELECT queries:
- get
Request successful. Returns the list of the effective route map routes or follow the location header for the outbound routes list.
| Name | Datatype | Description |
|---|---|---|
asPath | string | The ASPath of this route. |
bgpCommunities | string | BGP communities of the route. |
prefix | string | The address prefix of the route. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, virtualHubName | Gets the outbound routes configured for the Virtual Hub on a particular connection. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resourceGroupName | string | The resource group name of the VirtualHub. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
virtualHubName | string | The name of the VirtualHub. |
SELECT examples
- get
Gets the outbound routes configured for the Virtual Hub on a particular connection.
SELECT
asPath,
bgpCommunities,
prefix
FROM azure.network.virtual_hubs_outbound_routes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND virtualHubName = '{{ virtualHubName }}' -- required
;