App Service Plans - Get

Referência

Service:: App Service

API Version:: 2023-12-01

Descrição para Obter um plano de Serviço de Aplicações.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}?api-version=2023-12-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	Nome do grupo de recursos ao qual o recurso pertence. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada por GUID (por exemplo, 0000000000-0000-0000-0000-00000000000000).
api-version	query	True	string	Versão da API

Respostas

Name	Tipo	Description
200 OK	AppServicePlan	OK.
404 Not Found		Não encontrado.
Other Status Codes	DefaultErrorResponse	Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get App Service plan

Sample Request

HTTP

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

Sample Response

Status code:: 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
  }
}

Status code:: 404

Definições

Name	Description
AppServicePlan	Serviço de Aplicações plano.
Capability	Descreve as capacidades/funcionalidades permitidas para um SKU específico.
DefaultErrorResponse	Serviço de Aplicações resposta de erro.
Details
Error	Modelo de erro.
ExtendedLocation	Localização Expandida.
HostingEnvironmentProfile	Especificação para um Ambiente do Serviço de Aplicações a utilizar para este recurso.
KubeEnvironmentProfile	Especificação para um Ambiente do Kubernetes a utilizar para este recurso.
ProvisioningState	Estado de aprovisionamento do Plano de Serviço de Aplicações.
SkuCapacity	Descrição das opções de dimensionamento do plano Serviço de Aplicações.
SkuDescription	Descrição de um SKU para um recurso dimensionável.
StatusOptions	Serviço de Aplicações estado do plano.

AppServicePlan

Serviço de Aplicações plano.

Name	Tipo	Valor Predefinido	Description
extendedLocation	ExtendedLocation		Localização Expandida.
id	string		ID do Recurso.
kind	string		Tipo de recurso.
location	string		Localização do Recurso.
name	string		Nome do Recurso.
properties.elasticScaleEnabled	boolean		ServerFarm suporta ElasticScale. As aplicações neste plano serão dimensionadas como se o ServerFarm fosse ElasticPremium sku
properties.freeOfferExpirationTime	string		A hora em que a oferta gratuita do farm de servidores expira.
properties.geoRegion	string		Localização geográfica do plano de Serviço de Aplicações.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Especificação para o Ambiente do Serviço de Aplicações a utilizar para o plano de Serviço de Aplicações.
properties.hyperV	boolean	False	Se o plano `true`do serviço de aplicações de contentor do Hyper-V, `false` caso contrário.
properties.isSpot	boolean		Se `true`, este Serviço de Aplicações Plano é proprietário de instâncias spot.
properties.isXenon	boolean	False	Obsoleto: se o plano `true`do serviço de aplicações de contentor do Hyper-V, `false` caso contrário.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Especificação para o Ambiente do Kubernetes utilizar para o plano de Serviço de Aplicações.
properties.maximumElasticWorkerCount	integer		Número máximo de trabalhadores totais permitidos para este Plano de Serviço de Aplicações ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer		Número máximo de instâncias que podem ser atribuídas a este plano de Serviço de Aplicações.
properties.numberOfSites	integer		Número de aplicações atribuídas a este plano de Serviço de Aplicações.
properties.numberOfWorkers	integer		O número de instâncias atribuídas a este plano de Serviço de Aplicações.
properties.perSiteScaling	boolean	False	Se `true`, as aplicações atribuídas a este plano de Serviço de Aplicações podem ser dimensionadas de forma independente. Se `false`, as aplicações atribuídas a este plano de Serviço de Aplicações serão dimensionadas para todas as instâncias do plano.
properties.provisioningState	ProvisioningState		Estado de aprovisionamento do Plano de Serviço de Aplicações.
properties.reserved	boolean	False	Se o plano `true`do serviço de aplicações do Linux, `false` caso contrário.
properties.resourceGroup	string		Grupo de recursos do plano de Serviço de Aplicações.
properties.spotExpirationTime	string		A hora em que o farm de servidores expira. Válido apenas se for um farm de servidores spot.
properties.status	StatusOptions		Serviço de Aplicações estado do plano.
properties.subscription	string		Serviço de Aplicações subscrição do plano.
properties.targetWorkerCount	integer		Contagem de trabalhos de dimensionamento.
properties.targetWorkerSizeId	integer		Dimensionar o ID do tamanho da função de trabalho.
properties.workerTierName	string		Escalão de trabalho de destino atribuído ao plano de Serviço de Aplicações.
properties.zoneRedundant	boolean	False	Se `true`, este Serviço de Aplicações Plano irá efetuar o balanceamento da zona de disponibilidade. Se `false`, este Serviço de Aplicações Plano não realizará o balanceamento da zona de disponibilidade.
sku	SkuDescription		Descrição de um SKU para um recurso dimensionável.
tags	object		Etiquetas de recursos.
type	string		Tipo de recurso.

Capability

Descreve as capacidades/funcionalidades permitidas para um SKU específico.

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

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name	Tipo	Description
error	Error	Modelo de erro.

Details

Name	Tipo	Description
code	string	Cadeia 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.

Error

Modelo de erro.

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar 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.

ExtendedLocation

Localização Expandida.

Name	Tipo	Description
name	string	Nome da localização expandida.
type	string	Tipo de localização expandida.

HostingEnvironmentProfile

Especificação para um Ambiente do Serviço de Aplicações a utilizar para este recurso.

Name	Tipo	Description
id	string	ID de recurso do Ambiente do Serviço de Aplicações.
name	string	Nome do Ambiente do Serviço de Aplicações.
type	string	Tipo de recurso do Ambiente do Serviço de Aplicações.

KubeEnvironmentProfile

Especificação para um Ambiente do Kubernetes a utilizar para este recurso.

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

ProvisioningState

Estado de aprovisionamento do Plano de Serviço de Aplicações.

Name	Tipo	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

SkuCapacity

Descrição das opções de dimensionamento do plano Serviço de Aplicações.

Name	Tipo	Description
default	integer	Número predefinido de trabalhadores para este SKU do plano Serviço de Aplicações.
elasticMaximum	integer	Número máximo de trabalhadores elásticos para este Serviço de Aplicações SKU do plano.
maximum	integer	Número máximo de trabalhadores para este Serviço de Aplicações SKU do plano.
minimum	integer	Número mínimo de trabalhadores para este Serviço de Aplicações SKU do plano.
scaleType	string	Configurações de dimensionamento disponíveis para um plano de Serviço de Aplicações.

SkuDescription

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

Name	Tipo	Description
capabilities	Capability[]	As capacidades do SKU, por exemplo, estão ativadas pelo gestor de tráfego?
capacity	integer	Número atual de instâncias atribuídas ao recurso.
family	string	Código familiar do SKU do recurso.
locations	string[]	Localizações do SKU.
name	string	Nome do SKU do recurso.
size	string	Especificador de tamanho do SKU do recurso.
skuCapacity	SkuCapacity	Valores de dimensionamento mínimo, máximo e predefinido do SKU.
tier	string	Escalão de serviço do SKU do recurso.

StatusOptions

Serviço de Aplicações estado do plano.

Name	Tipo	Description
Creating	string
Pending	string
Ready	string