import * as pulumi from "@pulumi/pulumi"; /** * Manages a Route within a Route Table. * * > **NOTE on Route Tables and Routes:** This provider currently * provides both a standalone Route resource, and allows for Routes to be defined in-line within the Route Table resource. * At this time you cannot use a Route Table with in-line Routes in conjunction with any Route resources. Doing so will cause a conflict of Route configurations and will overwrite Routes. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleRouteTable = new azure.network.RouteTable("example", { * name: "acceptanceTestRouteTable1", * location: example.location, * resourceGroupName: example.name, * }); * const exampleRoute = new azure.network.Route("example", { * name: "acceptanceTestRoute1", * resourceGroupName: example.name, * routeTableName: exampleRouteTable.name, * addressPrefix: "10.1.0.0/16", * nextHopType: "VnetLocal", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Network` - 2025-01-01 * * ## Import * * Routes can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:network/route:Route exampleRoute /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/routeTables/mytable1/routes/myroute1 * ``` */ 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 state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: RouteState, 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 to which the route applies. Can be CIDR (such as `10.1.0.0/16`) or [Azure Service Tag](https://docs.microsoft.com/azure/virtual-network/service-tags-overview) (such as `ApiManagement`, `AzureBackup` or `AzureMonitor`) format. */ readonly addressPrefix: pulumi.Output; /** * The name of the route. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is `VirtualAppliance`. */ readonly nextHopInIpAddress: pulumi.Output; /** * The type of Azure hop the packet should be sent to. Possible values are `VirtualNetworkGateway`, `VnetLocal`, `Internet`, `VirtualAppliance` and `None`. */ readonly nextHopType: pulumi.Output; /** * The name of the resource group in which to create the route. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * The name of the route table within which create the route. Changing this forces a new resource to be created. */ readonly routeTableName: pulumi.Output; /** * 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); } /** * Input properties used for looking up and filtering Route resources. */ export interface RouteState { /** * The destination to which the route applies. Can be CIDR (such as `10.1.0.0/16`) or [Azure Service Tag](https://docs.microsoft.com/azure/virtual-network/service-tags-overview) (such as `ApiManagement`, `AzureBackup` or `AzureMonitor`) format. */ addressPrefix?: pulumi.Input; /** * The name of the route. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is `VirtualAppliance`. */ nextHopInIpAddress?: pulumi.Input; /** * The type of Azure hop the packet should be sent to. Possible values are `VirtualNetworkGateway`, `VnetLocal`, `Internet`, `VirtualAppliance` and `None`. */ nextHopType?: pulumi.Input; /** * The name of the resource group in which to create the route. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * The name of the route table within which create the route. Changing this forces a new resource to be created. */ routeTableName?: pulumi.Input; } /** * The set of arguments for constructing a Route resource. */ export interface RouteArgs { /** * The destination to which the route applies. Can be CIDR (such as `10.1.0.0/16`) or [Azure Service Tag](https://docs.microsoft.com/azure/virtual-network/service-tags-overview) (such as `ApiManagement`, `AzureBackup` or `AzureMonitor`) format. */ addressPrefix: pulumi.Input; /** * The name of the route. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is `VirtualAppliance`. */ nextHopInIpAddress?: pulumi.Input; /** * The type of Azure hop the packet should be sent to. Possible values are `VirtualNetworkGateway`, `VnetLocal`, `Internet`, `VirtualAppliance` and `None`. */ nextHopType: pulumi.Input; /** * The name of the resource group in which to create the route. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * The name of the route table within which create the route. Changing this forces a new resource to be created. */ routeTableName: pulumi.Input; }