Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. AppServicePlan
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.AppServicePlan

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    App Service plan. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

    Other available API versions: 2016-09-01, 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.

    Example Usage

    Create Or Update App Service plan

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var appServicePlan = new AzureNative.Web.AppServicePlan("appServicePlan", new()
    {
        Kind = "app",
        Location = "East US",
        Name = "testsf6141",
        ResourceGroupName = "testrg123",
        Sku = new AzureNative.Web.Inputs.SkuDescriptionArgs
        {
            Capacity = 1,
            Family = "P",
            Name = "P1",
            Size = "P1",
            Tier = "Premium",
        },
    });

});

    package main

import (
	web "github.com/pulumi/pulumi-azure-native-sdk/web/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := web.NewAppServicePlan(ctx, "appServicePlan", &web.AppServicePlanArgs{
			Kind:              pulumi.String("app"),
			Location:          pulumi.String("East US"),
			Name:              pulumi.String("testsf6141"),
			ResourceGroupName: pulumi.String("testrg123"),
			Sku: &web.SkuDescriptionArgs{
				Capacity: pulumi.Int(1),
				Family:   pulumi.String("P"),
				Name:     pulumi.String("P1"),
				Size:     pulumi.String("P1"),
				Tier:     pulumi.String("Premium"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.AppServicePlan;
import com.pulumi.azurenative.web.AppServicePlanArgs;
import com.pulumi.azurenative.web.inputs.SkuDescriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var appServicePlan = new AppServicePlan("appServicePlan", AppServicePlanArgs.builder()
            .kind("app")
            .location("East US")
            .name("testsf6141")
            .resourceGroupName("testrg123")
            .sku(SkuDescriptionArgs.builder()
                .capacity(1)
                .family("P")
                .name("P1")
                .size("P1")
                .tier("Premium")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

app_service_plan = azure_native.web.AppServicePlan("appServicePlan",
    kind="app",
    location="East US",
    name="testsf6141",
    resource_group_name="testrg123",
    sku={
        "capacity": 1,
        "family": "P",
        "name": "P1",
        "size": "P1",
        "tier": "Premium",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const appServicePlan = new azure_native.web.AppServicePlan("appServicePlan", {
    kind: "app",
    location: "East US",
    name: "testsf6141",
    resourceGroupName: "testrg123",
    sku: {
        capacity: 1,
        family: "P",
        name: "P1",
        size: "P1",
        tier: "Premium",
    },
});

    resources:
  appServicePlan:
    type: azure-native:web:AppServicePlan
    properties:
      kind: app
      location: East US
      name: testsf6141
      resourceGroupName: testrg123
      sku:
        capacity: 1
        family: P
        name: P1
        size: P1
        tier: Premium

    Create AppServicePlan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AppServicePlan(name: string, args: AppServicePlanArgs, opts?: CustomResourceOptions);
    @overload
def AppServicePlan(resource_name: str,
                   args: AppServicePlanArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def AppServicePlan(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   resource_group_name: Optional[str] = None,
                   maximum_elastic_worker_count: Optional[int] = None,
                   is_spot: Optional[bool] = None,
                   name: Optional[str] = None,
                   reserved: Optional[bool] = None,
                   per_site_scaling: Optional[bool] = None,
                   is_xenon: Optional[bool] = None,
                   kind: Optional[str] = None,
                   kube_environment_profile: Optional[KubeEnvironmentProfileArgs] = None,
                   location: Optional[str] = None,
                   elastic_scale_enabled: Optional[bool] = None,
                   hosting_environment_profile: Optional[HostingEnvironmentProfileArgs] = None,
                   free_offer_expiration_time: Optional[str] = None,
                   hyper_v: Optional[bool] = None,
                   extended_location: Optional[ExtendedLocationArgs] = None,
                   sku: Optional[SkuDescriptionArgs] = None,
                   spot_expiration_time: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   target_worker_count: Optional[int] = None,
                   target_worker_size_id: Optional[int] = None,
                   worker_tier_name: Optional[str] = None,
                   zone_redundant: Optional[bool] = None)
    func NewAppServicePlan(ctx *Context, name string, args AppServicePlanArgs, opts ...ResourceOption) (*AppServicePlan, error)
    public AppServicePlan(string name, AppServicePlanArgs args, CustomResourceOptions? opts = null)
    public AppServicePlan(String name, AppServicePlanArgs args)
public AppServicePlan(String name, AppServicePlanArgs args, CustomResourceOptions options)

    type: azure-native:web:AppServicePlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AppServicePlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AppServicePlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AppServicePlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppServicePlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppServicePlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var appServicePlanResource = new AzureNative.Web.AppServicePlan("appServicePlanResource", new()
{
    ResourceGroupName = "string",
    MaximumElasticWorkerCount = 0,
    IsSpot = false,
    Name = "string",
    Reserved = false,
    PerSiteScaling = false,
    IsXenon = false,
    Kind = "string",
    KubeEnvironmentProfile = new AzureNative.Web.Inputs.KubeEnvironmentProfileArgs
    {
        Id = "string",
    },
    Location = "string",
    ElasticScaleEnabled = false,
    HostingEnvironmentProfile = new AzureNative.Web.Inputs.HostingEnvironmentProfileArgs
    {
        Id = "string",
    },
    FreeOfferExpirationTime = "string",
    HyperV = false,
    ExtendedLocation = new AzureNative.Web.Inputs.ExtendedLocationArgs
    {
        Name = "string",
    },
    Sku = new AzureNative.Web.Inputs.SkuDescriptionArgs
    {
        Capabilities = new[]
        {
            new AzureNative.Web.Inputs.CapabilityArgs
            {
                Name = "string",
                Reason = "string",
                Value = "string",
            },
        },
        Capacity = 0,
        Family = "string",
        Locations = new[]
        {
            "string",
        },
        Name = "string",
        Size = "string",
        SkuCapacity = new AzureNative.Web.Inputs.SkuCapacityArgs
        {
            Default = 0,
            ElasticMaximum = 0,
            Maximum = 0,
            Minimum = 0,
            ScaleType = "string",
        },
        Tier = "string",
    },
    SpotExpirationTime = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TargetWorkerCount = 0,
    TargetWorkerSizeId = 0,
    WorkerTierName = "string",
    ZoneRedundant = false,
});

    example, err := web.NewAppServicePlan(ctx, "appServicePlanResource", &web.AppServicePlanArgs{
	ResourceGroupName:         pulumi.String("string"),
	MaximumElasticWorkerCount: pulumi.Int(0),
	IsSpot:                    pulumi.Bool(false),
	Name:                      pulumi.String("string"),
	Reserved:                  pulumi.Bool(false),
	PerSiteScaling:            pulumi.Bool(false),
	IsXenon:                   pulumi.Bool(false),
	Kind:                      pulumi.String("string"),
	KubeEnvironmentProfile: &web.KubeEnvironmentProfileArgs{
		Id: pulumi.String("string"),
	},
	Location:            pulumi.String("string"),
	ElasticScaleEnabled: pulumi.Bool(false),
	HostingEnvironmentProfile: &web.HostingEnvironmentProfileArgs{
		Id: pulumi.String("string"),
	},
	FreeOfferExpirationTime: pulumi.String("string"),
	HyperV:                  pulumi.Bool(false),
	ExtendedLocation: &web.ExtendedLocationArgs{
		Name: pulumi.String("string"),
	},
	Sku: &web.SkuDescriptionArgs{
		Capabilities: web.CapabilityArray{
			&web.CapabilityArgs{
				Name:   pulumi.String("string"),
				Reason: pulumi.String("string"),
				Value:  pulumi.String("string"),
			},
		},
		Capacity: pulumi.Int(0),
		Family:   pulumi.String("string"),
		Locations: pulumi.StringArray{
			pulumi.String("string"),
		},
		Name: pulumi.String("string"),
		Size: pulumi.String("string"),
		SkuCapacity: &web.SkuCapacityArgs{
			Default:        pulumi.Int(0),
			ElasticMaximum: pulumi.Int(0),
			Maximum:        pulumi.Int(0),
			Minimum:        pulumi.Int(0),
			ScaleType:      pulumi.String("string"),
		},
		Tier: pulumi.String("string"),
	},
	SpotExpirationTime: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TargetWorkerCount:  pulumi.Int(0),
	TargetWorkerSizeId: pulumi.Int(0),
	WorkerTierName:     pulumi.String("string"),
	ZoneRedundant:      pulumi.Bool(false),
})

    var appServicePlanResource = new AppServicePlan("appServicePlanResource", AppServicePlanArgs.builder()
    .resourceGroupName("string")
    .maximumElasticWorkerCount(0)
    .isSpot(false)
    .name("string")
    .reserved(false)
    .perSiteScaling(false)
    .isXenon(false)
    .kind("string")
    .kubeEnvironmentProfile(KubeEnvironmentProfileArgs.builder()
        .id("string")
        .build())
    .location("string")
    .elasticScaleEnabled(false)
    .hostingEnvironmentProfile(HostingEnvironmentProfileArgs.builder()
        .id("string")
        .build())
    .freeOfferExpirationTime("string")
    .hyperV(false)
    .extendedLocation(ExtendedLocationArgs.builder()
        .name("string")
        .build())
    .sku(SkuDescriptionArgs.builder()
        .capabilities(CapabilityArgs.builder()
            .name("string")
            .reason("string")
            .value("string")
            .build())
        .capacity(0)
        .family("string")
        .locations("string")
        .name("string")
        .size("string")
        .skuCapacity(SkuCapacityArgs.builder()
            .default_(0)
            .elasticMaximum(0)
            .maximum(0)
            .minimum(0)
            .scaleType("string")
            .build())
        .tier("string")
        .build())
    .spotExpirationTime("string")
    .tags(Map.of("string", "string"))
    .targetWorkerCount(0)
    .targetWorkerSizeId(0)
    .workerTierName("string")
    .zoneRedundant(false)
    .build());

    app_service_plan_resource = azure_native.web.AppServicePlan("appServicePlanResource",
    resource_group_name="string",
    maximum_elastic_worker_count=0,
    is_spot=False,
    name="string",
    reserved=False,
    per_site_scaling=False,
    is_xenon=False,
    kind="string",
    kube_environment_profile={
        "id": "string",
    },
    location="string",
    elastic_scale_enabled=False,
    hosting_environment_profile={
        "id": "string",
    },
    free_offer_expiration_time="string",
    hyper_v=False,
    extended_location={
        "name": "string",
    },
    sku={
        "capabilities": [{
            "name": "string",
            "reason": "string",
            "value": "string",
        }],
        "capacity": 0,
        "family": "string",
        "locations": ["string"],
        "name": "string",
        "size": "string",
        "sku_capacity": {
            "default": 0,
            "elastic_maximum": 0,
            "maximum": 0,
            "minimum": 0,
            "scale_type": "string",
        },
        "tier": "string",
    },
    spot_expiration_time="string",
    tags={
        "string": "string",
    },
    target_worker_count=0,
    target_worker_size_id=0,
    worker_tier_name="string",
    zone_redundant=False)

    const appServicePlanResource = new azure_native.web.AppServicePlan("appServicePlanResource", {
    resourceGroupName: "string",
    maximumElasticWorkerCount: 0,
    isSpot: false,
    name: "string",
    reserved: false,
    perSiteScaling: false,
    isXenon: false,
    kind: "string",
    kubeEnvironmentProfile: {
        id: "string",
    },
    location: "string",
    elasticScaleEnabled: false,
    hostingEnvironmentProfile: {
        id: "string",
    },
    freeOfferExpirationTime: "string",
    hyperV: false,
    extendedLocation: {
        name: "string",
    },
    sku: {
        capabilities: [{
            name: "string",
            reason: "string",
            value: "string",
        }],
        capacity: 0,
        family: "string",
        locations: ["string"],
        name: "string",
        size: "string",
        skuCapacity: {
            "default": 0,
            elasticMaximum: 0,
            maximum: 0,
            minimum: 0,
            scaleType: "string",
        },
        tier: "string",
    },
    spotExpirationTime: "string",
    tags: {
        string: "string",
    },
    targetWorkerCount: 0,
    targetWorkerSizeId: 0,
    workerTierName: "string",
    zoneRedundant: false,
});

    type: azure-native:web:AppServicePlan
properties:
    elasticScaleEnabled: false
    extendedLocation:
        name: string
    freeOfferExpirationTime: string
    hostingEnvironmentProfile:
        id: string
    hyperV: false
    isSpot: false
    isXenon: false
    kind: string
    kubeEnvironmentProfile:
        id: string
    location: string
    maximumElasticWorkerCount: 0
    name: string
    perSiteScaling: false
    reserved: false
    resourceGroupName: string
    sku:
        capabilities:
            - name: string
              reason: string
              value: string
        capacity: 0
        family: string
        locations:
            - string
        name: string
        size: string
        skuCapacity:
            default: 0
            elasticMaximum: 0
            maximum: 0
            minimum: 0
            scaleType: string
        tier: string
    spotExpirationTime: string
    tags:
        string: string
    targetWorkerCount: 0
    targetWorkerSizeId: 0
    workerTierName: string
    zoneRedundant: false

    AppServicePlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AppServicePlan resource accepts the following input properties:

    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    ElasticScaleEnabled bool
    ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
    ExtendedLocation Pulumi.AzureNative.Web.Inputs.ExtendedLocation
    Extended Location.
    FreeOfferExpirationTime string
    The time when the server farm free offer expires.
    HostingEnvironmentProfile Pulumi.AzureNative.Web.Inputs.HostingEnvironmentProfile
    Specification for the App Service Environment to use for the App Service plan.
    HyperV bool
    If Hyper-V container app service plan true, false otherwise.
    IsSpot bool
    If true, this App Service Plan owns spot instances.
    IsXenon bool
    Obsolete: If Hyper-V container app service plan true, false otherwise.
    Kind string
    Kind of resource.
    KubeEnvironmentProfile Pulumi.AzureNative.Web.Inputs.KubeEnvironmentProfile
    Specification for the Kubernetes Environment to use for the App Service plan.
    Location string
    Resource Location.
    MaximumElasticWorkerCount int
    Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
    Name string
    Name of the App Service plan.
    PerSiteScaling bool
    If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
    Reserved bool
    If Linux app service plan true, false otherwise.
    Sku Pulumi.AzureNative.Web.Inputs.SkuDescription
    Description of a SKU for a scalable resource.
    SpotExpirationTime string
    The time when the server farm expires. Valid only if it is a spot server farm.
    Tags Dictionary<string, string>
    Resource tags.
    TargetWorkerCount int
    Scaling worker count.
    TargetWorkerSizeId int
    Scaling worker size ID.
    WorkerTierName string
    Target worker tier assigned to the App Service plan.
    ZoneRedundant bool
    If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
    ResourceGroupName string
    Name of the resource group to which the resource belongs.
    ElasticScaleEnabled bool
    ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
    ExtendedLocation ExtendedLocationArgs
    Extended Location.
    FreeOfferExpirationTime string
    The time when the server farm free offer expires.
    HostingEnvironmentProfile HostingEnvironmentProfileArgs
    Specification for the App Service Environment to use for the App Service plan.
    HyperV bool
    If Hyper-V container app service plan true, false otherwise.
    IsSpot bool
    If true, this App Service Plan owns spot instances.
    IsXenon bool
    Obsolete: If Hyper-V container app service plan true, false otherwise.
    Kind string
    Kind of resource.
    KubeEnvironmentProfile KubeEnvironmentProfileArgs
    Specification for the Kubernetes Environment to use for the App Service plan.
    Location string
    Resource Location.
    MaximumElasticWorkerCount int
    Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
    Name string
    Name of the App Service plan.
    PerSiteScaling bool
    If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
    Reserved bool
    If Linux app service plan true, false otherwise.
    Sku SkuDescriptionArgs
    Description of a SKU for a scalable resource.
    SpotExpirationTime string
    The time when the server farm expires. Valid only if it is a spot server farm.
    Tags map[string]string
    Resource tags.
    TargetWorkerCount int
    Scaling worker count.
    TargetWorkerSizeId int
    Scaling worker size ID.
    WorkerTierName string
    Target worker tier assigned to the App Service plan.
    ZoneRedundant bool
    If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    elasticScaleEnabled Boolean
    ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
    extendedLocation ExtendedLocation
    Extended Location.
    freeOfferExpirationTime String
    The time when the server farm free offer expires.
    hostingEnvironmentProfile HostingEnvironmentProfile
    Specification for the App Service Environment to use for the App Service plan.
    hyperV Boolean
    If Hyper-V container app service plan true, false otherwise.
    isSpot Boolean
    If true, this App Service Plan owns spot instances.
    isXenon Boolean
    Obsolete: If Hyper-V container app service plan true, false otherwise.
    kind String
    Kind of resource.
    kubeEnvironmentProfile KubeEnvironmentProfile
    Specification for the Kubernetes Environment to use for the App Service plan.
    location String
    Resource Location.
    maximumElasticWorkerCount Integer
    Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
    name String
    Name of the App Service plan.
    perSiteScaling Boolean
    If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
    reserved Boolean
    If Linux app service plan true, false otherwise.
    sku SkuDescription
    Description of a SKU for a scalable resource.
    spotExpirationTime String
    The time when the server farm expires. Valid only if it is a spot server farm.
    tags Map<String,String>
    Resource tags.
    targetWorkerCount Integer
    Scaling worker count.
    targetWorkerSizeId Integer
    Scaling worker size ID.
    workerTierName String
    Target worker tier assigned to the App Service plan.
    zoneRedundant Boolean
    If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
    resourceGroupName string
    Name of the resource group to which the resource belongs.
    elasticScaleEnabled boolean
    ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
    extendedLocation ExtendedLocation
    Extended Location.
    freeOfferExpirationTime string
    The time when the server farm free offer expires.
    hostingEnvironmentProfile HostingEnvironmentProfile
    Specification for the App Service Environment to use for the App Service plan.
    hyperV boolean
    If Hyper-V container app service plan true, false otherwise.
    isSpot boolean
    If true, this App Service Plan owns spot instances.
    isXenon boolean
    Obsolete: If Hyper-V container app service plan true, false otherwise.
    kind string
    Kind of resource.
    kubeEnvironmentProfile KubeEnvironmentProfile
    Specification for the Kubernetes Environment to use for the App Service plan.
    location string
    Resource Location.
    maximumElasticWorkerCount number
    Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
    name string
    Name of the App Service plan.
    perSiteScaling boolean
    If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
    reserved boolean
    If Linux app service plan true, false otherwise.
    sku SkuDescription
    Description of a SKU for a scalable resource.
    spotExpirationTime string
    The time when the server farm expires. Valid only if it is a spot server farm.
    tags {[key: string]: string}
    Resource tags.
    targetWorkerCount number
    Scaling worker count.
    targetWorkerSizeId number
    Scaling worker size ID.
    workerTierName string
    Target worker tier assigned to the App Service plan.
    zoneRedundant boolean
    If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
    resource_group_name str
    Name of the resource group to which the resource belongs.
    elastic_scale_enabled bool
    ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
    extended_location ExtendedLocationArgs
    Extended Location.
    free_offer_expiration_time str
    The time when the server farm free offer expires.
    hosting_environment_profile HostingEnvironmentProfileArgs
    Specification for the App Service Environment to use for the App Service plan.
    hyper_v bool
    If Hyper-V container app service plan true, false otherwise.
    is_spot bool
    If true, this App Service Plan owns spot instances.
    is_xenon bool
    Obsolete: If Hyper-V container app service plan true, false otherwise.
    kind str
    Kind of resource.
    kube_environment_profile KubeEnvironmentProfileArgs
    Specification for the Kubernetes Environment to use for the App Service plan.
    location str
    Resource Location.
    maximum_elastic_worker_count int
    Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
    name str
    Name of the App Service plan.
    per_site_scaling bool
    If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
    reserved bool
    If Linux app service plan true, false otherwise.
    sku SkuDescriptionArgs
    Description of a SKU for a scalable resource.
    spot_expiration_time str
    The time when the server farm expires. Valid only if it is a spot server farm.
    tags Mapping[str, str]
    Resource tags.
    target_worker_count int
    Scaling worker count.
    target_worker_size_id int
    Scaling worker size ID.
    worker_tier_name str
    Target worker tier assigned to the App Service plan.
    zone_redundant bool
    If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
    resourceGroupName String
    Name of the resource group to which the resource belongs.
    elasticScaleEnabled Boolean
    ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
    extendedLocation Property Map
    Extended Location.
    freeOfferExpirationTime String
    The time when the server farm free offer expires.
    hostingEnvironmentProfile Property Map
    Specification for the App Service Environment to use for the App Service plan.
    hyperV Boolean
    If Hyper-V container app service plan true, false otherwise.
    isSpot Boolean
    If true, this App Service Plan owns spot instances.
    isXenon Boolean
    Obsolete: If Hyper-V container app service plan true, false otherwise.
    kind String
    Kind of resource.
    kubeEnvironmentProfile Property Map
    Specification for the Kubernetes Environment to use for the App Service plan.
    location String
    Resource Location.
    maximumElasticWorkerCount Number
    Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
    name String
    Name of the App Service plan.
    perSiteScaling Boolean
    If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.
    reserved Boolean
    If Linux app service plan true, false otherwise.
    sku Property Map
    Description of a SKU for a scalable resource.
    spotExpirationTime String
    The time when the server farm expires. Valid only if it is a spot server farm.
    tags Map<String>
    Resource tags.
    targetWorkerCount Number
    Scaling worker count.
    targetWorkerSizeId Number
    Scaling worker size ID.
    workerTierName String
    Target worker tier assigned to the App Service plan.
    zoneRedundant Boolean
    If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AppServicePlan resource produces the following output properties:

    GeoRegion string
    Geographical location for the App Service plan.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaximumNumberOfWorkers int
    Maximum number of instances that can be assigned to this App Service plan.
    NumberOfSites int
    Number of apps assigned to this App Service plan.
    NumberOfWorkers int
    The number of instances that are assigned to this App Service plan.
    ProvisioningState string
    Provisioning state of the App Service Plan.
    ResourceGroup string
    Resource group of the App Service plan.
    Status string
    App Service plan status.
    Subscription string
    App Service plan subscription.
    Type string
    Resource type.
    GeoRegion string
    Geographical location for the App Service plan.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaximumNumberOfWorkers int
    Maximum number of instances that can be assigned to this App Service plan.
    NumberOfSites int
    Number of apps assigned to this App Service plan.
    NumberOfWorkers int
    The number of instances that are assigned to this App Service plan.
    ProvisioningState string
    Provisioning state of the App Service Plan.
    ResourceGroup string
    Resource group of the App Service plan.
    Status string
    App Service plan status.
    Subscription string
    App Service plan subscription.
    Type string
    Resource type.
    geoRegion String
    Geographical location for the App Service plan.
    id String
    The provider-assigned unique ID for this managed resource.
    maximumNumberOfWorkers Integer
    Maximum number of instances that can be assigned to this App Service plan.
    numberOfSites Integer
    Number of apps assigned to this App Service plan.
    numberOfWorkers Integer
    The number of instances that are assigned to this App Service plan.
    provisioningState String
    Provisioning state of the App Service Plan.
    resourceGroup String
    Resource group of the App Service plan.
    status String
    App Service plan status.
    subscription String
    App Service plan subscription.
    type String
    Resource type.
    geoRegion string
    Geographical location for the App Service plan.
    id string
    The provider-assigned unique ID for this managed resource.
    maximumNumberOfWorkers number
    Maximum number of instances that can be assigned to this App Service plan.
    numberOfSites number
    Number of apps assigned to this App Service plan.
    numberOfWorkers number
    The number of instances that are assigned to this App Service plan.
    provisioningState string
    Provisioning state of the App Service Plan.
    resourceGroup string
    Resource group of the App Service plan.
    status string
    App Service plan status.
    subscription string
    App Service plan subscription.
    type string
    Resource type.
    geo_region str
    Geographical location for the App Service plan.
    id str
    The provider-assigned unique ID for this managed resource.
    maximum_number_of_workers int
    Maximum number of instances that can be assigned to this App Service plan.
    number_of_sites int
    Number of apps assigned to this App Service plan.
    number_of_workers int
    The number of instances that are assigned to this App Service plan.
    provisioning_state str
    Provisioning state of the App Service Plan.
    resource_group str
    Resource group of the App Service plan.
    status str
    App Service plan status.
    subscription str
    App Service plan subscription.
    type str
    Resource type.
    geoRegion String
    Geographical location for the App Service plan.
    id String
    The provider-assigned unique ID for this managed resource.
    maximumNumberOfWorkers Number
    Maximum number of instances that can be assigned to this App Service plan.
    numberOfSites Number
    Number of apps assigned to this App Service plan.
    numberOfWorkers Number
    The number of instances that are assigned to this App Service plan.
    provisioningState String
    Provisioning state of the App Service Plan.
    resourceGroup String
    Resource group of the App Service plan.
    status String
    App Service plan status.
    subscription String
    App Service plan subscription.
    type String
    Resource type.

    Supporting Types

    Capability, CapabilityArgs

    Name string
    Name of the SKU capability.
    Reason string
    Reason of the SKU capability.
    Value string
    Value of the SKU capability.
    Name string
    Name of the SKU capability.
    Reason string
    Reason of the SKU capability.
    Value string
    Value of the SKU capability.
    name String
    Name of the SKU capability.
    reason String
    Reason of the SKU capability.
    value String
    Value of the SKU capability.
    name string
    Name of the SKU capability.
    reason string
    Reason of the SKU capability.
    value string
    Value of the SKU capability.
    name str
    Name of the SKU capability.
    reason str
    Reason of the SKU capability.
    value str
    Value of the SKU capability.
    name String
    Name of the SKU capability.
    reason String
    Reason of the SKU capability.
    value String
    Value of the SKU capability.

    CapabilityResponse, CapabilityResponseArgs

    Name string
    Name of the SKU capability.
    Reason string
    Reason of the SKU capability.
    Value string
    Value of the SKU capability.
    Name string
    Name of the SKU capability.
    Reason string
    Reason of the SKU capability.
    Value string
    Value of the SKU capability.
    name String
    Name of the SKU capability.
    reason String
    Reason of the SKU capability.
    value String
    Value of the SKU capability.
    name string
    Name of the SKU capability.
    reason string
    Reason of the SKU capability.
    value string
    Value of the SKU capability.
    name str
    Name of the SKU capability.
    reason str
    Reason of the SKU capability.
    value str
    Value of the SKU capability.
    name String
    Name of the SKU capability.
    reason String
    Reason of the SKU capability.
    value String
    Value of the SKU capability.

    ExtendedLocation, ExtendedLocationArgs

    Name string
    Name of extended location.
    Name string
    Name of extended location.
    name String
    Name of extended location.
    name string
    Name of extended location.
    name str
    Name of extended location.
    name String
    Name of extended location.

    ExtendedLocationResponse, ExtendedLocationResponseArgs

    Type string
    Type of extended location.
    Name string
    Name of extended location.
    Type string
    Type of extended location.
    Name string
    Name of extended location.
    type String
    Type of extended location.
    name String
    Name of extended location.
    type string
    Type of extended location.
    name string
    Name of extended location.
    type str
    Type of extended location.
    name str
    Name of extended location.
    type String
    Type of extended location.
    name String
    Name of extended location.

    HostingEnvironmentProfile, HostingEnvironmentProfileArgs

    Id string
    Resource ID of the App Service Environment.
    Id string
    Resource ID of the App Service Environment.
    id String
    Resource ID of the App Service Environment.
    id string
    Resource ID of the App Service Environment.
    id str
    Resource ID of the App Service Environment.
    id String
    Resource ID of the App Service Environment.

    HostingEnvironmentProfileResponse, HostingEnvironmentProfileResponseArgs

    Name string
    Name of the App Service Environment.
    Type string
    Resource type of the App Service Environment.
    Id string
    Resource ID of the App Service Environment.
    Name string
    Name of the App Service Environment.
    Type string
    Resource type of the App Service Environment.
    Id string
    Resource ID of the App Service Environment.
    name String
    Name of the App Service Environment.
    type String
    Resource type of the App Service Environment.
    id String
    Resource ID of the App Service Environment.
    name string
    Name of the App Service Environment.
    type string
    Resource type of the App Service Environment.
    id string
    Resource ID of the App Service Environment.
    name str
    Name of the App Service Environment.
    type str
    Resource type of the App Service Environment.
    id str
    Resource ID of the App Service Environment.
    name String
    Name of the App Service Environment.
    type String
    Resource type of the App Service Environment.
    id String
    Resource ID of the App Service Environment.

    KubeEnvironmentProfile, KubeEnvironmentProfileArgs

    Id string
    Resource ID of the Kubernetes Environment.
    Id string
    Resource ID of the Kubernetes Environment.
    id String
    Resource ID of the Kubernetes Environment.
    id string
    Resource ID of the Kubernetes Environment.
    id str
    Resource ID of the Kubernetes Environment.
    id String
    Resource ID of the Kubernetes Environment.

    KubeEnvironmentProfileResponse, KubeEnvironmentProfileResponseArgs

    Name string
    Name of the Kubernetes Environment.
    Type string
    Resource type of the Kubernetes Environment.
    Id string
    Resource ID of the Kubernetes Environment.
    Name string
    Name of the Kubernetes Environment.
    Type string
    Resource type of the Kubernetes Environment.
    Id string
    Resource ID of the Kubernetes Environment.
    name String
    Name of the Kubernetes Environment.
    type String
    Resource type of the Kubernetes Environment.
    id String
    Resource ID of the Kubernetes Environment.
    name string
    Name of the Kubernetes Environment.
    type string
    Resource type of the Kubernetes Environment.
    id string
    Resource ID of the Kubernetes Environment.
    name str
    Name of the Kubernetes Environment.
    type str
    Resource type of the Kubernetes Environment.
    id str
    Resource ID of the Kubernetes Environment.
    name String
    Name of the Kubernetes Environment.
    type String
    Resource type of the Kubernetes Environment.
    id String
    Resource ID of the Kubernetes Environment.

    SkuCapacity, SkuCapacityArgs

    Default int
    Default number of workers for this App Service plan SKU.
    ElasticMaximum int
    Maximum number of Elastic workers for this App Service plan SKU.
    Maximum int
    Maximum number of workers for this App Service plan SKU.
    Minimum int
    Minimum number of workers for this App Service plan SKU.
    ScaleType string
    Available scale configurations for an App Service plan.
    Default int
    Default number of workers for this App Service plan SKU.
    ElasticMaximum int
    Maximum number of Elastic workers for this App Service plan SKU.
    Maximum int
    Maximum number of workers for this App Service plan SKU.
    Minimum int
    Minimum number of workers for this App Service plan SKU.
    ScaleType string
    Available scale configurations for an App Service plan.
    default_ Integer
    Default number of workers for this App Service plan SKU.
    elasticMaximum Integer
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum Integer
    Maximum number of workers for this App Service plan SKU.
    minimum Integer
    Minimum number of workers for this App Service plan SKU.
    scaleType String
    Available scale configurations for an App Service plan.
    default number
    Default number of workers for this App Service plan SKU.
    elasticMaximum number
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum number
    Maximum number of workers for this App Service plan SKU.
    minimum number
    Minimum number of workers for this App Service plan SKU.
    scaleType string
    Available scale configurations for an App Service plan.
    default int
    Default number of workers for this App Service plan SKU.
    elastic_maximum int
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum int
    Maximum number of workers for this App Service plan SKU.
    minimum int
    Minimum number of workers for this App Service plan SKU.
    scale_type str
    Available scale configurations for an App Service plan.
    default Number
    Default number of workers for this App Service plan SKU.
    elasticMaximum Number
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum Number
    Maximum number of workers for this App Service plan SKU.
    minimum Number
    Minimum number of workers for this App Service plan SKU.
    scaleType String
    Available scale configurations for an App Service plan.

    SkuCapacityResponse, SkuCapacityResponseArgs

    Default int
    Default number of workers for this App Service plan SKU.
    ElasticMaximum int
    Maximum number of Elastic workers for this App Service plan SKU.
    Maximum int
    Maximum number of workers for this App Service plan SKU.
    Minimum int
    Minimum number of workers for this App Service plan SKU.
    ScaleType string
    Available scale configurations for an App Service plan.
    Default int
    Default number of workers for this App Service plan SKU.
    ElasticMaximum int
    Maximum number of Elastic workers for this App Service plan SKU.
    Maximum int
    Maximum number of workers for this App Service plan SKU.
    Minimum int
    Minimum number of workers for this App Service plan SKU.
    ScaleType string
    Available scale configurations for an App Service plan.
    default_ Integer
    Default number of workers for this App Service plan SKU.
    elasticMaximum Integer
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum Integer
    Maximum number of workers for this App Service plan SKU.
    minimum Integer
    Minimum number of workers for this App Service plan SKU.
    scaleType String
    Available scale configurations for an App Service plan.
    default number
    Default number of workers for this App Service plan SKU.
    elasticMaximum number
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum number
    Maximum number of workers for this App Service plan SKU.
    minimum number
    Minimum number of workers for this App Service plan SKU.
    scaleType string
    Available scale configurations for an App Service plan.
    default int
    Default number of workers for this App Service plan SKU.
    elastic_maximum int
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum int
    Maximum number of workers for this App Service plan SKU.
    minimum int
    Minimum number of workers for this App Service plan SKU.
    scale_type str
    Available scale configurations for an App Service plan.
    default Number
    Default number of workers for this App Service plan SKU.
    elasticMaximum Number
    Maximum number of Elastic workers for this App Service plan SKU.
    maximum Number
    Maximum number of workers for this App Service plan SKU.
    minimum Number
    Minimum number of workers for this App Service plan SKU.
    scaleType String
    Available scale configurations for an App Service plan.

    SkuDescription, SkuDescriptionArgs

    Capabilities List<Pulumi.AzureNative.Web.Inputs.Capability>
    Capabilities of the SKU, e.g., is traffic manager enabled?
    Capacity int
    Current number of instances assigned to the resource.
    Family string
    Family code of the resource SKU.
    Locations List<string>
    Locations of the SKU.
    Name string
    Name of the resource SKU.
    Size string
    Size specifier of the resource SKU.
    SkuCapacity Pulumi.AzureNative.Web.Inputs.SkuCapacity
    Min, max, and default scale values of the SKU.
    Tier string
    Service tier of the resource SKU.
    Capabilities []Capability
    Capabilities of the SKU, e.g., is traffic manager enabled?
    Capacity int
    Current number of instances assigned to the resource.
    Family string
    Family code of the resource SKU.
    Locations []string
    Locations of the SKU.
    Name string
    Name of the resource SKU.
    Size string
    Size specifier of the resource SKU.
    SkuCapacity SkuCapacity
    Min, max, and default scale values of the SKU.
    Tier string
    Service tier of the resource SKU.
    capabilities List<Capability>
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity Integer
    Current number of instances assigned to the resource.
    family String
    Family code of the resource SKU.
    locations List<String>
    Locations of the SKU.
    name String
    Name of the resource SKU.
    size String
    Size specifier of the resource SKU.
    skuCapacity SkuCapacity
    Min, max, and default scale values of the SKU.
    tier String
    Service tier of the resource SKU.
    capabilities Capability[]
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity number
    Current number of instances assigned to the resource.
    family string
    Family code of the resource SKU.
    locations string[]
    Locations of the SKU.
    name string
    Name of the resource SKU.
    size string
    Size specifier of the resource SKU.
    skuCapacity SkuCapacity
    Min, max, and default scale values of the SKU.
    tier string
    Service tier of the resource SKU.
    capabilities Sequence[Capability]
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity int
    Current number of instances assigned to the resource.
    family str
    Family code of the resource SKU.
    locations Sequence[str]
    Locations of the SKU.
    name str
    Name of the resource SKU.
    size str
    Size specifier of the resource SKU.
    sku_capacity SkuCapacity
    Min, max, and default scale values of the SKU.
    tier str
    Service tier of the resource SKU.
    capabilities List<Property Map>
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity Number
    Current number of instances assigned to the resource.
    family String
    Family code of the resource SKU.
    locations List<String>
    Locations of the SKU.
    name String
    Name of the resource SKU.
    size String
    Size specifier of the resource SKU.
    skuCapacity Property Map
    Min, max, and default scale values of the SKU.
    tier String
    Service tier of the resource SKU.

    SkuDescriptionResponse, SkuDescriptionResponseArgs

    Capabilities List<Pulumi.AzureNative.Web.Inputs.CapabilityResponse>
    Capabilities of the SKU, e.g., is traffic manager enabled?
    Capacity int
    Current number of instances assigned to the resource.
    Family string
    Family code of the resource SKU.
    Locations List<string>
    Locations of the SKU.
    Name string
    Name of the resource SKU.
    Size string
    Size specifier of the resource SKU.
    SkuCapacity Pulumi.AzureNative.Web.Inputs.SkuCapacityResponse
    Min, max, and default scale values of the SKU.
    Tier string
    Service tier of the resource SKU.
    Capabilities []CapabilityResponse
    Capabilities of the SKU, e.g., is traffic manager enabled?
    Capacity int
    Current number of instances assigned to the resource.
    Family string
    Family code of the resource SKU.
    Locations []string
    Locations of the SKU.
    Name string
    Name of the resource SKU.
    Size string
    Size specifier of the resource SKU.
    SkuCapacity SkuCapacityResponse
    Min, max, and default scale values of the SKU.
    Tier string
    Service tier of the resource SKU.
    capabilities List<CapabilityResponse>
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity Integer
    Current number of instances assigned to the resource.
    family String
    Family code of the resource SKU.
    locations List<String>
    Locations of the SKU.
    name String
    Name of the resource SKU.
    size String
    Size specifier of the resource SKU.
    skuCapacity SkuCapacityResponse
    Min, max, and default scale values of the SKU.
    tier String
    Service tier of the resource SKU.
    capabilities CapabilityResponse[]
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity number
    Current number of instances assigned to the resource.
    family string
    Family code of the resource SKU.
    locations string[]
    Locations of the SKU.
    name string
    Name of the resource SKU.
    size string
    Size specifier of the resource SKU.
    skuCapacity SkuCapacityResponse
    Min, max, and default scale values of the SKU.
    tier string
    Service tier of the resource SKU.
    capabilities Sequence[CapabilityResponse]
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity int
    Current number of instances assigned to the resource.
    family str
    Family code of the resource SKU.
    locations Sequence[str]
    Locations of the SKU.
    name str
    Name of the resource SKU.
    size str
    Size specifier of the resource SKU.
    sku_capacity SkuCapacityResponse
    Min, max, and default scale values of the SKU.
    tier str
    Service tier of the resource SKU.
    capabilities List<Property Map>
    Capabilities of the SKU, e.g., is traffic manager enabled?
    capacity Number
    Current number of instances assigned to the resource.
    family String
    Family code of the resource SKU.
    locations List<String>
    Locations of the SKU.
    name String
    Name of the resource SKU.
    size String
    Size specifier of the resource SKU.
    skuCapacity Property Map
    Min, max, and default scale values of the SKU.
    tier String
    Service tier of the resource SKU.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:web:AppServicePlan testsf6141 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native