azure-native.network.getRoute
Explore with Pulumi AI
Gets the specified route from a route table. API Version: 2020-11-01.
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>
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]
func LookupRoute(ctx *Context, args *LookupRouteArgs, opts ...InvokeOption) (*LookupRouteResult, error)
func LookupRouteOutput(ctx *Context, args *LookupRouteOutputArgs, opts ...InvokeOption) LookupRouteResultOutput
> 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)
}
public static CompletableFuture<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:network:getRoute
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName The name of the resource group.
- Route
Name string The name of the route.
- Route
Table stringName The name of the route table.
- Resource
Group stringName The name of the resource group.
- Route
Name string The name of the route.
- Route
Table stringName The name of the route table.
- resource
Group StringName The name of the resource group.
- route
Name String The name of the route.
- route
Table StringName The name of the route table.
- resource
Group stringName The name of the resource group.
- route
Name string The name of the route.
- route
Table stringName The name of the route table.
- resource_
group_ strname The name of the resource group.
- route_
name str The name of the route.
- route_
table_ strname The name of the route table.
- resource
Group StringName The name of the resource group.
- route
Name String The name of the route.
- route
Table StringName The name of the route table.
getRoute Result
The following output properties are available:
- Etag string
A unique read-only string that changes whenever the resource is updated.
- Next
Hop stringType The type of Azure hop the packet should be sent to.
- Provisioning
State string The provisioning state of the route resource.
- Address
Prefix string The destination CIDR to which the route applies.
- Has
Bgp boolOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
- 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.
- Next
Hop stringIp Address 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.
- Etag string
A unique read-only string that changes whenever the resource is updated.
- Next
Hop stringType The type of Azure hop the packet should be sent to.
- Provisioning
State string The provisioning state of the route resource.
- Address
Prefix string The destination CIDR to which the route applies.
- Has
Bgp boolOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
- 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.
- Next
Hop stringIp Address 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.
- etag String
A unique read-only string that changes whenever the resource is updated.
- next
Hop StringType The type of Azure hop the packet should be sent to.
- provisioning
State String The provisioning state of the route resource.
- address
Prefix String The destination CIDR to which the route applies.
- has
Bgp BooleanOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
- 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.
- next
Hop StringIp Address 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.
- etag string
A unique read-only string that changes whenever the resource is updated.
- next
Hop stringType The type of Azure hop the packet should be sent to.
- provisioning
State string The provisioning state of the route resource.
- address
Prefix string The destination CIDR to which the route applies.
- has
Bgp booleanOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
- 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.
- next
Hop stringIp Address 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.
- etag str
A unique read-only string that changes whenever the resource is updated.
- next_
hop_ strtype 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.
- has_
bgp_ booloverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
- 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_ strip_ address 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.
- etag String
A unique read-only string that changes whenever the resource is updated.
- next
Hop StringType The type of Azure hop the packet should be sent to.
- provisioning
State String The provisioning state of the route resource.
- address
Prefix String The destination CIDR to which the route applies.
- has
Bgp BooleanOverride A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
- 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.
- next
Hop StringIp Address 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