App Service Plans - Get

Service:

App Service

API Version:

2024-04-01

Description for Get an App Service plan.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the App Service plan.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
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

HTTP

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

Java

/**
 * Samples for AppServicePlans GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAppServicePlan.json
     */
    /**
     * Sample code: Get App Service plan.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAppServicePlan(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServicePlans().getByResourceGroupWithResponse("testrg123",
            "testsf6141", com.azure.core.util.Context.NONE);
    }
}

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

Go

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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAppServicePlan.json
// this example is just showing the usage of "AppServicePlans_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AppServicePlanResource created on azure
// for more information of creating AppServicePlanResource, please refer to the document of AppServicePlanResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "testsf6141";
ResourceIdentifier appServicePlanResourceId = AppServicePlanResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
AppServicePlanResource appServicePlan = client.GetAppServicePlanResource(appServicePlanResourceId);

// invoke the operation
AppServicePlanResource result = await appServicePlan.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppServicePlanData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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.
Details
Error	Error model.
ExtendedLocation	Extended Location.
HostingEnvironmentProfile	Specification for an App Service Environment to use for this resource.
KubeEnvironmentProfile	Specification for a Kubernetes Environment to use for this resource.
ProvisioningState	Provisioning state of the 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.

AppServicePlan

App Service plan.

Name	Type	Default value	Description
extendedLocation	ExtendedLocation		Extended Location.
id	string		Resource Id.
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.elasticScaleEnabled	boolean		ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku
properties.freeOfferExpirationTime	string		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.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		Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan
properties.maximumNumberOfWorkers	integer		Maximum number of instances that can be assigned to this App Service plan.
properties.numberOfSites	integer		Number of apps assigned to this App Service plan.
properties.numberOfWorkers	integer		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.provisioningState	ProvisioningState		Provisioning state of the 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		The time when the server farm expires. Valid only if it is a spot server farm.
properties.status	StatusOptions		App Service plan status.
properties.subscription	string		App Service plan subscription.
properties.targetWorkerCount	integer		Scaling worker count.
properties.targetWorkerSizeId	integer		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

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

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

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

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

Extended Location.

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

HostingEnvironmentProfile

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.

KubeEnvironmentProfile

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.

ProvisioningState

Provisioning state of the App Service Plan.

Name	Type	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

SkuCapacity

Description of the App Service plan scale options.

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

SkuDescription

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

App Service plan status.

Name	Type	Description
Creating	string
Pending	string
Ready	string