Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getAppServicePlan

App Service plan. API Version: 2020-12-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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:web:getAppServicePlan
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

Name of the App Service plan.

ResourceGroupName string

Name of the resource group to which the resource belongs.

Name string

Name of the App Service plan.

ResourceGroupName string

Name of the resource group to which the resource belongs.

name String

Name of the App Service plan.

resourceGroupName String

Name of the resource group to which the resource belongs.

name string

Name of the App Service plan.

resourceGroupName string

Name of the resource group to which the resource belongs.

name str

Name of the App Service plan.

resource_group_name str

Name of the resource group to which the resource belongs.

name String

Name of the App Service plan.

resourceGroupName String

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.

MaximumNumberOfWorkers int

Maximum number of instances that can be assigned to this App Service plan.

Name string

Resource Name.

NumberOfSites int

Number of apps 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.

FreeOfferExpirationTime string

The time when the server farm free offer expires.

HostingEnvironmentProfile Pulumi.AzureNative.Web.Outputs.HostingEnvironmentProfileResponse

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.Outputs.KubeEnvironmentProfileResponse

Specification for the Kubernetes Environment to use for the App Service plan.

MaximumElasticWorkerCount int

Maximum number of total workers allowed for this ElasticScaleEnabled 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.Outputs.SkuDescriptionResponse

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.

GeoRegion string

Geographical location for the App Service plan.

Id string

Resource Id.

Location string

Resource Location.

MaximumNumberOfWorkers int

Maximum number of instances that can be assigned to this App Service plan.

Name string

Resource Name.

NumberOfSites int

Number of apps 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.

FreeOfferExpirationTime string

The time when the server farm free offer expires.

HostingEnvironmentProfile HostingEnvironmentProfileResponse

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 KubeEnvironmentProfileResponse

Specification for the Kubernetes Environment to use for the App Service plan.

MaximumElasticWorkerCount int

Maximum number of total workers allowed for this ElasticScaleEnabled 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 SkuDescriptionResponse

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.

geoRegion String

Geographical location for the App Service plan.

id String

Resource Id.

location String

Resource Location.

maximumNumberOfWorkers Integer

Maximum number of instances that can be assigned to this App Service plan.

name String

Resource Name.

numberOfSites Integer

Number of apps 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.

freeOfferExpirationTime String

The time when the server farm free offer expires.

hostingEnvironmentProfile HostingEnvironmentProfileResponse

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 KubeEnvironmentProfileResponse

Specification for the Kubernetes Environment to use for the App Service plan.

maximumElasticWorkerCount Integer

Maximum number of total workers allowed for this ElasticScaleEnabled 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 SkuDescriptionResponse

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

Resource tags.

targetWorkerCount Integer

Scaling worker count.

targetWorkerSizeId Integer

Scaling worker size ID.

workerTierName String

Target worker tier assigned to the App Service plan.

geoRegion string

Geographical location for the App Service plan.

id string

Resource Id.

location string

Resource Location.

maximumNumberOfWorkers number

Maximum number of instances that can be assigned to this App Service plan.

name string

Resource Name.

numberOfSites number

Number of apps 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.

freeOfferExpirationTime string

The time when the server farm free offer expires.

hostingEnvironmentProfile HostingEnvironmentProfileResponse

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 KubeEnvironmentProfileResponse

Specification for the Kubernetes Environment to use for the App Service plan.

maximumElasticWorkerCount number

Maximum number of total workers allowed for this ElasticScaleEnabled 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 SkuDescriptionResponse

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.

geo_region str

Geographical location for the App Service plan.

id str

Resource Id.

location str

Resource Location.

maximum_number_of_workers int

Maximum number of instances that can be assigned to this App Service plan.

name str

Resource Name.

number_of_sites int

Number of apps 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.

free_offer_expiration_time str

The time when the server farm free offer expires.

hosting_environment_profile HostingEnvironmentProfileResponse

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 KubeEnvironmentProfileResponse

Specification for the Kubernetes Environment to use for the App Service plan.

maximum_elastic_worker_count int

Maximum number of total workers allowed for this ElasticScaleEnabled 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 SkuDescriptionResponse

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.

geoRegion String

Geographical location for the App Service plan.

id String

Resource Id.

location String

Resource Location.

maximumNumberOfWorkers Number

Maximum number of instances that can be assigned to this App Service plan.

name String

Resource Name.

numberOfSites Number

Number of apps 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.

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.

maximumElasticWorkerCount Number

Maximum number of total workers allowed for this ElasticScaleEnabled 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

Resource tags.

targetWorkerCount Number

Scaling worker count.

targetWorkerSizeId Number

Scaling worker size ID.

workerTierName String

Target worker tier assigned to the App Service plan.

Supporting Types

CapabilityResponse

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.

HostingEnvironmentProfileResponse

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.

KubeEnvironmentProfileResponse

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.

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.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 ListResponse>

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

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

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

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
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0