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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.web.getAppServicePlan
Explore with Pulumi AI
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Description for Get an App Service plan. Azure REST API version: 2022-09-01.
Other available API versions: 2016-09-01, 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.
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.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- Name string
- Name of the App Service plan.
- ResourceGroup stringName 
- Name of the resource group to which the resource belongs.
- name String
- Name of the App Service plan.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
- name string
- Name of the App Service plan.
- resourceGroup 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.
- resourceGroup StringName 
- Name of the resource group to which the resource belongs.
getAppServicePlan Result
The following output properties are available:
- GeoRegion string
- Geographical location for the App Service plan.
- Id string
- Resource Id.
- Location string
- Resource Location.
- MaximumNumber intOf Workers 
- Maximum number of instances that can be assigned to this App Service plan.
- Name string
- Resource Name.
- NumberOf intSites 
- Number of apps assigned to this App Service plan.
- NumberOf intWorkers 
- 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.
- ElasticScale boolEnabled 
- ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
- ExtendedLocation Pulumi.Azure Native. Web. Outputs. Extended Location Response 
- Extended Location.
- FreeOffer stringExpiration Time 
- The time when the server farm free offer expires.
- HostingEnvironment Pulumi.Profile Azure Native. Web. Outputs. Hosting Environment Profile Response 
- 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.
- KubeEnvironment Pulumi.Profile Azure Native. Web. Outputs. Kube Environment Profile Response 
- Specification for the Kubernetes Environment to use for the App Service plan.
- MaximumElastic intWorker Count 
- Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
- PerSite 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.
- SpotExpiration stringTime 
- The time when the server farm expires. Valid only if it is a spot server farm.
- Dictionary<string, string>
- Resource tags.
- TargetWorker intCount 
- Scaling worker count.
- TargetWorker intSize Id 
- Scaling worker size ID.
- WorkerTier stringName 
- 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.
- GeoRegion string
- Geographical location for the App Service plan.
- Id string
- Resource Id.
- Location string
- Resource Location.
- MaximumNumber intOf Workers 
- Maximum number of instances that can be assigned to this App Service plan.
- Name string
- Resource Name.
- NumberOf intSites 
- Number of apps assigned to this App Service plan.
- NumberOf intWorkers 
- 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.
- ElasticScale boolEnabled 
- ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
- ExtendedLocation ExtendedLocation Response 
- Extended Location.
- FreeOffer stringExpiration Time 
- The time when the server farm free offer expires.
- HostingEnvironment HostingProfile Environment Profile Response 
- 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.
- KubeEnvironment KubeProfile Environment Profile Response 
- Specification for the Kubernetes Environment to use for the App Service plan.
- MaximumElastic intWorker Count 
- Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
- PerSite 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
SkuDescription Response 
- Description of a SKU for a scalable resource.
- SpotExpiration stringTime 
- The time when the server farm expires. Valid only if it is a spot server farm.
- map[string]string
- Resource tags.
- TargetWorker intCount 
- Scaling worker count.
- TargetWorker intSize Id 
- Scaling worker size ID.
- WorkerTier stringName 
- 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.
- geoRegion String
- Geographical location for the App Service plan.
- id String
- Resource Id.
- location String
- Resource Location.
- maximumNumber IntegerOf Workers 
- Maximum number of instances that can be assigned to this App Service plan.
- name String
- Resource Name.
- numberOf IntegerSites 
- Number of apps assigned to this App Service plan.
- numberOf IntegerWorkers 
- 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.
- elasticScale BooleanEnabled 
- ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
- extendedLocation ExtendedLocation Response 
- Extended Location.
- freeOffer StringExpiration Time 
- The time when the server farm free offer expires.
- hostingEnvironment HostingProfile Environment Profile Response 
- 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.
- kubeEnvironment KubeProfile Environment Profile Response 
- Specification for the Kubernetes Environment to use for the App Service plan.
- maximumElastic IntegerWorker Count 
- Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
- perSite 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
SkuDescription Response 
- Description of a SKU for a scalable resource.
- spotExpiration StringTime 
- The time when the server farm expires. Valid only if it is a spot server farm.
- Map<String,String>
- Resource tags.
- targetWorker IntegerCount 
- Scaling worker count.
- targetWorker IntegerSize Id 
- Scaling worker size ID.
- workerTier StringName 
- 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.
- geoRegion string
- Geographical location for the App Service plan.
- id string
- Resource Id.
- location string
- Resource Location.
- maximumNumber numberOf Workers 
- Maximum number of instances that can be assigned to this App Service plan.
- name string
- Resource Name.
- numberOf numberSites 
- Number of apps assigned to this App Service plan.
- numberOf numberWorkers 
- 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.
- elasticScale booleanEnabled 
- ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
- extendedLocation ExtendedLocation Response 
- Extended Location.
- freeOffer stringExpiration Time 
- The time when the server farm free offer expires.
- hostingEnvironment HostingProfile Environment Profile Response 
- 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.
- kubeEnvironment KubeProfile Environment Profile Response 
- Specification for the Kubernetes Environment to use for the App Service plan.
- maximumElastic numberWorker Count 
- Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
- perSite 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
SkuDescription Response 
- Description of a SKU for a scalable resource.
- spotExpiration stringTime 
- The time when the server farm expires. Valid only if it is a spot server farm.
- {[key: string]: string}
- Resource tags.
- targetWorker numberCount 
- Scaling worker count.
- targetWorker numberSize Id 
- Scaling worker size ID.
- workerTier stringName 
- 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.
- 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.
- 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
SkuDescription 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.
- geoRegion String
- Geographical location for the App Service plan.
- id String
- Resource Id.
- location String
- Resource Location.
- maximumNumber NumberOf Workers 
- Maximum number of instances that can be assigned to this App Service plan.
- name String
- Resource Name.
- numberOf NumberSites 
- Number of apps assigned to this App Service plan.
- numberOf NumberWorkers 
- 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.
- elasticScale BooleanEnabled 
- ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
- extendedLocation Property Map
- Extended Location.
- freeOffer StringExpiration Time 
- The time when the server farm free offer expires.
- hostingEnvironment Property MapProfile 
- 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.
- kubeEnvironment Property MapProfile 
- Specification for the Kubernetes Environment to use for the App Service plan.
- maximumElastic NumberWorker Count 
- Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
- perSite 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.
- spotExpiration StringTime 
- The time when the server farm expires. Valid only if it is a spot server farm.
- Map<String>
- Resource tags.
- targetWorker NumberCount 
- Scaling worker count.
- targetWorker NumberSize Id 
- Scaling worker size ID.
- workerTier StringName 
- 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.
Supporting Types
CapabilityResponse 
ExtendedLocationResponse  
HostingEnvironmentProfileResponse   
KubeEnvironmentProfileResponse   
SkuCapacityResponse  
- 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.
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.
- SkuCapacity 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
[]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 SkuCapacity Response 
- 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 SkuCapacity Response 
- 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 SkuCapacity Response 
- 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 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.
- skuCapacity 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
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi