@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
*
* 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 function getFrontDoor(args: GetFrontDoorArgs, opts?: pulumi.InvokeOptions): Promise<GetFrontDoorResult>;
export interface GetFrontDoorArgs {
/**
* Name of the Front Door which is globally unique.
*/
frontDoorName: string;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: string;
}
/**
* Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there.
*/
export interface GetFrontDoorResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Backend pools available to routing rules.
*/
readonly backendPools?: outputs.frontdoor.BackendPoolResponse[];
/**
* Settings for all backendPools
*/
readonly backendPoolsSettings?: outputs.frontdoor.BackendPoolsSettingsResponse;
/**
* The host that each frontendEndpoint must CNAME to.
*/
readonly cname: string;
/**
* Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
*/
readonly enabledState?: string;
/**
* Key-Value pair representing additional properties for frontdoor.
*/
readonly extendedProperties: {
[key: string]: string;
};
/**
* A friendly name for the frontDoor
*/
readonly friendlyName?: string;
/**
* The Id of the frontdoor.
*/
readonly frontdoorId: string;
/**
* Frontend endpoints available to routing rules.
*/
readonly frontendEndpoints?: outputs.frontdoor.FrontendEndpointResponse[];
/**
* Health probe settings associated with this Front Door instance.
*/
readonly healthProbeSettings?: outputs.frontdoor.HealthProbeSettingsModelResponse[];
/**
* Resource ID.
*/
readonly id: string;
/**
* Load balancing settings associated with this Front Door instance.
*/
readonly loadBalancingSettings?: outputs.frontdoor.LoadBalancingSettingsModelResponse[];
/**
* Resource location.
*/
readonly location?: string;
/**
* Resource name.
*/
readonly name: string;
/**
* Provisioning state of the Front Door.
*/
readonly provisioningState: string;
/**
* Resource status of the Front Door.
*/
readonly resourceState: string;
/**
* Routing rules associated with this Front Door.
*/
readonly routingRules?: outputs.frontdoor.RoutingRuleResponse[];
/**
* Rules Engine Configurations available to routing rules.
*/
readonly rulesEngines: outputs.frontdoor.RulesEngineResponse[];
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Resource type.
*/
readonly type: string;
}
/**
* Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
*
* 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 function getFrontDoorOutput(args: GetFrontDoorOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFrontDoorResult>;
export interface GetFrontDoorOutputArgs {
/**
* Name of the Front Door which is globally unique.
*/
frontDoorName: pulumi.Input<string>;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
}