@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.64 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* Route resource.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-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, 2024-07-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Route extends pulumi.CustomResource {
/**
* Get an existing Route resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Route;
/**
* Returns true if the given object is an instance of Route. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Route;
/**
* The destination CIDR to which the route applies.
*/
readonly addressPrefix: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* A value indicating whether this route overrides overlapping BGP routes regardless of LPM.
*/
readonly hasBgpOverride: pulumi.Output<boolean>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
*/
readonly nextHopIpAddress: pulumi.Output<string | undefined>;
/**
* The type of Azure hop the packet should be sent to.
*/
readonly nextHopType: pulumi.Output<string>;
/**
* The provisioning state of the route resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The type of the resource.
*/
readonly type: pulumi.Output<string | undefined>;
/**
* Create a Route resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Route resource.
*/
export interface RouteArgs {
/**
* The destination CIDR to which the route applies.
*/
addressPrefix?: pulumi.Input<string>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
name?: pulumi.Input<string>;
/**
* The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
*/
nextHopIpAddress?: pulumi.Input<string>;
/**
* The type of Azure hop the packet should be sent to.
*/
nextHopType: pulumi.Input<string | enums.network.RouteNextHopType>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the route.
*/
routeName?: pulumi.Input<string>;
/**
* The name of the route table.
*/
routeTableName: pulumi.Input<string>;
/**
* The type of the resource.
*/
type?: pulumi.Input<string>;
}