App Service Plans - Get

Serviço:: App Service

Versão da API:: 2025-05-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=2025-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome do plano de serviço de aplicações.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	AppServicePlan	Operação do Azure concluída com êxito.
404 Not Found		O servidor não consegue encontrar o recurso solicitado.
Other Status Codes	DefaultErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get App Service plan

Pedido de amostra

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


/**
 * Samples for AppServicePlans GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/GetAppServicePlan.json
     */
    /**
     * Sample code: Get App Service plan.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void getAppServicePlan(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        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

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

// Generated from example definition: 2025-05-01/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("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", 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 = armappservice.PlansClientGetResponse{
	// 	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

Resposta da amostra

Código de estado:: 200

{
  "name": "testsf6141",
  "type": "Microsoft.Web/serverfarms",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
  "kind": "app",
  "location": "East US",
  "properties": {
    "geoRegion": "East US",
    "isSpot": false,
    "maximumNumberOfWorkers": 20,
    "numberOfSites": 4,
    "numberOfWorkers": 19,
    "provisioningState": "Succeeded",
    "reserved": false,
    "status": "Ready",
    "targetWorkerCount": 0,
    "targetWorkerSizeId": 0
  },
  "sku": {
    "name": "P1",
    "capacity": 1,
    "family": "P",
    "size": "P1",
    "tier": "Premium"
  }
}

Código de estado:: 404

Definições

Name	Description
AppServicePlan	Plano do Serviço de Aplicações.
Capability	Descreve os recursos/capacidades permitidos para uma SKU específica.
createdByType	O tipo de identidade que criou o recurso.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
DefaultErrorResponseError	Modelo de erro.
DefaultErrorResponseErrorDetailsItem	Erros detalhados.
DefaultIdentity
ExtendedLocation	Localização estendida.
HostingEnvironmentProfile	Especificação para um Ambiente do Serviço de Aplicativo a ser usado para este recurso.
InstallScript	Configuração do script de instalação do farm de servidores.
InstallScriptSource	Objeto para manter a referência de script de instalação.
InstallScriptType	Tipo de script de instalação.
KeyVaultReferenceWithStatus	Objeto para manter a referência do cofre de chaves e o status da resolução
KubeEnvironmentProfile	Especificação para um ambiente Kubernetes a ser usado para este recurso.
ManagedServiceIdentity	Identidade do serviço gerenciado.
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
ProvisioningState	Estado de provisionamento do Plano do Serviço de Aplicativo.
RegistryAdapter	Configuração do adaptador de registro do farm de servidores.
RegistryAdapterType	Tipo de adaptador de registro.
ServerFarmNetworkSettings	Configurações de rede para um plano de serviço de aplicativo.
SkuCapacity	Descrição das opções de escala do plano do Serviço de Aplicativo.
SkuDescription	Descrição de uma SKU para um recurso escalável.
StatusOptions	Status do plano do Serviço de Aplicativo.
StorageMount	Configuração de montagem de armazenamento de farm de servidores.
StorageMountType	Tipo de suporte de armazenamento.
systemData	Metadados referentes à criação e última modificação do recurso.
UserAssignedIdentity	Identidade atribuída pelo usuário.

AppServicePlan

Object

Plano do Serviço de Aplicações.

Name	Tipo	Description
extendedLocation	ExtendedLocation	Localização estendida.
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identidade do serviço gerenciado.
kind	string	Tipo de recurso. Se o recurso for um aplicativo, você pode 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 sobre os valores suportados para o tipo.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.asyncScalingEnabled	boolean	Se `true`o , este Plano do Serviço de Aplicativo tentará dimensionar de forma assíncrona se não houver trabalhadores suficientes para dimensionar de forma síncrona. Se `false`o , este Plano do Serviço de Aplicativo tentará apenas o dimensionamento de sincronização.
properties.elasticScaleEnabled	boolean	ServerFarm suporta ElasticScale. Os aplicativos neste plano serão dimensionados como se o ServerFarm fosse uma sku ElasticPremium
properties.freeOfferExpirationTime	string (date-time)	O tempo em que a oferta gratuita do farm de servidores expira.
properties.geoRegion	string	Localização geográfica do 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	Se Hyper-V plano `true`de serviço de aplicativo de contêiner , `false` caso contrário.
properties.installScripts	InstallScript[]	Instale scripts associados a este plano do Serviço de Aplicativo.
properties.isCustomMode	boolean	Se este farm de servidores está no modo personalizado.
properties.isSpot	boolean	Se `true`o , este Plano do Serviço de Aplicativo possui instâncias spot.
properties.isXenon	boolean	Obsoleto: Se Hyper-V plano `true`de serviço de aplicativo de contêiner , `false` caso contrário.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile	Especificação para o ambiente Kubernetes a ser usado para o plano do Serviço de Aplicativo.
properties.maximumElasticWorkerCount	integer (int32)	Número máximo de trabalhadores totais permitido para este Plano de 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.network	ServerFarmNetworkSettings	Todas as configurações de rede para o farm de servidores.
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	Se `true`, os aplicativos atribuídos a este plano do Serviço de Aplicativo podem 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.planDefaultIdentity	DefaultIdentity	Identidade a ser usada pela plataforma para vários recursos e integrações usando identidade gerenciada.
properties.provisioningState	ProvisioningState	Estado de provisionamento do Plano do Serviço de Aplicativo.
properties.rdpEnabled	boolean	Se `true`o acesso RDP estiver habilitado para este plano do Serviço de Aplicativo. Aplicável apenas para ASPs IsCustomMode. Se `false`o acesso RDP estiver desativado.
properties.registryAdapters	RegistryAdapter[]	Adaptadores de registo associados a este plano do Serviço de Aplicações.
properties.reserved	boolean	Se o plano `true`de serviço de aplicativo Linux , `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.storageMounts	StorageMount[]	Montagens de armazenamento associadas a este 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 trabalhadores.
properties.targetWorkerSizeId	integer (int32)	Dimensionamento do ID do tamanho do trabalhador.
properties.workerTierName	string	Camada de trabalhador de destino atribuída ao plano do Serviço de Aplicativo.
properties.zoneRedundant	boolean	Se `true`o , este Plano do Serviço de Aplicativo executará o balanceamento da zona de disponibilidade. Se `false`o , este Plano do Serviço de Aplicativo não executará o balanceamento da zona de disponibilidade.
sku	SkuDescription	Descrição de uma SKU para um recurso escalável.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Capability

Object

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

Name	Tipo	Description
name	string	Nome do recurso de SKU.
reason	string	Razão da capacidade de SKU.
value	string	Valor da capacidade de SKU.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

Resposta de erro do Serviço de Aplicativo.

Name	Tipo	Description
error	DefaultErrorResponseError	Modelo de erro.

DefaultErrorResponseError

Object

Modelo de erro.

Name	Tipo	Description
code	string	String padronizada para identificar programaticamente o erro.
details	DefaultErrorResponseErrorDetailsItem[]	Erros detalhados.
innererror	string	Mais informações para depurar erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

DefaultErrorResponseErrorDetailsItem

Object

Erros detalhados.

Name	Tipo	Description
code	string	String padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

DefaultIdentity

Object

Name	Tipo	Description
identityType	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
userAssignedIdentityResourceId	string

ExtendedLocation

Object

Localização estendida.

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

HostingEnvironmentProfile

Object

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

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

InstallScript

Object

Configuração do script de instalação do farm de servidores.

Name	Tipo	Description
name	string	Nome do script de instalação.
source	InstallScriptSource	Origem do script de instalação.

InstallScriptSource

Object

Objeto para manter a referência de script de instalação.

Name	Tipo	Description
sourceUri	string	Instale o URI de origem do script de onde o arquivo de script de instalação será buscado.
type	InstallScriptType	Tipo de script de instalação.

InstallScriptType

Enumeração

Tipo de script de instalação.

Valor	Description
RemoteAzureBlob
PlatformStorage

KeyVaultReferenceWithStatus

Object

Objeto para manter a referência do cofre de chaves e o status da resolução

Name	Tipo	Description
referenceStatus	string	Status de referência do segredo do cofre de chaves.
secretUri	string	URI secreto do cofre de chaves.

KubeEnvironmentProfile

Object

Especificação para um ambiente Kubernetes a ser usado para este recurso.

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

ManagedServiceIdentity

Object

Identidade do serviço gerenciado.

Name	Tipo	Description
principalId	string	ID principal da identidade do serviço gerenciado.
tenantId	string	Locatário da identidade do serviço gerenciado.
type	ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
userAssignedIdentities	<string, UserAssignedIdentity>	A lista de identidades atribuídas pelo usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ProvisioningState

Enumeração

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

Valor	Description
Succeeded
Failed
Canceled
InProgress
Deleting

RegistryAdapter

Object

Configuração do adaptador de registro do farm de servidores.

Name	Tipo	Description
keyVaultSecretReference	KeyVaultReferenceWithStatus	Referência do cofre de chaves ao valor que será colocado no local do Registro
registryKey	string	Chave do Registro para o adaptador.
type	RegistryAdapterType	Tipo de adaptador de registro.

RegistryAdapterType

Enumeração

Tipo de adaptador de registro.

Valor	Description
Binary
String
Expand_String
Multi_String
DWord
QWord

ServerFarmNetworkSettings

Object

Configurações de rede para um plano de serviço de aplicativo.

Name	Tipo	Description
virtualNetworkSubnetId	string	ID do Azure Resource Manager da rede virtual e da sub-rede a serem unidas pela Integração VNET Regional. Isso deve ter o formato /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

SkuCapacity

Object

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

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

SkuDescription

Object

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

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

StatusOptions

Enumeração

Status do plano do Serviço de Aplicativo.

Valor	Description
Ready
Pending
Creating

StorageMount

Object

Configuração de montagem de armazenamento de farm de servidores.

Name	Tipo	Description
credentialsKeyVaultReference	KeyVaultReferenceWithStatus	Referência KV às credenciais para se conectar ao compartilhamento.
destinationPath	string	Caminho no trabalhador onde o armazenamento será montado.
name	string	Nome do suporte de armazenamento.
source	string	Origem do compartilhamento de arquivos/armazenamento.
type	StorageMountType	Tipo de suporte de armazenamento.

StorageMountType

Enumeração

Tipo de suporte de armazenamento.

Valor	Description
AzureFiles
LocalStorage
FileShare

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Object

Identidade atribuída pelo usuário.

Name	Tipo	Description
clientId	string	ID do cliente da identidade atribuída ao usuário
principalId	string	ID principal da identidade atribuída ao usuário

Partilhar via

App Service Plans - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Get App Service plan

Pedido de amostra

Resposta da amostra

Definições

AppServicePlan

Capability

createdByType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

DefaultIdentity

ExtendedLocation

HostingEnvironmentProfile

InstallScript

InstallScriptSource

InstallScriptType

KeyVaultReferenceWithStatus

KubeEnvironmentProfile

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

RegistryAdapter

RegistryAdapterType

ServerFarmNetworkSettings

SkuCapacity

SkuDescription

StatusOptions

StorageMount

StorageMountType

systemData

UserAssignedIdentity