App Service Plans - List

Usługa:

App Service

Wersja interfejsu API:

2024-04-01

Opis opcji Pobierz wszystkie plany usługi App Service dla subskrypcji.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
api-version	query	True	string	Wersja interfejsu API
detailed	query		boolean	Określ true, aby zwrócić wszystkie właściwości planu usługi App Service. Wartość domyślna to false, która zwraca podzbiór właściwości. Pobieranie wszystkich właściwości może zwiększyć opóźnienie interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AppServicePlanCollection	OK
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List App Service plans

Przykładowe żądanie

HTTP

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

Java

/**
 * Samples for AppServicePlans List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-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-04-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/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/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-04-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-04-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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
AppServicePlan	Plan usługi App Service.
AppServicePlanCollection	Kolekcja planów usługi App Service.
Capability	Opisuje możliwości/funkcje dozwolone dla określonej jednostki SKU.
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
ExtendedLocation	Lokalizacja rozszerzona.
HostingEnvironmentProfile	Specyfikacja środowiska App Service Environment do użycia dla tego zasobu.
KubeEnvironmentProfile	Specyfikacja środowiska Kubernetes do użycia dla tego zasobu.
ProvisioningState	Stan aprowizacji planu usługi App Service.
SkuCapacity	Opis opcji skalowania planu usługi App Service.
SkuDescription	Opis jednostki SKU dla skalowalnego zasobu.
StatusOptions	Stan planu usługi App Service.

AppServicePlan

Objekt

Plan usługi App Service.

Nazwa	Typ	Domyślna wartość	Opis
extendedLocation	ExtendedLocation		Lokalizacja rozszerzona.
id	string		Identyfikator zasobu.
kind	string		Rodzaj zasobu. Jeśli zasób jest aplikacją, możesz zapoznać się z https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference, aby uzyskać szczegółowe informacje o obsługiwanych wartościach dla rodzaju.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.elasticScaleEnabled	boolean		ServerFarm obsługuje warstwę ElasticScale. Aplikacje w tym planie będą skalowane tak, jakby serwerFarm był jednostka SKU ElasticPremium
properties.freeOfferExpirationTime	string (date-time)		Czas wygaśnięcia bezpłatnej oferty farmy serwerów.
properties.geoRegion	string		Lokalizacja geograficzna planu usługi App Service.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Specyfikacja środowiska App Service Environment do użycia dla planu usługi App Service.
properties.hyperV	boolean	False	Jeśli Hyper-V trueplanu usługi App Service kontenera, false w przeciwnym razie.
properties.isSpot	boolean		Jeśli true, ten plan usługi App Service jest właścicielem wystąpień typu spot.
properties.isXenon	boolean	False	Przestarzałe: jeśli Hyper-V plan usługi App Service kontenera true, false w przeciwnym razie.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Specyfikacja środowiska Kubernetes do użycia dla planu usługi App Service.
properties.maximumElasticWorkerCount	integer (int32)		Maksymalna liczba całkowitych procesów roboczych dozwolonych dla tego planu usługi App Service ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer (int32)		Maksymalna liczba wystąpień, które można przypisać do tego planu usługi App Service.
properties.numberOfSites	integer (int32)		Liczba aplikacji przypisanych do tego planu usługi App Service.
properties.numberOfWorkers	integer (int32)		Liczba wystąpień przypisanych do tego planu usługi App Service.
properties.perSiteScaling	boolean	False	Jeśli true, aplikacje przypisane do tego planu usługi App Service można skalować niezależnie. Jeśli false, aplikacje przypisane do tego planu usługi App Service będą skalowane do wszystkich wystąpień planu.
properties.provisioningState	ProvisioningState		Stan aprowizacji planu usługi App Service.
properties.reserved	boolean	False	Jeśli plan usługi app service systemu Linux true, false w przeciwnym razie.
properties.resourceGroup	string		Grupa zasobów planu usługi App Service.
properties.spotExpirationTime	string (date-time)		Czas wygaśnięcia farmy serwerów. Prawidłowe tylko wtedy, gdy jest to farma serwerów typu spot.
properties.status	StatusOptions		Stan planu usługi App Service.
properties.subscription	string		Subskrypcja planu usługi App Service.
properties.targetWorkerCount	integer (int32)		Liczba procesów roboczych skalowania.
properties.targetWorkerSizeId	integer (int32)		Identyfikator rozmiaru procesu roboczego skalowania.
properties.workerTierName	string		Docelowa warstwa procesu roboczego przypisana do planu usługi App Service.
properties.zoneRedundant	boolean	False	Jeśli true, ten plan usługi App Service przeprowadzi równoważenie strefy dostępności. Jeśli false, ten plan usługi App Service nie będzie wykonywać równoważenia strefy dostępności.
sku	SkuDescription		Opis jednostki SKU dla skalowalnego zasobu.
tags	object		Tagi zasobów.
type	string		Typ zasobu.

AppServicePlanCollection

Objekt

Kolekcja planów usługi App Service.

Nazwa	Typ	Opis
nextLink	string	Łącze do następnej strony zasobów.
value	AppServicePlan[]	Kolekcja zasobów.

Capability

Objekt

Opisuje możliwości/funkcje dozwolone dla określonej jednostki SKU.

Nazwa	Typ	Opis
name	string	Nazwa możliwości jednostki SKU.
reason	string	Przyczyna możliwości jednostki SKU.
value	string	Wartość możliwości jednostki SKU.

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

ExtendedLocation

Objekt

Lokalizacja rozszerzona.

Nazwa	Typ	Opis
name	string	Nazwa lokalizacji rozszerzonej.
type	string	Typ lokalizacji rozszerzonej.

HostingEnvironmentProfile

Objekt

Specyfikacja środowiska App Service Environment do użycia dla tego zasobu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu środowiska App Service Environment.
name	string	Nazwa środowiska App Service Environment.
type	string	Typ zasobu środowiska App Service Environment.

KubeEnvironmentProfile

Objekt

Specyfikacja środowiska Kubernetes do użycia dla tego zasobu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu środowiska Kubernetes.
name	string	Nazwa środowiska Kubernetes.
type	string	Typ zasobu środowiska Kubernetes.

ProvisioningState

Wyliczanie

Stan aprowizacji planu usługi App Service.

Wartość	Opis
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Objekt

Opis opcji skalowania planu usługi App Service.

Nazwa	Typ	Opis
default	integer (int32)	Domyślna liczba procesów roboczych dla tej jednostki SKU planu usługi App Service.
elasticMaximum	integer (int32)	Maksymalna liczba elastycznych procesów roboczych dla tej jednostki SKU planu usługi App Service.
maximum	integer (int32)	Maksymalna liczba procesów roboczych dla tej jednostki SKU planu usługi App Service.
minimum	integer (int32)	Minimalna liczba procesów roboczych dla tej jednostki SKU planu usługi App Service.
scaleType	string	Dostępne konfiguracje skalowania dla planu usługi App Service.

SkuDescription

Objekt

Opis jednostki SKU dla skalowalnego zasobu.

Nazwa	Typ	Opis
capabilities	Capability[]	Możliwości jednostki SKU, np. czy usługa Traffic Manager jest włączona?
capacity	integer (int32)	Bieżąca liczba wystąpień przypisanych do zasobu.
family	string	Kod rodziny jednostki SKU zasobu.
locations	string[]	Lokalizacje jednostki SKU.
name	string	Nazwa jednostki SKU zasobu.
size	string	Specyfikator rozmiaru jednostki SKU zasobu.
skuCapacity	SkuCapacity	Minimalne, maksymalne i domyślne wartości skalowania jednostki SKU.
tier	string	Warstwa usługi jednostki SKU zasobu.

StatusOptions

Wyliczanie

Stan planu usługi App Service.

Wartość	Opis
Creating
Pending
Ready