@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.39 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";
/**
* Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.
*
* Uses Azure REST API version 2021-06-01.
*
* Other available API versions: 2019-04-01, 2019-05-01, 2020-01-01, 2020-04-01, 2020-05-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native frontdoor [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class FrontDoor extends pulumi.CustomResource {
/**
* Get an existing FrontDoor 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): FrontDoor;
/**
* Returns true if the given object is an instance of FrontDoor. 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 FrontDoor;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Backend pools available to routing rules.
*/
readonly backendPools: pulumi.Output<outputs.frontdoor.BackendPoolResponse[] | undefined>;
/**
* Settings for all backendPools
*/
readonly backendPoolsSettings: pulumi.Output<outputs.frontdoor.BackendPoolsSettingsResponse | undefined>;
/**
* The host that each frontendEndpoint must CNAME to.
*/
readonly cname: pulumi.Output<string>;
/**
* Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
*/
readonly enabledState: pulumi.Output<string | undefined>;
/**
* Key-Value pair representing additional properties for frontdoor.
*/
readonly extendedProperties: pulumi.Output<{
[key: string]: string;
}>;
/**
* A friendly name for the frontDoor
*/
readonly friendlyName: pulumi.Output<string | undefined>;
/**
* The Id of the frontdoor.
*/
readonly frontdoorId: pulumi.Output<string>;
/**
* Frontend endpoints available to routing rules.
*/
readonly frontendEndpoints: pulumi.Output<outputs.frontdoor.FrontendEndpointResponse[] | undefined>;
/**
* Health probe settings associated with this Front Door instance.
*/
readonly healthProbeSettings: pulumi.Output<outputs.frontdoor.HealthProbeSettingsModelResponse[] | undefined>;
/**
* Load balancing settings associated with this Front Door instance.
*/
readonly loadBalancingSettings: pulumi.Output<outputs.frontdoor.LoadBalancingSettingsModelResponse[] | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* Provisioning state of the Front Door.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Resource status of the Front Door.
*/
readonly resourceState: pulumi.Output<string>;
/**
* Routing rules associated with this Front Door.
*/
readonly routingRules: pulumi.Output<outputs.frontdoor.RoutingRuleResponse[] | undefined>;
/**
* Rules Engine Configurations available to routing rules.
*/
readonly rulesEngines: pulumi.Output<outputs.frontdoor.RulesEngineResponse[]>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a FrontDoor 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: FrontDoorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a FrontDoor resource.
*/
export interface FrontDoorArgs {
/**
* Backend pools available to routing rules.
*/
backendPools?: pulumi.Input<pulumi.Input<inputs.frontdoor.BackendPoolArgs>[]>;
/**
* Settings for all backendPools
*/
backendPoolsSettings?: pulumi.Input<inputs.frontdoor.BackendPoolsSettingsArgs>;
/**
* Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
*/
enabledState?: pulumi.Input<string | enums.frontdoor.FrontDoorEnabledState>;
/**
* A friendly name for the frontDoor
*/
friendlyName?: pulumi.Input<string>;
/**
* Name of the Front Door which is globally unique.
*/
frontDoorName?: pulumi.Input<string>;
/**
* Frontend endpoints available to routing rules.
*/
frontendEndpoints?: pulumi.Input<pulumi.Input<inputs.frontdoor.FrontendEndpointArgs>[]>;
/**
* Health probe settings associated with this Front Door instance.
*/
healthProbeSettings?: pulumi.Input<pulumi.Input<inputs.frontdoor.HealthProbeSettingsModelArgs>[]>;
/**
* Load balancing settings associated with this Front Door instance.
*/
loadBalancingSettings?: pulumi.Input<pulumi.Input<inputs.frontdoor.LoadBalancingSettingsModelArgs>[]>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Routing rules associated with this Front Door.
*/
routingRules?: pulumi.Input<pulumi.Input<inputs.frontdoor.RoutingRuleArgs>[]>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}