GetAppServicePlan

Use this data source to access information about an existing App Service Plan (formerly known as a Server Farm).

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.AppService.GetAppServicePlan.InvokeAsync(new Azure.AppService.GetAppServicePlanArgs
        {
            Name = "search-app-service-plan",
            ResourceGroupName = "search-service",
        }));
        this.AppServicePlanId = example.Apply(example => example.Id);
    }

    [Output("appServicePlanId")]
    public Output<string> AppServicePlanId { get; set; }
}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        example, err := appservice.GetAppServicePlan(ctx, &appservice.GetAppServicePlanArgs{
            Name:              "search-app-service-plan",
            ResourceGroupName: "search-service",
        }, nil)
        if err != nil {
            return err
        }
        ctx.Export("appServicePlanId", example.Id)
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.appservice.get_app_service_plan(name="search-app-service-plan",
    resource_group_name="search-service")
pulumi.export("appServicePlanId", example.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.appservice.getAppServicePlan({
    name: "search-app-service-plan",
    resourceGroupName: "search-service",
});
export const appServicePlanId = example.then(example => example.id);

Using GetAppServicePlan

function getAppServicePlan(args: GetAppServicePlanArgs, opts?: InvokeOptions): Promise<GetAppServicePlanResult>

function  get_app_service_plan(name=None, resource_group_name=None, opts=None)

func GetAppServicePlan(ctx *Context, args *GetAppServicePlanArgs, opts ...InvokeOption) (*GetAppServicePlanResult, error)

public static class GetAppServicePlan {
    public static Task<GetAppServicePlanResult> InvokeAsync(GetAppServicePlanArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the App Service Plan.
ResourceGroupName string: The Name of the Resource Group where the App Service Plan exists.

Name string: The name of the App Service Plan.
ResourceGroupName string: The Name of the Resource Group where the App Service Plan exists.

name string: The name of the App Service Plan.
resourceGroupName string: The Name of the Resource Group where the App Service Plan exists.

name str: The name of the App Service Plan.
resource_group_name str: The Name of the Resource Group where the App Service Plan exists.

GetAppServicePlan Result

The following output properties are available:

AppServiceEnvironmentId string: The ID of the App Service Environment where the App Service Plan is located.
Id string: The provider-assigned unique ID for this managed resource.
IsXenon bool: A flag that indicates if it’s a xenon plan (support for Windows Container)
Kind string: The Operating System type of the App Service Plan
Location string: The Azure location where the App Service Plan exists
MaximumElasticWorkerCount int: The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
MaximumNumberOfWorkers int: The maximum number of workers supported with the App Service Plan’s sku.
Name string
PerSiteScaling bool: Can Apps assigned to this App Service Plan be scaled independently?
Reserved bool: Is this App Service Plan Reserved?
ResourceGroupName string
Sku GetAppServicePlanSku: A sku block as documented below.
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

AppServiceEnvironmentId string: The ID of the App Service Environment where the App Service Plan is located.
Id string: The provider-assigned unique ID for this managed resource.
IsXenon bool: A flag that indicates if it’s a xenon plan (support for Windows Container)
Kind string: The Operating System type of the App Service Plan
Location string: The Azure location where the App Service Plan exists
MaximumElasticWorkerCount int: The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
MaximumNumberOfWorkers int: The maximum number of workers supported with the App Service Plan’s sku.
Name string
PerSiteScaling bool: Can Apps assigned to this App Service Plan be scaled independently?
Reserved bool: Is this App Service Plan Reserved?
ResourceGroupName string
Sku GetAppServicePlanSku: A sku block as documented below.
Tags map[string]string: A mapping of tags assigned to the resource.

appServiceEnvironmentId string: The ID of the App Service Environment where the App Service Plan is located.
id string: The provider-assigned unique ID for this managed resource.
isXenon boolean: A flag that indicates if it’s a xenon plan (support for Windows Container)
kind string: The Operating System type of the App Service Plan
location string: The Azure location where the App Service Plan exists
maximumElasticWorkerCount number: The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
maximumNumberOfWorkers number: The maximum number of workers supported with the App Service Plan’s sku.
name string
perSiteScaling boolean: Can Apps assigned to this App Service Plan be scaled independently?
reserved boolean: Is this App Service Plan Reserved?
resourceGroupName string
sku GetAppServicePlanSku: A sku block as documented below.
tags {[key: string]: string}: A mapping of tags assigned to the resource.

app_service_environment_id str: The ID of the App Service Environment where the App Service Plan is located.
id str: The provider-assigned unique ID for this managed resource.
is_xenon bool: A flag that indicates if it’s a xenon plan (support for Windows Container)
kind str: The Operating System type of the App Service Plan
location str: The Azure location where the App Service Plan exists
maximum_elastic_worker_count float: The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.
maximum_number_of_workers float: The maximum number of workers supported with the App Service Plan’s sku.
name str
per_site_scaling bool: Can Apps assigned to this App Service Plan be scaled independently?
reserved bool: Is this App Service Plan Reserved?
resource_group_name str
sku Dict[GetAppServicePlanSku]: A sku block as documented below.
tags Dict[str, str]: A mapping of tags assigned to the resource.

Supporting Types

GetAppServicePlanSku

See the output API doc for this type.

Capacity int: Specifies the number of workers associated with this App Service Plan.
Size string: Specifies the plan’s instance size.
Tier string: Specifies the plan’s pricing tier.

Capacity int: Specifies the number of workers associated with this App Service Plan.
Size string: Specifies the plan’s instance size.
Tier string: Specifies the plan’s pricing tier.

capacity number: Specifies the number of workers associated with this App Service Plan.
size string: Specifies the plan’s instance size.
tier string: Specifies the plan’s pricing tier.

capacity float: Specifies the number of workers associated with this App Service Plan.
size str: Specifies the plan’s instance size.
tier str: Specifies the plan’s pricing tier.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetAppServicePlan

Example Usage

Using GetAppServicePlan

GetAppServicePlan Result

Supporting Types

GetAppServicePlanSku

Package Details

On This Page