Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getRoute
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getRoute

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified route from a route table.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getRoute

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRoute(args: GetRouteArgs, opts?: InvokeOptions): Promise<GetRouteResult>
function getRouteOutput(args: GetRouteOutputArgs, opts?: InvokeOptions): Output<GetRouteResult>
Copy
def get_route(resource_group_name: Optional[str] = None,
              route_name: Optional[str] = None,
              route_table_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRouteResult
def get_route_output(resource_group_name: Optional[pulumi.Input[str]] = None,
              route_name: Optional[pulumi.Input[str]] = None,
              route_table_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRouteResult]
Copy
func LookupRoute(ctx *Context, args *LookupRouteArgs, opts ...InvokeOption) (*LookupRouteResult, error)
func LookupRouteOutput(ctx *Context, args *LookupRouteOutputArgs, opts ...InvokeOption) LookupRouteResultOutput
Copy

> Note: This function is named LookupRoute in the Go SDK.

public static class GetRoute 
{
    public static Task<GetRouteResult> InvokeAsync(GetRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteResult> Invoke(GetRouteInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
public static Output<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getRoute
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RouteName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route.
RouteTableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route table.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
RouteName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route.
RouteTableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route table.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
routeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the route.
routeTableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the route table.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
routeName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route.
routeTableName
This property is required.
Changes to this property will trigger replacement.
string
The name of the route table.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
route_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the route.
route_table_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the route table.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
routeName
This property is required.
Changes to this property will trigger replacement.
String
The name of the route.
routeTableName
This property is required.
Changes to this property will trigger replacement.
String
The name of the route table.

getRoute Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
HasBgpOverride bool
A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
NextHopType string
The type of Azure hop the packet should be sent to.
ProvisioningState string
The provisioning state of the route resource.
AddressPrefix string
The destination CIDR to which the route applies.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
NextHopIpAddress string
The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
Type string
The type of the resource.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
HasBgpOverride bool
A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
NextHopType string
The type of Azure hop the packet should be sent to.
ProvisioningState string
The provisioning state of the route resource.
AddressPrefix string
The destination CIDR to which the route applies.
Id string
Resource ID.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
NextHopIpAddress string
The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
Type string
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
hasBgpOverride Boolean
A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
nextHopType String
The type of Azure hop the packet should be sent to.
provisioningState String
The provisioning state of the route resource.
addressPrefix String
The destination CIDR to which the route applies.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
nextHopIpAddress String
The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
type String
The type of the resource.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
hasBgpOverride boolean
A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
nextHopType string
The type of Azure hop the packet should be sent to.
provisioningState string
The provisioning state of the route resource.
addressPrefix string
The destination CIDR to which the route applies.
id string
Resource ID.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
nextHopIpAddress string
The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
type string
The type of the resource.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
has_bgp_override bool
A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
next_hop_type str
The type of Azure hop the packet should be sent to.
provisioning_state str
The provisioning state of the route resource.
address_prefix str
The destination CIDR to which the route applies.
id str
Resource ID.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
next_hop_ip_address str
The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
type str
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
hasBgpOverride Boolean
A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
nextHopType String
The type of Azure hop the packet should be sent to.
provisioningState String
The provisioning state of the route resource.
addressPrefix String
The destination CIDR to which the route applies.
id String
Resource ID.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
nextHopIpAddress String
The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
type String
The type of the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native