App Service Plans - Get

Service:: App Service

API Version:: 2025-03-01

Description for Get an App Service plan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}?api-version=2025-03-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the App Service plan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Name of the resource group to which the resource belongs.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	AppServicePlan	OK.
404 Not Found		Not found.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get App Service plan

Sample request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141?api-version=2025-03-01

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_app_service_plan.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_plans.get(
        resource_group_name="testrg123",
        name="testsf6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetAppServicePlan.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetAppServicePlan.json
func ExamplePlansClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPlansClient().Get(ctx, "testrg123", "testsf6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Plan = armappservice.Plan{
	// 	Name: to.Ptr("testsf6141"),
	// 	Type: to.Ptr("Microsoft.Web/serverfarms"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141"),
	// 	Kind: to.Ptr("app"),
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armappservice.PlanProperties{
	// 		GeoRegion: to.Ptr("East US"),
	// 		IsSpot: to.Ptr(false),
	// 		MaximumNumberOfWorkers: to.Ptr[int32](20),
	// 		NumberOfSites: to.Ptr[int32](4),
	// 		NumberOfWorkers: to.Ptr[int32](19),
	// 		ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
	// 		Reserved: to.Ptr(false),
	// 		Status: to.Ptr(armappservice.StatusOptionsReady),
	// 		TargetWorkerCount: to.Ptr[int32](0),
	// 		TargetWorkerSizeID: to.Ptr[int32](0),
	// 	},
	// 	SKU: &armappservice.SKUDescription{
	// 		Name: to.Ptr("P1"),
	// 		Capacity: to.Ptr[int32](1),
	// 		Family: to.Ptr("P"),
	// 		Size: to.Ptr("P1"),
	// 		Tier: to.Ptr("Premium"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Get an App Service plan.
 *
 * @summary Description for Get an App Service plan.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetAppServicePlan.json
 */
async function getAppServicePlan() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testsf6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServicePlans.get(resourceGroupName, name);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
  "name": "testsf6141",
  "type": "Microsoft.Web/serverfarms",
  "kind": "app",
  "location": "East US",
  "properties": {
    "status": "Ready",
    "maximumNumberOfWorkers": 20,
    "numberOfWorkers": 19,
    "geoRegion": "East US",
    "numberOfSites": 4,
    "isSpot": false,
    "reserved": false,
    "targetWorkerCount": 0,
    "targetWorkerSizeId": 0,
    "provisioningState": "Succeeded"
  },
  "sku": {
    "name": "P1",
    "tier": "Premium",
    "size": "P1",
    "family": "P",
    "capacity": 1
  }
}

Status code:: 404

Definitions

Name	Description
AppServicePlan	App Service plan.
Capability	Describes the capabilities/features allowed for a specific SKU.
DefaultErrorResponse	App Service error response.
DefaultIdentity
Details
Error	Error model.
ExtendedLocation	Extended Location.
HostingEnvironmentProfile	Specification for an App Service Environment to use for this resource.
InstallScript	Server farm install script configuration.
InstallScriptSource	Object to hold install script reference.
InstallScriptType	Type of the install script.
KeyVaultReferenceWithStatus	Object to hold key vault reference and the resolution status
KubeEnvironmentProfile	Specification for a Kubernetes Environment to use for this resource.
ManagedServiceIdentity	Managed service identity.
ManagedServiceIdentityType	Type of managed service identity.
ProvisioningState	Provisioning state of the App Service Plan.
RegistryAdapter	Server farm registry adapter configuration.
RegistryAdapterType	Type of the registry adapter.
ServerFarmNetworkSettings	Network settings for an app service plan.
SkuCapacity	Description of the App Service plan scale options.
SkuDescription	Description of a SKU for a scalable resource.
StatusOptions	App Service plan status.
StorageMount	Server farm storage mount configuration.
StorageMountType	Type of the storage mount.
userAssignedIdentity	User Assigned identity.

AppServicePlan

Object

App Service plan.

Name	Type	Default value	Description
extendedLocation	ExtendedLocation		Extended Location.
id	string		Resource Id.
identity	ManagedServiceIdentity		Managed service identity.
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.
location	string		Resource Location.
name	string		Resource Name.
properties.asyncScalingEnabled	boolean		If `true`, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If `false`, this App Service Plan will only attempt sync scaling.
properties.elasticScaleEnabled	boolean		ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
properties.freeOfferExpirationTime	string (date-time)		The time when the server farm free offer expires.
properties.geoRegion	string		Geographical location for the App Service plan.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Specification for the App Service Environment to use for the App Service plan.
properties.hyperV	boolean	False	If Hyper-V container app service plan `true`, `false` otherwise.
properties.installScripts	InstallScript[]		Install scripts associated with this App Service plan.
properties.isCustomMode	boolean		Whether this server farm is in custom mode.
properties.isSpot	boolean		If `true`, this App Service Plan owns spot instances.
properties.isXenon	boolean	False	Obsolete: If Hyper-V container app service plan `true`, `false` otherwise.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Specification for the Kubernetes Environment to use for the App Service plan.
properties.maximumElasticWorkerCount	integer (int32)		Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
properties.maximumNumberOfWorkers	integer (int32)		Maximum number of instances that can be assigned to this App Service plan.
properties.network	ServerFarmNetworkSettings		All network settings for the server farm.
properties.numberOfSites	integer (int32)		Number of apps assigned to this App Service plan.
properties.numberOfWorkers	integer (int32)		The number of instances that are assigned to this App Service plan.
properties.perSiteScaling	boolean	False	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.
properties.planDefaultIdentity	DefaultIdentity		Identity to use by platform for various features and integrations using managed identity.
properties.provisioningState	ProvisioningState		Provisioning state of the App Service Plan.
properties.rdpEnabled	boolean		If `true`, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If `false`, RDP access is disabled.
properties.registryAdapters	RegistryAdapter[]		Registry adapters associated with this App Service plan.
properties.reserved	boolean	False	If Linux app service plan `true`, `false` otherwise.
properties.resourceGroup	string		Resource group of the App Service plan.
properties.spotExpirationTime	string (date-time)		The time when the server farm expires. Valid only if it is a spot server farm.
properties.status	StatusOptions		App Service plan status.
properties.storageMounts	StorageMount[]		Storage mounts associated with this App Service plan.
properties.subscription	string		App Service plan subscription.
properties.targetWorkerCount	integer (int32)		Scaling worker count.
properties.targetWorkerSizeId	integer (int32)		Scaling worker size ID.
properties.workerTierName	string		Target worker tier assigned to the App Service plan.
properties.zoneRedundant	boolean	False	If `true`, this App Service Plan will perform availability zone balancing. If `false`, this App Service Plan will not perform availability zone balancing.
sku	SkuDescription		Description of a SKU for a scalable resource.
tags	object		Resource tags.
type	string		Resource type.

Capability

Object

Describes the capabilities/features allowed for a specific SKU.

Name	Type	Description
name	string	Name of the SKU capability.
reason	string	Reason of the SKU capability.
value	string	Value of the SKU capability.

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	Error	Error model.

DefaultIdentity

Object

Name	Type	Description
identityType	ManagedServiceIdentityType
userAssignedIdentityResourceId	string

Details

Object

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

ExtendedLocation

Object

Extended Location.

Name	Type	Description
name	string	Name of extended location.
type	string	Type of extended location.

HostingEnvironmentProfile

Object

Specification for an App Service Environment to use for this resource.

Name	Type	Description
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.

InstallScript

Object

Server farm install script configuration.

Name	Type	Description
name	string	Name of the install script.
source	InstallScriptSource	Source of the install script.

InstallScriptSource

Object

Object to hold install script reference.

Name	Type	Description
sourceUri	string	Install script source URI where the install script file will be fetched from.
type	InstallScriptType	Type of the install script.

InstallScriptType

Enumeration

Type of the install script.

Value	Description
RemoteAzureBlob
PlatformStorage

KeyVaultReferenceWithStatus

Object

Object to hold key vault reference and the resolution status

Name	Type	Description
referenceStatus	string	Reference status of the key vault secret.
secretUri	string	Key vault secret URI.

KubeEnvironmentProfile

Object

Specification for a Kubernetes Environment to use for this resource.

Name	Type	Description
id	string	Resource ID of the Kubernetes Environment.
name	string	Name of the Kubernetes Environment.
type	string	Resource type of the Kubernetes Environment.

ManagedServiceIdentity

Object

Managed service identity.

Name	Type	Description
principalId	string	Principal Id of managed service identity.
tenantId	string	Tenant of managed service identity.
type	ManagedServiceIdentityType	Type of managed service identity.
userAssignedIdentities	<string, userAssignedIdentity>	The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeration

Type of managed service identity.

Value	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ProvisioningState

Enumeration

Provisioning state of the App Service Plan.

Value	Description
Succeeded
Failed
Canceled
InProgress
Deleting

RegistryAdapter

Object

Server farm registry adapter configuration.

Name	Type	Description
keyVaultSecretReference	KeyVaultReferenceWithStatus	Key vault reference to the value that will be placed in the registry location
registryKey	string	Registry key for the adapter.
type	RegistryAdapterType	Type of the registry adapter.

RegistryAdapterType

Enumeration

Type of the registry adapter.

Value	Description
Binary
String
Expand_String
Multi_String
DWord
QWord

ServerFarmNetworkSettings

Object

Network settings for an app service plan.

Name	Type	Description
virtualNetworkSubnetId	string	Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

SkuCapacity

Object

Description of the App Service plan scale options.

Name	Type	Description
default	integer (int32)	Default number of workers for this App Service plan SKU.
elasticMaximum	integer (int32)	Maximum number of Elastic workers for this App Service plan SKU.
maximum	integer (int32)	Maximum number of workers for this App Service plan SKU.
minimum	integer (int32)	Minimum number of workers for this App Service plan SKU.
scaleType	string	Available scale configurations for an App Service plan.

SkuDescription

Object

Description of a SKU for a scalable resource.

Name	Type	Description
capabilities	Capability[]	Capabilities of the SKU, e.g., is traffic manager enabled?
capacity	integer (int32)	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.

StatusOptions

Enumeration

App Service plan status.

Value	Description
Ready
Pending
Creating

StorageMount

Object

Server farm storage mount configuration.

Name	Type	Description
credentialsKeyVaultReference	KeyVaultReferenceWithStatus	KV reference to the credentials to connect to the share.
destinationPath	string	Path on worker where storage will be mounted.
name	string	Name of the storage mount.
source	string	Source of the fileshare/storage.
type	StorageMountType	Type of the storage mount.

StorageMountType

Enumeration

Type of the storage mount.

Value	Description
AzureFiles
LocalStorage
FileShare

userAssignedIdentity

Object

User Assigned identity.

Name	Type	Description
clientId	string	Client Id of user assigned identity
principalId	string	Principal Id of user assigned identity

Share via

App Service Plans - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get App Service plan

Sample request

Sample response

Definitions

AppServicePlan

Capability

DefaultErrorResponse

DefaultIdentity

Details

Error

ExtendedLocation

HostingEnvironmentProfile

InstallScript

InstallScriptSource

InstallScriptType

KeyVaultReferenceWithStatus

KubeEnvironmentProfile

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

RegistryAdapter

RegistryAdapterType

ServerFarmNetworkSettings

SkuCapacity

SkuDescription

StatusOptions

StorageMount

StorageMountType

userAssignedIdentity