@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Description for Get an App Service plan.
*
* Uses Azure REST API version 2024-04-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 function getAppServicePlan(args: GetAppServicePlanArgs, opts?: pulumi.InvokeOptions): Promise<GetAppServicePlanResult>;
export interface GetAppServicePlanArgs {
/**
* Name of the App Service plan.
*/
name: string;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: string;
}
/**
* App Service plan.
*/
export interface GetAppServicePlanResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
*/
readonly elasticScaleEnabled?: boolean;
/**
* Extended Location.
*/
readonly extendedLocation?: outputs.web.ExtendedLocationResponse;
/**
* The time when the server farm free offer expires.
*/
readonly freeOfferExpirationTime?: string;
/**
* Geographical location for the App Service plan.
*/
readonly geoRegion: string;
/**
* Specification for the App Service Environment to use for the App Service plan.
*/
readonly hostingEnvironmentProfile?: outputs.web.HostingEnvironmentProfileResponse;
/**
* If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
*/
readonly hyperV?: boolean;
/**
* Resource Id.
*/
readonly id: string;
/**
* If <code>true</code>, this App Service Plan owns spot instances.
*/
readonly isSpot?: boolean;
/**
* Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise.
*/
readonly isXenon?: boolean;
/**
* 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?: string;
/**
* Specification for the Kubernetes Environment to use for the App Service plan.
*/
readonly kubeEnvironmentProfile?: outputs.web.KubeEnvironmentProfileResponse;
/**
* Resource Location.
*/
readonly location: string;
/**
* Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
*/
readonly maximumElasticWorkerCount?: number;
/**
* Maximum number of instances that can be assigned to this App Service plan.
*/
readonly maximumNumberOfWorkers: number;
/**
* Resource Name.
*/
readonly name: string;
/**
* Number of apps assigned to this App Service plan.
*/
readonly numberOfSites: number;
/**
* The number of instances that are assigned to this App Service plan.
*/
readonly numberOfWorkers: number;
/**
* If <code>true</code>, apps assigned to this App Service plan can be scaled independently.
* If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.
*/
readonly perSiteScaling?: boolean;
/**
* Provisioning state of the App Service Plan.
*/
readonly provisioningState: string;
/**
* If Linux app service plan <code>true</code>, <code>false</code> otherwise.
*/
readonly reserved?: boolean;
/**
* Resource group of the App Service plan.
*/
readonly resourceGroup: string;
/**
* Description of a SKU for a scalable resource.
*/
readonly sku?: outputs.web.SkuDescriptionResponse;
/**
* The time when the server farm expires. Valid only if it is a spot server farm.
*/
readonly spotExpirationTime?: string;
/**
* App Service plan status.
*/
readonly status: string;
/**
* App Service plan subscription.
*/
readonly subscription: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Scaling worker count.
*/
readonly targetWorkerCount?: number;
/**
* Scaling worker size ID.
*/
readonly targetWorkerSizeId?: number;
/**
* Resource type.
*/
readonly type: string;
/**
* Target worker tier assigned to the App Service plan.
*/
readonly workerTierName?: string;
/**
* If <code>true</code>, this App Service Plan will perform availability zone balancing.
* If <code>false</code>, this App Service Plan will not perform availability zone balancing.
*/
readonly zoneRedundant?: boolean;
}
/**
* Description for Get an App Service plan.
*
* Uses Azure REST API version 2024-04-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 function getAppServicePlanOutput(args: GetAppServicePlanOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAppServicePlanResult>;
export interface GetAppServicePlanOutputArgs {
/**
* Name of the App Service plan.
*/
name: pulumi.Input<string>;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: pulumi.Input<string>;
}