azure-native.web.getAppServicePlan
Explore with Pulumi AI
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. 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 for details.
Using getAppServicePlan
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAppServicePlan(args: GetAppServicePlanArgs, opts?: InvokeOptions): Promise<GetAppServicePlanResult>
function getAppServicePlanOutput(args: GetAppServicePlanOutputArgs, opts?: InvokeOptions): Output<GetAppServicePlanResult>def get_app_service_plan(name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAppServicePlanResult
def get_app_service_plan_output(name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAppServicePlanResult]func LookupAppServicePlan(ctx *Context, args *LookupAppServicePlanArgs, opts ...InvokeOption) (*LookupAppServicePlanResult, error)
func LookupAppServicePlanOutput(ctx *Context, args *LookupAppServicePlanOutputArgs, opts ...InvokeOption) LookupAppServicePlanResultOutput> Note: This function is named LookupAppServicePlan in the Go SDK.
public static class GetAppServicePlan 
{
    public static Task<GetAppServicePlanResult> InvokeAsync(GetAppServicePlanArgs args, InvokeOptions? opts = null)
    public static Output<GetAppServicePlanResult> Invoke(GetAppServicePlanInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAppServicePlanResult> getAppServicePlan(GetAppServicePlanArgs args, InvokeOptions options)
public static Output<GetAppServicePlanResult> getAppServicePlan(GetAppServicePlanArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:web:getAppServicePlan
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
 - Name of the App Service plan.
 - Resource
Group stringName  - Name of the resource group to which the resource belongs.
 
- Name string
 - Name of the App Service plan.
 - Resource
Group stringName  - Name of the resource group to which the resource belongs.
 
- name String
 - Name of the App Service plan.
 - resource
Group StringName  - Name of the resource group to which the resource belongs.
 
- name string
 - Name of the App Service plan.
 - resource
Group stringName  - Name of the resource group to which the resource belongs.
 
- name str
 - Name of the App Service plan.
 - resource_
group_ strname  - Name of the resource group to which the resource belongs.
 
- name String
 - Name of the App Service plan.
 - resource
Group StringName  - Name of the resource group to which the resource belongs.
 
getAppServicePlan Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Geo
Region string - Geographical location for the App Service plan.
 - Id string
 - Resource Id.
 - Location string
 - Resource Location.
 - Maximum
Number intOf Workers  - Maximum number of instances that can be assigned to this App Service plan.
 - Name string
 - Resource Name.
 - Number
Of intSites  - Number of apps assigned to this App Service plan.
 - Number
Of intWorkers  - The number of instances that are assigned to this App Service plan.
 - Provisioning
State string - Provisioning state of the App Service Plan.
 - Resource
Group string - Resource group of the App Service plan.
 - Status string
 - App Service plan status.
 - Subscription string
 - App Service plan subscription.
 - Type string
 - Resource type.
 - Elastic
Scale boolEnabled  - ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
 - Extended
Location Pulumi.Azure Native. Web. Outputs. Extended Location Response  - Extended Location.
 - Free
Offer stringExpiration Time  - The time when the server farm free offer expires.
 - Hosting
Environment Pulumi.Profile Azure Native. Web. Outputs. Hosting Environment Profile Response  - 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 string
 - 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.
 - Kube
Environment Pulumi.Profile Azure Native. Web. Outputs. Kube Environment Profile Response  - Specification for the Kubernetes Environment to use for the App Service plan.
 - Maximum
Elastic intWorker Count  - Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
 - Per
Site boolScaling  - 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.
Azure Native. Web. Outputs. Sku Description Response  - Description of a SKU for a scalable resource.
 - Spot
Expiration stringTime  - The time when the server farm expires. Valid only if it is a spot server farm.
 - Dictionary<string, string>
 - Resource tags.
 - Target
Worker intCount  - Scaling worker count.
 - Target
Worker intSize Id  - Scaling worker size ID.
 - Worker
Tier stringName  - 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.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Geo
Region string - Geographical location for the App Service plan.
 - Id string
 - Resource Id.
 - Location string
 - Resource Location.
 - Maximum
Number intOf Workers  - Maximum number of instances that can be assigned to this App Service plan.
 - Name string
 - Resource Name.
 - Number
Of intSites  - Number of apps assigned to this App Service plan.
 - Number
Of intWorkers  - The number of instances that are assigned to this App Service plan.
 - Provisioning
State string - Provisioning state of the App Service Plan.
 - Resource
Group string - Resource group of the App Service plan.
 - Status string
 - App Service plan status.
 - Subscription string
 - App Service plan subscription.
 - Type string
 - Resource type.
 - Elastic
Scale boolEnabled  - ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
 - Extended
Location ExtendedLocation Response  - Extended Location.
 - Free
Offer stringExpiration Time  - The time when the server farm free offer expires.
 - Hosting
Environment HostingProfile Environment Profile Response  - 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 string
 - 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.
 - Kube
Environment KubeProfile Environment Profile Response  - Specification for the Kubernetes Environment to use for the App Service plan.
 - Maximum
Elastic intWorker Count  - Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
 - Per
Site boolScaling  - 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
Sku
Description Response  - Description of a SKU for a scalable resource.
 - Spot
Expiration stringTime  - The time when the server farm expires. Valid only if it is a spot server farm.
 - map[string]string
 - Resource tags.
 - Target
Worker intCount  - Scaling worker count.
 - Target
Worker intSize Id  - Scaling worker size ID.
 - Worker
Tier stringName  - 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.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - geo
Region String - Geographical location for the App Service plan.
 - id String
 - Resource Id.
 - location String
 - Resource Location.
 - maximum
Number IntegerOf Workers  - Maximum number of instances that can be assigned to this App Service plan.
 - name String
 - Resource Name.
 - number
Of IntegerSites  - Number of apps assigned to this App Service plan.
 - number
Of IntegerWorkers  - The number of instances that are assigned to this App Service plan.
 - provisioning
State String - Provisioning state of the App Service Plan.
 - resource
Group String - Resource group of the App Service plan.
 - status String
 - App Service plan status.
 - subscription String
 - App Service plan subscription.
 - type String
 - Resource type.
 - elastic
Scale BooleanEnabled  - ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
 - extended
Location ExtendedLocation Response  - Extended Location.
 - free
Offer StringExpiration Time  - The time when the server farm free offer expires.
 - hosting
Environment HostingProfile Environment Profile Response  - Specification for the App Service Environment to use for the App Service plan.
 - hyper
V Boolean - If Hyper-V container app service plan true, false otherwise.
 - is
Spot Boolean - If true, this App Service Plan owns spot instances.
 - is
Xenon Boolean - Obsolete: If Hyper-V container app service plan true, false otherwise.
 - kind String
 - 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.
 - kube
Environment KubeProfile Environment Profile Response  - Specification for the Kubernetes Environment to use for the App Service plan.
 - maximum
Elastic IntegerWorker Count  - Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
 - per
Site BooleanScaling  - 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
Sku
Description Response  - Description of a SKU for a scalable resource.
 - spot
Expiration StringTime  - The time when the server farm expires. Valid only if it is a spot server farm.
 - Map<String,String>
 - Resource tags.
 - target
Worker IntegerCount  - Scaling worker count.
 - target
Worker IntegerSize Id  - Scaling worker size ID.
 - worker
Tier StringName  - Target worker tier assigned to the App Service plan.
 - zone
Redundant Boolean - If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - geo
Region string - Geographical location for the App Service plan.
 - id string
 - Resource Id.
 - location string
 - Resource Location.
 - maximum
Number numberOf Workers  - Maximum number of instances that can be assigned to this App Service plan.
 - name string
 - Resource Name.
 - number
Of numberSites  - Number of apps assigned to this App Service plan.
 - number
Of numberWorkers  - The number of instances that are assigned to this App Service plan.
 - provisioning
State string - Provisioning state of the App Service Plan.
 - resource
Group string - Resource group of the App Service plan.
 - status string
 - App Service plan status.
 - subscription string
 - App Service plan subscription.
 - type string
 - Resource type.
 - elastic
Scale booleanEnabled  - ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
 - extended
Location ExtendedLocation Response  - Extended Location.
 - free
Offer stringExpiration Time  - The time when the server farm free offer expires.
 - hosting
Environment HostingProfile Environment Profile Response  - Specification for the App Service Environment to use for the App Service plan.
 - hyper
V boolean - If Hyper-V container app service plan true, false otherwise.
 - is
Spot boolean - If true, this App Service Plan owns spot instances.
 - is
Xenon boolean - Obsolete: If Hyper-V container app service plan true, false otherwise.
 - kind string
 - 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.
 - kube
Environment KubeProfile Environment Profile Response  - Specification for the Kubernetes Environment to use for the App Service plan.
 - maximum
Elastic numberWorker Count  - Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
 - per
Site booleanScaling  - 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
Sku
Description Response  - Description of a SKU for a scalable resource.
 - spot
Expiration stringTime  - The time when the server farm expires. Valid only if it is a spot server farm.
 - {[key: string]: string}
 - Resource tags.
 - target
Worker numberCount  - Scaling worker count.
 - target
Worker numberSize Id  - Scaling worker size ID.
 - worker
Tier stringName  - Target worker tier assigned to the App Service plan.
 - zone
Redundant boolean - If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - geo_
region str - Geographical location for the App Service plan.
 - id str
 - Resource Id.
 - location str
 - Resource Location.
 - maximum_
number_ intof_ workers  - Maximum number of instances that can be assigned to this App Service plan.
 - name str
 - Resource Name.
 - number_
of_ intsites  - Number of apps assigned to this App Service plan.
 - number_
of_ intworkers  - 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.
 - elastic_
scale_ boolenabled  - ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
 - extended_
location ExtendedLocation Response  - Extended Location.
 - free_
offer_ strexpiration_ time  - The time when the server farm free offer expires.
 - hosting_
environment_ Hostingprofile Environment Profile Response  - 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. 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.
 - kube_
environment_ Kubeprofile Environment Profile Response  - Specification for the Kubernetes Environment to use for the App Service plan.
 - maximum_
elastic_ intworker_ count  - Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
 - per_
site_ boolscaling  - 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
Sku
Description Response  - Description of a SKU for a scalable resource.
 - spot_
expiration_ strtime  - The time when the server farm expires. Valid only if it is a spot server farm.
 - Mapping[str, str]
 - Resource tags.
 - target_
worker_ intcount  - Scaling worker count.
 - target_
worker_ intsize_ id  - Scaling worker size ID.
 - worker_
tier_ strname  - 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.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - geo
Region String - Geographical location for the App Service plan.
 - id String
 - Resource Id.
 - location String
 - Resource Location.
 - maximum
Number NumberOf Workers  - Maximum number of instances that can be assigned to this App Service plan.
 - name String
 - Resource Name.
 - number
Of NumberSites  - Number of apps assigned to this App Service plan.
 - number
Of NumberWorkers  - The number of instances that are assigned to this App Service plan.
 - provisioning
State String - Provisioning state of the App Service Plan.
 - resource
Group String - Resource group of the App Service plan.
 - status String
 - App Service plan status.
 - subscription String
 - App Service plan subscription.
 - type String
 - Resource type.
 - elastic
Scale BooleanEnabled  - ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
 - extended
Location Property Map - Extended Location.
 - free
Offer StringExpiration Time  - The time when the server farm free offer expires.
 - hosting
Environment Property MapProfile  - Specification for the App Service Environment to use for the App Service plan.
 - hyper
V Boolean - If Hyper-V container app service plan true, false otherwise.
 - is
Spot Boolean - If true, this App Service Plan owns spot instances.
 - is
Xenon Boolean - Obsolete: If Hyper-V container app service plan true, false otherwise.
 - kind String
 - 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.
 - kube
Environment Property MapProfile  - Specification for the Kubernetes Environment to use for the App Service plan.
 - maximum
Elastic NumberWorker Count  - Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
 - per
Site BooleanScaling  - 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.
 - spot
Expiration StringTime  - The time when the server farm expires. Valid only if it is a spot server farm.
 - Map<String>
 - Resource tags.
 - target
Worker NumberCount  - Scaling worker count.
 - target
Worker NumberSize Id  - Scaling worker size ID.
 - worker
Tier StringName  - Target worker tier assigned to the App Service plan.
 - zone
Redundant Boolean - If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.
 
Supporting Types
CapabilityResponse 
ExtendedLocationResponse  
HostingEnvironmentProfileResponse   
KubeEnvironmentProfileResponse   
SkuCapacityResponse  
- 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 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 string - Available scale configurations for an App Service plan.
 
- default_ Integer
 - Default number of workers for this App Service plan SKU.
 - elastic
Maximum 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.
 - scale
Type String - Available scale configurations for an App Service plan.
 
- default number
 - Default number of workers for this App Service plan SKU.
 - elastic
Maximum 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.
 - scale
Type 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.
 - elastic
Maximum 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.
 - scale
Type String - Available scale configurations for an App Service plan.
 
SkuDescriptionResponse  
- Capabilities
List<Pulumi.
Azure Native. Web. Inputs. Capability Response>  - 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.
 - Sku
Capacity Pulumi.Azure Native. Web. Inputs. Sku Capacity Response  - Min, max, and default scale values of the SKU.
 - Tier string
 - Service tier of the resource SKU.
 
- Capabilities
[]Capability
Response  - 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.
 - Sku
Capacity SkuCapacity Response  - Min, max, and default scale values of the SKU.
 - Tier string
 - Service tier of the resource SKU.
 
- capabilities
List<Capability
Response>  - 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.
 - sku
Capacity SkuCapacity Response  - Min, max, and default scale values of the SKU.
 - tier String
 - Service tier of the resource SKU.
 
- capabilities
Capability
Response[]  - 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.
 - sku
Capacity SkuCapacity Response  - Min, max, and default scale values of the SKU.
 - tier string
 - Service tier of the resource SKU.
 
- capabilities
Sequence[Capability
Response]  - 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 Response  - 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.
 - sku
Capacity Property Map - Min, max, and default scale values of the SKU.
 - tier String
 - Service tier of the resource SKU.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0