App Service Plans - Get

Referência

Service:: App Service

API Version:: 2023-12-01

Descrição para Obter um plano de Serviço de Aplicativo.

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

Parâmetros de URI

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

Respostas

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

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

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

Nome	Description
AppServicePlan	Plano do Serviço de Aplicativo.
Capability	Descreve os recursos/funcionalidades permitidos para um SKU específico.
DefaultErrorResponse	Serviço de Aplicativo resposta de erro.
Details
Error	Modelo de erro.
ExtendedLocation	Localização Estendida.
HostingEnvironmentProfile	Especificação de um Ambiente do Serviço de Aplicativo a ser usado para esse recurso.
KubeEnvironmentProfile	Especificação de um Ambiente kubernetes a ser usado para esse recurso.
ProvisioningState	Estado de provisionamento do plano de Serviço de Aplicativo.
SkuCapacity	Descrição das opções de escala do plano Serviço de Aplicativo.
SkuDescription	Descrição de um SKU para um recurso escalonável.
StatusOptions	Serviço de Aplicativo plano status.

AppServicePlan

Plano do Serviço de Aplicativo.

Nome	Tipo	Valor padrão	Description
extendedLocation	ExtendedLocation		Localização Estendida.
id	string		ID do recurso.
kind	string		Tipo de recurso.
location	string		Local do recurso.
name	string		Nome do recurso.
properties.elasticScaleEnabled	boolean		ServerFarm dá suporte ao ElasticScale. Os aplicativos neste plano serão dimensionados como se o ServerFarm fosse o sku ElasticPremium
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 Aplicativo.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Especificação para o Ambiente do Serviço de Aplicativo a ser usado para o plano de Serviço de Aplicativo.
properties.hyperV	boolean	False	Se o plano `true`do serviço de aplicativo de contêiner do Hyper-V for , `false` caso contrário, .
properties.isSpot	boolean		Se `true`, esse plano Serviço de Aplicativo possui instâncias spot.
properties.isXenon	boolean	False	Obsoleto: se o plano `true`do serviço de aplicativo de contêiner hyper-V for , `false` caso contrário, .
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Especificação para o Ambiente kubernetes a ser usado para o plano de Serviço de Aplicativo.
properties.maximumElasticWorkerCount	integer		Número máximo de trabalhos permitidos para este Plano de Serviço de Aplicativo ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer		Número máximo de instâncias que podem ser atribuídas a esse plano Serviço de Aplicativo.
properties.numberOfSites	integer		Número de aplicativos atribuídos a esse plano de Serviço de Aplicativo.
properties.numberOfWorkers	integer		O número de instâncias atribuídas a esse plano Serviço de Aplicativo.
properties.perSiteScaling	boolean	False	Se `true`, os aplicativos atribuídos a esse plano Serviço de Aplicativo poderão ser dimensionados de forma independente. Se `false`, os aplicativos atribuídos a esse plano Serviço de Aplicativo serão dimensionados para todas as instâncias do plano.
properties.provisioningState	ProvisioningState		Estado de provisionamento do plano de Serviço de Aplicativo.
properties.reserved	boolean	False	Se o serviço de aplicativo Linux planejar `true`, `false` caso contrário, .
properties.resourceGroup	string		Grupo de recursos do plano de Serviço de Aplicativo.
properties.spotExpirationTime	string		A hora em que o farm de servidores expira. Válido somente se for um farm de servidores spot.
properties.status	StatusOptions		Serviço de Aplicativo plano status.
properties.subscription	string		Serviço de Aplicativo assinatura do plano.
properties.targetWorkerCount	integer		Dimensionamento da contagem de trabalho.
properties.targetWorkerSizeId	integer		Dimensionando a ID do tamanho do trabalho.
properties.workerTierName	string		Camada de trabalho de destino atribuída ao plano de Serviço de Aplicativo.
properties.zoneRedundant	boolean	False	Se `true`, este plano de Serviço de Aplicativo executará o balanceamento de zona de disponibilidade. Se `false`, este plano de 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

Descreve os recursos/funcionalidades permitidos para um SKU específico.

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

Serviço de Aplicativo resposta de erro.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

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 erro.
target	string	Informações detalhadas de descrição e depuração de erro.

Error

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 erro.
target	string	Informações detalhadas de descrição e depuração de erro.

ExtendedLocation

Localização Estendida.

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

HostingEnvironmentProfile

Especificação de 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

Especificação de um Ambiente kubernetes a ser usado para esse recurso.

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

ProvisioningState

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

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

SkuCapacity

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

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

SkuDescription

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

Nome	Tipo	Description
capabilities	Capability[]	Os recursos do SKU, por exemplo, estão habilitados para o gerenciador de tráfego?
capacity	integer	Número atual de instâncias atribuídas ao recurso.
family	string	Código da 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ínimos, máximos e padrão da SKU.
tier	string	Camada de serviço do SKU do recurso.

StatusOptions

Serviço de Aplicativo plano status.

Nome	Tipo	Description
Creating	string
Pending	string
Ready	string