@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.99 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Friendly Routes name mapping to the any Routes or secret related information.
*
* Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.
*
* Other available API versions: 2023-05-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2025-01-01-preview, 2025-04-15, 2025-06-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native cdn [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 Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
*/
readonly cacheConfiguration: pulumi.Output<outputs.cdn.AfdRouteCacheConfigurationResponse | undefined>;
/**
* Domains referenced by this endpoint.
*/
readonly customDomains: pulumi.Output<outputs.cdn.ActivatedResourceReferenceResponse[] | undefined>;
readonly deploymentStatus: pulumi.Output<string>;
/**
* Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
*/
readonly enabledState: pulumi.Output<string | undefined>;
/**
* The name of the endpoint which holds the route.
*/
readonly endpointName: pulumi.Output<string>;
/**
* Protocol this rule will use when forwarding traffic to backends.
*/
readonly forwardingProtocol: pulumi.Output<string | undefined>;
/**
* Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
*/
readonly httpsRedirect: pulumi.Output<string | undefined>;
/**
* whether this route will be linked to the default endpoint domain.
*/
readonly linkToDefaultDomain: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* A reference to the origin group.
*/
readonly originGroup: pulumi.Output<outputs.cdn.ResourceReferenceResponse>;
/**
* A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
*/
readonly originPath: pulumi.Output<string | undefined>;
/**
* The route patterns of the rule.
*/
readonly patternsToMatch: pulumi.Output<string[] | undefined>;
/**
* Provisioning status
*/
readonly provisioningState: pulumi.Output<string>;
/**
* rule sets referenced by this endpoint.
*/
readonly ruleSets: pulumi.Output<outputs.cdn.ResourceReferenceResponse[] | undefined>;
/**
* List of supported protocols for this route.
*/
readonly supportedProtocols: pulumi.Output<string[] | undefined>;
/**
* Read only system data
*/
readonly systemData: pulumi.Output<outputs.cdn.SystemDataResponse>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* 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 caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
*/
cacheConfiguration?: pulumi.Input<inputs.cdn.AfdRouteCacheConfigurationArgs>;
/**
* Domains referenced by this endpoint.
*/
customDomains?: pulumi.Input<pulumi.Input<inputs.cdn.ActivatedResourceReferenceArgs>[]>;
/**
* Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
*/
enabledState?: pulumi.Input<string | enums.cdn.EnabledState>;
/**
* Name of the endpoint under the profile which is unique globally.
*/
endpointName: pulumi.Input<string>;
/**
* Protocol this rule will use when forwarding traffic to backends.
*/
forwardingProtocol?: pulumi.Input<string | enums.cdn.ForwardingProtocol>;
/**
* Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
*/
httpsRedirect?: pulumi.Input<string | enums.cdn.HttpsRedirect>;
/**
* whether this route will be linked to the default endpoint domain.
*/
linkToDefaultDomain?: pulumi.Input<string | enums.cdn.LinkToDefaultDomain>;
/**
* A reference to the origin group.
*/
originGroup: pulumi.Input<inputs.cdn.ResourceReferenceArgs>;
/**
* A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
*/
originPath?: pulumi.Input<string>;
/**
* The route patterns of the rule.
*/
patternsToMatch?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
*/
profileName: pulumi.Input<string>;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Name of the routing rule.
*/
routeName?: pulumi.Input<string>;
/**
* rule sets referenced by this endpoint.
*/
ruleSets?: pulumi.Input<pulumi.Input<inputs.cdn.ResourceReferenceArgs>[]>;
/**
* List of supported protocols for this route.
*/
supportedProtocols?: pulumi.Input<pulumi.Input<string | enums.cdn.AFDEndpointProtocols>[]>;
}