azure-native.network.getRoute

Explore with Pulumi AI

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

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:

ResourceGroupName string: The name of the resource group.
RouteName string: The name of the route.
RouteTableName string: The name of the route table.

ResourceGroupName string: The name of the resource group.
RouteName string: The name of the route.
RouteTableName string: The name of the route table.

resourceGroupName String: The name of the resource group.
routeName String: The name of the route.
routeTableName String: The name of the route table.

resourceGroupName string: The name of the resource group.
routeName string: The name of the route.
routeTableName string: The name of the route table.

resource_group_name str: The name of the resource group.
route_name str: The name of the route.
route_table_name str: The name of the route table.

resourceGroupName String: The name of the resource group.
routeName String: The name of the route.
routeTableName String: 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.
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.
HasBgpOverride bool: 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.
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.

Etag string: A unique read-only string that changes whenever the resource is updated.
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.
HasBgpOverride bool: 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.
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.

etag String: A unique read-only string that changes whenever the resource is updated.
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.
hasBgpOverride Boolean: 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.
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.

etag string: A unique read-only string that changes whenever the resource is updated.
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.
hasBgpOverride boolean: 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.
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.

etag str: A unique read-only string that changes whenever the resource is updated.
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.
has_bgp_override bool: 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_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.

etag String: A unique read-only string that changes whenever the resource is updated.
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.
hasBgpOverride Boolean: 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.
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

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getRoute

On this page

On this page

Using getRoute

getRoute Result

Package Details

On this page

On this page