@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
*
* Uses Azure REST API version 2024-09-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 function getRoute(args: GetRouteArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteResult>;
export interface GetRouteArgs {
/**
* Name of the endpoint under the profile which is unique globally.
*/
endpointName: string;
/**
* Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
*/
profileName: string;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: string;
/**
* Name of the routing rule.
*/
routeName: string;
}
/**
* Friendly Routes name mapping to the any Routes or secret related information.
*/
export interface GetRouteResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
*/
readonly cacheConfiguration?: outputs.cdn.AfdRouteCacheConfigurationResponse;
/**
* Domains referenced by this endpoint.
*/
readonly customDomains?: outputs.cdn.ActivatedResourceReferenceResponse[];
readonly deploymentStatus: string;
/**
* Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
*/
readonly enabledState?: string;
/**
* The name of the endpoint which holds the route.
*/
readonly endpointName: string;
/**
* Protocol this rule will use when forwarding traffic to backends.
*/
readonly forwardingProtocol?: string;
/**
* 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?: string;
/**
* Resource ID.
*/
readonly id: string;
/**
* whether this route will be linked to the default endpoint domain.
*/
readonly linkToDefaultDomain?: string;
/**
* Resource name.
*/
readonly name: string;
/**
* A reference to the origin group.
*/
readonly originGroup: 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?: string;
/**
* The route patterns of the rule.
*/
readonly patternsToMatch?: string[];
/**
* Provisioning status
*/
readonly provisioningState: string;
/**
* rule sets referenced by this endpoint.
*/
readonly ruleSets?: outputs.cdn.ResourceReferenceResponse[];
/**
* List of supported protocols for this route.
*/
readonly supportedProtocols?: string[];
/**
* Read only system data
*/
readonly systemData: outputs.cdn.SystemDataResponse;
/**
* Resource type.
*/
readonly type: string;
}
/**
* Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
*
* Uses Azure REST API version 2024-09-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 function getRouteOutput(args: GetRouteOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRouteResult>;
export interface GetRouteOutputArgs {
/**
* Name of the endpoint under the profile which is unique globally.
*/
endpointName: 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>;
}