App Service Plans - Get

Serviço:

App Service

Versão da API:

2024-04-01

Descrição para obter um plano do Serviço de Aplicativo.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do plano do Serviço de Aplicativo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID de assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	AppServicePlan	OKEY.
404 Not Found		Não encontrado.
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get App Service plan

Solicitação de exemplo

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

Python

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

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

JavaScript

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

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

Resposta de exemplo

Código de status:

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

Código de status:

404

Definições

Nome	Description
AppServicePlan	Plano do Serviço de Aplicativo.
Capability	Descreve os recursos/recursos permitidos para uma SKU específica.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
ExtendedLocation	Local Estendido.
HostingEnvironmentProfile	Especificação para um Ambiente do Serviço de Aplicativo a ser usado para esse recurso.
KubeEnvironmentProfile	Especificação para um Ambiente do Kubernetes a ser usado para esse recurso.
ProvisioningState	Estado de provisionamento do Plano do Serviço de Aplicativo.
SkuCapacity	Descrição das opções de escala do plano do Serviço de Aplicativo.
SkuDescription	Descrição de um SKU para um recurso escalonável.
StatusOptions	Status do plano do Serviço de Aplicativo.

AppServicePlan

Objeto

Plano do Serviço de Aplicativo.

Nome	Tipo	Valor padrão	Description
extendedLocation	ExtendedLocation		Local Estendido.
id	string		ID do recurso.
kind	string		Tipo de recurso. Se o recurso for um aplicativo, você poderá consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obter detalhes de valores com suporte para tipo.
location	string		Local do recurso.
name	string		Nome do recurso.
properties.elasticScaleEnabled	boolean		O ServerFarm dá suporte ao ElasticScale. Os aplicativos neste plano serão dimensionados como se o ServerFarm fosse sku ElasticPremium
properties.freeOfferExpirationTime	string (date-time)		A hora em que a oferta gratuita do farm de servidores expira.
properties.geoRegion	string		Localização geográfica para o plano do Serviço de Aplicativo.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Especificação para o Ambiente do Serviço de Aplicativo a ser usado para o plano do Serviço de Aplicativo.
properties.hyperV	boolean	False	Se Hyper-V plano do serviço de aplicativo de contêiner true, false caso contrário.
properties.isSpot	boolean		Se true, este Plano do Serviço de Aplicativo será proprietário de instâncias spot.
properties.isXenon	boolean	False	Obsoleto: se Hyper-V plano do serviço de aplicativo de contêiner true, false caso contrário.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Especificação para o Ambiente do Kubernetes a ser usado para o plano do Serviço de Aplicativo.
properties.maximumElasticWorkerCount	integer (int32)		Número máximo de trabalhadores permitidos para este Plano do Serviço de Aplicativo ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer (int32)		Número máximo de instâncias que podem ser atribuídas a este plano do Serviço de Aplicativo.
properties.numberOfSites	integer (int32)		Número de aplicativos atribuídos a este plano do Serviço de Aplicativo.
properties.numberOfWorkers	integer (int32)		O número de instâncias atribuídas a este plano do Serviço de Aplicativo.
properties.perSiteScaling	boolean	False	Se true, os aplicativos atribuídos a este plano do Serviço de Aplicativo poderão ser dimensionados de forma independente. Se false, os aplicativos atribuídos a este plano do Serviço de Aplicativo serão dimensionados para todas as instâncias do plano.
properties.provisioningState	ProvisioningState		Estado de provisionamento do Plano do Serviço de Aplicativo.
properties.reserved	boolean	False	Se o plano do serviço de aplicativo Linux true, false caso contrário.
properties.resourceGroup	string		Grupo de recursos do plano do Serviço de Aplicativo.
properties.spotExpirationTime	string (date-time)		A hora em que o farm de servidores expira. Válido somente se for um farm de servidores spot.
properties.status	StatusOptions		Status do plano do Serviço de Aplicativo.
properties.subscription	string		Assinatura do plano do Serviço de Aplicativo.
properties.targetWorkerCount	integer (int32)		Dimensionamento da contagem de trabalho.
properties.targetWorkerSizeId	integer (int32)		Dimensionamento da ID do tamanho do trabalho.
properties.workerTierName	string		Camada de trabalho de destino atribuída ao plano do Serviço de Aplicativo.
properties.zoneRedundant	boolean	False	Se true, este Plano do Serviço de Aplicativo executará o balanceamento de zona de disponibilidade. Se false, este Plano do Serviço de Aplicativo não executará o balanceamento de zona de disponibilidade.
sku	SkuDescription		Descrição de um SKU para um recurso escalonável.
tags	object		Marcas de recurso.
type	string		Tipo de recurso.

Capability

Objeto

Descreve os recursos/recursos permitidos para uma SKU específica.

Nome	Tipo	Description
name	string	Nome da funcionalidade de SKU.
reason	string	Motivo da funcionalidade de SKU.
value	string	Valor da funcionalidade de SKU.

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

ExtendedLocation

Objeto

Local Estendido.

Nome	Tipo	Description
name	string	Nome do local estendido.
type	string	Tipo de local estendido.

HostingEnvironmentProfile

Objeto

Especificação para um Ambiente do Serviço de Aplicativo a ser usado para esse recurso.

Nome	Tipo	Description
id	string	ID do recurso do Ambiente do Serviço de Aplicativo.
name	string	Nome do Ambiente do Serviço de Aplicativo.
type	string	Tipo de recurso do Ambiente do Serviço de Aplicativo.

KubeEnvironmentProfile

Objeto

Especificação para um Ambiente do Kubernetes a ser usado para esse recurso.

Nome	Tipo	Description
id	string	ID do recurso do Ambiente do Kubernetes.
name	string	Nome do Ambiente do Kubernetes.
type	string	Tipo de recurso do Ambiente do Kubernetes.

ProvisioningState

Enumeração

Estado de provisionamento do Plano do Serviço de Aplicativo.

Valor	Description
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Objeto

Descrição das opções de escala do plano do Serviço de Aplicativo.

Nome	Tipo	Description
default	integer (int32)	Número padrão de trabalhos para este SKU de plano do Serviço de Aplicativo.
elasticMaximum	integer (int32)	Número máximo de trabalhos elásticos para este SKU de plano do Serviço de Aplicativo.
maximum	integer (int32)	Número máximo de trabalhadores para esse SKU de plano do Serviço de Aplicativo.
minimum	integer (int32)	Número mínimo de trabalhadores para esse SKU de plano do Serviço de Aplicativo.
scaleType	string	Configurações de escala disponíveis para um plano do Serviço de Aplicativo.

SkuDescription

Objeto

Descrição de um SKU para um recurso escalonável.

Nome	Tipo	Description
capabilities	Capability[]	Os recursos da SKU, por exemplo, estão habilitados para o gerenciador de tráfego?
capacity	integer (int32)	Número atual de instâncias atribuídas ao recurso.
family	string	Código de família do SKU do recurso.
locations	string[]	Locais do SKU.
name	string	Nome do SKU do recurso.
size	string	Especificador de tamanho do SKU do recurso.
skuCapacity	SkuCapacity	Valores de escala mínimo, máximo e padrão da SKU.
tier	string	Camada de serviço do SKU do recurso.

StatusOptions

Enumeração

Status do plano do Serviço de Aplicativo.

Valor	Description
Creating
Pending
Ready