App Service Plans - Get

Riferimento

Servizio:: App Service

Versione API:: 2024-04-01

Descrizione per Ottenere un piano di servizio app.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome del piano di servizio app.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome del gruppo di risorse a cui appartiene la risorsa.
subscriptionId	path	True	string	ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versione API

Risposte

Nome	Tipo	Descrizione
200 OK	AppServicePlan	OK.
404 Not Found		Non trovato.
Other Status Codes	DefaultErrorResponse	Risposta di errore del servizio app.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get App Service plan

Esempio di richiesta

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


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

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/stable/2024-04-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/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

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/stable/2024-04-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

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

Risposta di esempio

Codice di stato:: 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
  }
}

Codice di stato:: 404

Definizioni

Nome	Descrizione
AppServicePlan	Piano di servizio app.
Capability	Descrive le funzionalità o le funzionalità consentite per uno SKU specifico.
DefaultErrorResponse	Risposta di errore del servizio app.
Details
Error	Modello di errore.
ExtendedLocation	Posizione estesa.
HostingEnvironmentProfile	Specifica per un ambiente del servizio app da usare per questa risorsa.
KubeEnvironmentProfile	Specifica per un ambiente Kubernetes da usare per questa risorsa.
ProvisioningState	Stato di provisioning del piano di servizio app.
SkuCapacity	Descrizione delle opzioni di scalabilità del piano di servizio app.
SkuDescription	Descrizione di uno SKU per una risorsa scalabile.
StatusOptions	Stato del piano di servizio app.

AppServicePlan

Object

Piano di servizio app.

Nome	Tipo	Valore predefinito	Descrizione
extendedLocation	ExtendedLocation		Posizione estesa.
id	string		ID risorsa.
kind	string		Tipo di risorsa. Se la risorsa è un'app, è possibile fare riferimento a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference per informazioni dettagliate sui valori supportati per il tipo.
location	string		Percorso risorsa.
name	string		Nome risorsa.
properties.elasticScaleEnabled	boolean		ServerFarm supporta ElasticScale. Le app in questo piano verranno ridimensionate come se lo SKU ServerFarm fosse ElasticPremium
properties.freeOfferExpirationTime	string (date-time)		Ora di scadenza dell'offerta gratuita della server farm.
properties.geoRegion	string		Posizione geografica per il piano di servizio app.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Specifica per l'ambiente del servizio app da usare per il piano di servizio app.
properties.hyperV	boolean	False	Se Hyper-V piano di servizio app contenitore `true`, `false` in caso contrario.
properties.isSpot	boolean		Se `true`, questo piano di servizio app è proprietario di istanze spot.
properties.isXenon	boolean	False	Obsoleto: se Hyper-V piano di servizio app contenitore `true`, `false` in caso contrario.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Specifica per l'ambiente Kubernetes da usare per il piano di servizio app.
properties.maximumElasticWorkerCount	integer (int32)		Numero massimo di ruoli di lavoro totali consentiti per questo piano di servizio app ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer (int32)		Numero massimo di istanze che possono essere assegnate a questo piano di servizio app.
properties.numberOfSites	integer (int32)		Numero di app assegnate al piano di servizio app.
properties.numberOfWorkers	integer (int32)		Numero di istanze assegnate a questo piano di servizio app.
properties.perSiteScaling	boolean	False	Se `true`, le app assegnate a questo piano di servizio app possono essere ridimensionate in modo indipendente. Se `false`, le app assegnate a questo piano di servizio app verranno ridimensionate in tutte le istanze del piano.
properties.provisioningState	ProvisioningState		Stato di provisioning del piano di servizio app.
properties.reserved	boolean	False	Se il piano di servizio app Linux `true`, `false` in caso contrario.
properties.resourceGroup	string		Gruppo di risorse del piano di servizio app.
properties.spotExpirationTime	string (date-time)		Ora di scadenza della server farm. Valido solo se si tratta di una server farm spot.
properties.status	StatusOptions		Stato del piano di servizio app.
properties.subscription	string		Sottoscrizione del piano di servizio app.
properties.targetWorkerCount	integer (int32)		Ridimensionamento del numero di ruoli di lavoro.
properties.targetWorkerSizeId	integer (int32)		Ridimensionamento dell'ID dimensione del ruolo di lavoro.
properties.workerTierName	string		Livello di lavoro di destinazione assegnato al piano di servizio app.
properties.zoneRedundant	boolean	False	Se `true`, questo piano di servizio app eseguirà il bilanciamento della zona di disponibilità. Se `false`, questo piano di servizio app non eseguirà il bilanciamento della zona di disponibilità.
sku	SkuDescription		Descrizione di uno SKU per una risorsa scalabile.
tags	object		Tag di risorsa.
type	string		Tipo di risorsa.

Capability

Object

Descrive le funzionalità o le funzionalità consentite per uno SKU specifico.

Nome	Tipo	Descrizione
name	string	Nome della funzionalità SKU.
reason	string	Motivo della funzionalità SKU.
value	string	Valore della funzionalità SKU.

DefaultErrorResponse

Object

Risposta di errore del servizio app.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Object

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

Error

Object

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
details	Details[]	Errori dettagliati.
innererror	string	Altre informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

ExtendedLocation

Object

Posizione estesa.

Nome	Tipo	Descrizione
name	string	Nome della posizione estesa.
type	string	Tipo di posizione estesa.

HostingEnvironmentProfile

Object

Specifica per un ambiente del servizio app da usare per questa risorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa dell'ambiente del servizio app.
name	string	Nome dell'ambiente del servizio app.
type	string	Tipo di risorsa dell'ambiente del servizio app.

KubeEnvironmentProfile

Object

Specifica per un ambiente Kubernetes da usare per questa risorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa dell'ambiente Kubernetes.
name	string	Nome dell'ambiente Kubernetes.
type	string	Tipo di risorsa dell'ambiente Kubernetes.

ProvisioningState

Enumerazione

Stato di provisioning del piano di servizio app.

Valore	Descrizione
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Object

Descrizione delle opzioni di scalabilità del piano di servizio app.

Nome	Tipo	Descrizione
default	integer (int32)	Numero predefinito di ruoli di lavoro per questo SKU del piano di servizio app.
elasticMaximum	integer (int32)	Numero massimo di ruoli di lavoro elastici per questo SKU del piano di servizio app.
maximum	integer (int32)	Numero massimo di ruoli di lavoro per questo SKU del piano di servizio app.
minimum	integer (int32)	Numero minimo di ruoli di lavoro per questo SKU del piano di servizio app.
scaleType	string	Configurazioni di scalabilità disponibili per un piano di servizio app.

SkuDescription

Object

Descrizione di uno SKU per una risorsa scalabile.

Nome	Tipo	Descrizione
capabilities	Capability[]	Le funzionalità dello SKU, ad esempio, sono abilitate per Gestione traffico?
capacity	integer (int32)	Numero corrente di istanze assegnate alla risorsa.
family	string	Codice della famiglia dello SKU della risorsa.
locations	string[]	Posizioni dello SKU.
name	string	Nome dello SKU della risorsa.
size	string	Identificatore di dimensioni dello SKU della risorsa.
skuCapacity	SkuCapacity	Valori di scala minimo, massimo e predefinito dello SKU.
tier	string	Livello di servizio dello SKU della risorsa.

StatusOptions

Enumerazione

Stato del piano di servizio app.

Valore	Descrizione
Creating
Pending
Ready