App Service Plans - List

Dienst:

App Service

API-Version:

2024-11-01

Beschreibung für alle App Service-Pläne für ein Abonnement abrufen.

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

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms?detailed={detailed}&api-version=2024-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-Version
detailed	query		boolean	Geben Sie true an, um alle App Service-Planeigenschaften zurückzugeben. Der Standardwert ist false, der eine Teilmenge der Eigenschaften zurückgibt. Das Abrufen aller Eigenschaften kann die API-Latenz erhöhen.

Antworten

Name	Typ	Beschreibung
200 OK	AppServicePlanCollection	OKAY
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List App Service plans

Beispielanforderung

HTTP

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

Java

/**
 * Samples for AppServicePlans List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListAppServicePlans.json
     */
    /**
     * Sample code: List App Service plans.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAppServicePlans(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServicePlans().list(null, 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_app_service_plans.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.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListAppServicePlans.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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListAppServicePlans.json
func ExamplePlansClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewPlansClient().NewListPager(&armappservice.PlansClientListOptions{Detailed: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.PlanCollection = armappservice.PlanCollection{
		// 	Value: []*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"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testsf7252"),
		// 			Type: to.Ptr("Microsoft.Web/serverfarms"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf7252"),
		// 			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

JavaScript

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

/**
 * This sample demonstrates how to Description for Get all App Service plans for a subscription.
 *
 * @summary Description for Get all App Service plans for a subscription.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListAppServicePlans.json
 */
async function listAppServicePlans() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.appServicePlans.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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-11-01/examples/ListAppServicePlans.json
// this example is just showing the usage of "AppServicePlans_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (AppServicePlanResource item in subscriptionResource.GetAppServicePlansAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "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
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf7252",
      "name": "testsf7252",
      "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
      }
    }
  ]
}

Definitionen

Name	Beschreibung
AppServicePlan	App Service-Plan.
AppServicePlanCollection	Sammlung von App Service-Plänen.
Capability	Beschreibt die für eine bestimmte SKU zulässigen Funktionen/Features.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details
Error	Fehlermodell.
ExtendedLocation	Erweiterter Speicherort.
HostingEnvironmentProfile	Spezifikation für eine App Service-Umgebung, die für diese Ressource verwendet werden soll.
KubeEnvironmentProfile	Spezifikation für eine Kubernetes-Umgebung, die für diese Ressource verwendet werden soll.
ProvisioningState	Bereitstellungsstatus des App-Serviceplans.
SkuCapacity	Beschreibung der Skalierungsoptionen für den App Service-Plan.
SkuDescription	Beschreibung einer SKU für eine skalierbare Ressource.
StatusOptions	App Service-Planstatus.

AppServicePlan

Objekt

App Service-Plan.

Name	Typ	Standardwert	Beschreibung
extendedLocation	ExtendedLocation		Erweiterter Speicherort.
id	string		Ressourcen-ID.
kind	string		Art der Ressource. Wenn es sich bei der Ressource um eine App handelt, können Sie auf https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference für details unterstützte Werte für die Art verweisen.
location	string		Ressourcenspeicherort.
name	string		Ressourcenname.
properties.asyncScalingEnabled	boolean		Wenn true, versucht dieser App Service-Plan, asynchron zu skalieren, wenn nicht genügend Worker für die synchrone Skalierung vorhanden sind. Wenn false, versucht dieser App Service-Plan nur die Synchronisierungskalierung.
properties.elasticScaleEnabled	boolean		ServerFarm unterstützt ElasticScale. Apps in diesem Plan werden skaliert, als wäre die ServerFarm elasticPremium sku.
properties.freeOfferExpirationTime	string (date-time)		Der Zeitpunkt, zu dem das kostenlose Angebot der Serverfarm abläuft.
properties.geoRegion	string		Geografischer Standort für den App Service-Plan.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Spezifikation für die App-Dienstumgebung, die für den App Service-Plan verwendet werden soll.
properties.hyperV	boolean	False	Wenn Hyper-V Container-App-Serviceplan true, false andernfalls.
properties.isSpot	boolean		Wenn true, besitzt dieser App-Serviceplan Spotinstanzen.
properties.isXenon	boolean	False	Veraltet: Wenn Hyper-V Container-App-Serviceplan true, false andernfalls.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Spezifikation für die Kubernetes-Umgebung, die für den App Service-Plan verwendet werden soll.
properties.maximumElasticWorkerCount	integer (int32)		Maximale Anzahl der zulässigen Mitarbeiter für diesen ElasticScaleEnabled App Service Plan
properties.maximumNumberOfWorkers	integer (int32)		Maximale Anzahl von Instanzen, die diesem App Service-Plan zugewiesen werden können.
properties.numberOfSites	integer (int32)		Die Anzahl der Apps, die diesem App Service-Plan zugewiesen wurden.
properties.numberOfWorkers	integer (int32)		Die Anzahl der Instanzen, die diesem App Service-Plan zugewiesen sind.
properties.perSiteScaling	boolean	False	Wenn true, können apps, die diesem App Service-Plan zugewiesen sind, unabhängig voneinander skaliert werden. Wenn false, werden apps, die diesem App Service-Plan zugewiesen sind, auf alle Instanzen des Plans skaliert.
properties.provisioningState	ProvisioningState		Bereitstellungsstatus des App-Serviceplans.
properties.reserved	boolean	False	Wenn der Linux-App-Dienstplan true, false andernfalls.
properties.resourceGroup	string		Ressourcengruppe des App Service-Plans.
properties.spotExpirationTime	string (date-time)		Der Zeitpunkt, zu dem die Serverfarm abläuft. Nur gültig, wenn es sich um eine Spotserverfarm handelt.
properties.status	StatusOptions		App Service-Planstatus.
properties.subscription	string		App Service-Planabonnement.
properties.targetWorkerCount	integer (int32)		Skalierung der Arbeitskraftanzahl.
properties.targetWorkerSizeId	integer (int32)		Skalierungs-Arbeitsgrößen-ID.
properties.workerTierName	string		Zielarbeitsstufe, die dem App Service-Plan zugewiesen ist.
properties.zoneRedundant	boolean	False	Wenn true, führt dieser App-Serviceplan den Zonenausgleich für die Verfügbarkeit durch. Wenn false, führt dieser App-Serviceplan keinen Verfügbarkeitszonenausgleich durch.
sku	SkuDescription		Beschreibung einer SKU für eine skalierbare Ressource.
tags	object		Ressourcentags.
type	string		Ressourcentyp.

AppServicePlanCollection

Objekt

Sammlung von App Service-Plänen.

Name	Typ	Beschreibung
nextLink	string	Link zur nächsten Seite von Ressourcen.
value	AppServicePlan[]	Sammlung von Ressourcen.

Capability

Objekt

Beschreibt die für eine bestimmte SKU zulässigen Funktionen/Features.

Name	Typ	Beschreibung
name	string	Name der SKU-Funktion.
reason	string	Grund der SKU-Funktion.
value	string	Wert der SKU-Funktion.

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

ExtendedLocation

Objekt

Erweiterter Speicherort.

Name	Typ	Beschreibung
name	string	Name des erweiterten Speicherorts.
type	string	Typ des erweiterten Speicherorts.

HostingEnvironmentProfile

Objekt

Spezifikation für eine App Service-Umgebung, die für diese Ressource verwendet werden soll.

Name	Typ	Beschreibung
id	string	Ressourcen-ID der App-Dienstumgebung.
name	string	Name der App-Dienstumgebung.
type	string	Ressourcentyp der App-Dienstumgebung.

KubeEnvironmentProfile

Objekt

Spezifikation für eine Kubernetes-Umgebung, die für diese Ressource verwendet werden soll.

Name	Typ	Beschreibung
id	string	Ressourcen-ID der Kubernetes-Umgebung.
name	string	Name der Kubernetes-Umgebung.
type	string	Ressourcentyp der Kubernetes-Umgebung.

ProvisioningState

Enumeration

Bereitstellungsstatus des App-Serviceplans.

Wert	Beschreibung
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Objekt

Beschreibung der Skalierungsoptionen für den App Service-Plan.

Name	Typ	Beschreibung
default	integer (int32)	Standardanzahl der Mitarbeiter für diese App Service-Plan-SKU.
elasticMaximum	integer (int32)	Maximale Anzahl von elastic Workern für diese App Service-Plan-SKU.
maximum	integer (int32)	Maximale Anzahl von Mitarbeitern für diese App Service-Plan-SKU.
minimum	integer (int32)	Mindestanzahl der Mitarbeiter für diese App Service-Plan-SKU.
scaleType	string	Verfügbare Skalierungskonfigurationen für einen App Service-Plan.

SkuDescription

Objekt

Beschreibung einer SKU für eine skalierbare Ressource.

Name	Typ	Beschreibung
capabilities	Capability[]	Funktionen der SKU, z. B. ist der Datenverkehrs-Manager aktiviert?
capacity	integer (int32)	Aktuelle Anzahl der Instanzen, die der Ressource zugewiesen sind.
family	string	Familiencode der Ressourcen-SKU.
locations	string[]	Speicherorte der SKU.
name	string	Name der Ressourcen-SKU.
size	string	Größenbezeichner der Ressourcen-SKU.
skuCapacity	SkuCapacity	Min-, Max- und Standardwerte der SKU.
tier	string	Dienstebene der Ressourcen-SKU.

StatusOptions

Enumeration

App Service-Planstatus.

Wert	Beschreibung
Creating
Pending
Ready