@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.59 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";
/**
* App Service Environment ARM resource.
*
* Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.
*
* Other available API versions: 2016-09-01, 2018-02-01, 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01, 2024-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native web [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class AppServiceEnvironment extends pulumi.CustomResource {
/**
* Get an existing AppServiceEnvironment 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): AppServiceEnvironment;
/**
* Returns true if the given object is an instance of AppServiceEnvironment. 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 AppServiceEnvironment;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Custom settings for changing the behavior of the App Service Environment.
*/
readonly clusterSettings: pulumi.Output<outputs.web.NameValuePairResponse[] | undefined>;
/**
* Full view of the custom domain suffix configuration for ASEv3.
*/
readonly customDnsSuffixConfiguration: pulumi.Output<outputs.web.CustomDnsSuffixConfigurationResponse | undefined>;
/**
* Dedicated Host Count
*/
readonly dedicatedHostCount: pulumi.Output<number | undefined>;
/**
* DNS suffix of the App Service Environment.
*/
readonly dnsSuffix: pulumi.Output<string | undefined>;
/**
* Scale factor for front-ends.
*/
readonly frontEndScaleFactor: pulumi.Output<number | undefined>;
/**
* Flag that displays whether an ASE has linux workers or not
*/
readonly hasLinuxWorkers: pulumi.Output<boolean>;
/**
* Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
*/
readonly internalLoadBalancingMode: pulumi.Output<string | undefined>;
/**
* Number of IP SSL addresses reserved for the App Service Environment.
*/
readonly ipsslAddressCount: pulumi.Output<number | undefined>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
readonly kind: pulumi.Output<string | undefined>;
/**
* Resource Location.
*/
readonly location: pulumi.Output<string>;
/**
* Maximum number of VMs in the App Service Environment.
*/
readonly maximumNumberOfMachines: pulumi.Output<number>;
/**
* Number of front-end instances.
*/
readonly multiRoleCount: pulumi.Output<number>;
/**
* Front-end VM size, e.g. "Medium", "Large".
*/
readonly multiSize: pulumi.Output<string | undefined>;
/**
* Resource Name.
*/
readonly name: pulumi.Output<string>;
/**
* Full view of networking configuration for an ASE.
*/
readonly networkingConfiguration: pulumi.Output<outputs.web.AseV3NetworkingConfigurationResponse | undefined>;
/**
* Provisioning state of the App Service Environment.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Current status of the App Service Environment.
*/
readonly status: pulumi.Output<string>;
/**
* <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available
* (most likely because NSG blocked the incoming traffic).
*/
readonly suspended: pulumi.Output<boolean>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Whether an upgrade is available for this App Service Environment.
*/
readonly upgradeAvailability: pulumi.Output<string>;
/**
* Upgrade Preference
*/
readonly upgradePreference: pulumi.Output<string | undefined>;
/**
* User added ip ranges to whitelist on ASE db
*/
readonly userWhitelistedIpRanges: pulumi.Output<string[] | undefined>;
/**
* Description of the Virtual Network.
*/
readonly virtualNetwork: pulumi.Output<outputs.web.VirtualNetworkProfileResponse>;
/**
* Whether or not this App Service Environment is zone-redundant.
*/
readonly zoneRedundant: pulumi.Output<boolean | undefined>;
/**
* Create a AppServiceEnvironment 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: AppServiceEnvironmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a AppServiceEnvironment resource.
*/
export interface AppServiceEnvironmentArgs {
/**
* Custom settings for changing the behavior of the App Service Environment.
*/
clusterSettings?: pulumi.Input<pulumi.Input<inputs.web.NameValuePairArgs>[]>;
/**
* Full view of the custom domain suffix configuration for ASEv3.
*/
customDnsSuffixConfiguration?: pulumi.Input<inputs.web.CustomDnsSuffixConfigurationArgs>;
/**
* Dedicated Host Count
*/
dedicatedHostCount?: pulumi.Input<number>;
/**
* DNS suffix of the App Service Environment.
*/
dnsSuffix?: pulumi.Input<string>;
/**
* Scale factor for front-ends.
*/
frontEndScaleFactor?: pulumi.Input<number>;
/**
* Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
*/
internalLoadBalancingMode?: pulumi.Input<string | enums.web.LoadBalancingMode>;
/**
* Number of IP SSL addresses reserved for the App Service Environment.
*/
ipsslAddressCount?: pulumi.Input<number>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
kind?: pulumi.Input<string>;
/**
* Resource Location.
*/
location?: pulumi.Input<string>;
/**
* Front-end VM size, e.g. "Medium", "Large".
*/
multiSize?: pulumi.Input<string>;
/**
* Name of the App Service Environment.
*/
name?: pulumi.Input<string>;
/**
* Full view of networking configuration for an ASE.
*/
networkingConfiguration?: pulumi.Input<inputs.web.AseV3NetworkingConfigurationArgs>;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Upgrade Preference
*/
upgradePreference?: pulumi.Input<string | enums.web.UpgradePreference>;
/**
* User added ip ranges to whitelist on ASE db
*/
userWhitelistedIpRanges?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the Virtual Network.
*/
virtualNetwork: pulumi.Input<inputs.web.VirtualNetworkProfileArgs>;
/**
* Whether or not this App Service Environment is zone-redundant.
*/
zoneRedundant?: pulumi.Input<boolean>;
}