App Service Plans - Get

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

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

Parâmetros do URI

Name In Required Type Description
name
path True
  • string

Nome do plano de serviço de aplicações.

resourceGroupName
path True
  • string

Nome do grupo de recursos a que pertence o recurso.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True
  • string

O seu ID de subscrição do Azure. Trata-se de uma corda formatada pelo GUID (por exemplo, 0000000-0000-0000-0000-0000-0000000000000000000).

api-version
query True
  • string

Versão da API

Respostas

Name Type Description
200 OK

OK.

404 Not Found

Não encontrado.

Other Status Codes

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

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Get App Service plan

Sample Request

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

Sample Response

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

Definições

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

HostingEnvironmentProfile

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

KubeEnvironmentProfile

Especificação para um Ambiente Kubernetes para usar para este recurso.

ProvisioningState

Estado de provisão do Plano Serviço de Aplicações.

SkuCapacity

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

SkuDescription

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

StatusOptions

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

AppServicePlan

Serviço de Aplicações plano.

Name Type Default Value Description
extendedLocation

Localização estendida.

id
  • string

Identificação de recursos.

kind
  • string

Tipo de recurso.

location
  • string

Localização de Recursos.

name
  • string

Nome de recurso.

properties.elasticScaleEnabled
  • boolean

ServerFarm suporta ElasticScale. As aplicações neste plano vão escalar como se o ServerFarm fosse elasticPremium sku

properties.freeOfferExpirationTime
  • string

O momento em que a oferta gratuita da fazenda do servidor expira.

properties.geoRegion
  • string

Localização geográfica para o plano Serviço de Aplicações.

properties.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 de serviço de aplicação de contentores Hyper-V for planeado true, false caso contrário.

properties.isSpot
  • boolean

Setrue, este plano Serviço de Aplicações possuir instâncias pontuais.

properties.isXenon
  • boolean
False

Obsoleto: Se o plano de serviço de aplicação de contentores Hyper-V for planeado true, false caso contrário.

properties.kubeEnvironmentProfile

Especificação para o Ambiente Kubernetes a utilizar para o plano Serviço de Aplicações.

properties.maximumElasticWorkerCount
  • integer

Número máximo de trabalhadores totais autorizados para este Plano de Serviço de Aplicações ElasticScaleEnabled

properties.maximumNumberOfWorkers
  • integer

Número máximo de casos que podem ser atribuídos a este plano Serviço de Aplicações.

properties.numberOfSites
  • integer

Número de aplicações atribuídas a este plano Serviço de Aplicações.

properties.numberOfWorkers
  • integer

O número de casos atribuídos a este plano Serviço de Aplicações.

properties.perSiteScaling
  • boolean
False

Se true, as aplicações atribuídas a este Serviço de Aplicações plano pode ser dimensionado de forma independente. Se false, as aplicações atribuídas a este Serviço de Aplicações plano irá escalar para todos os casos do plano.

properties.provisioningState

Estado de provisão do Plano Serviço de Aplicações.

properties.reserved
  • boolean
False

Se o plano truede serviço de aplicações Linux, false caso contrário.

properties.resourceGroup
  • string

Grupo de recursos do plano Serviço de Aplicações.

properties.spotExpirationTime
  • string

A hora em que a fazenda do servidor expira. Válido apenas se for uma fazenda de servidores spot.

properties.status

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

properties.subscription
  • string

Serviço de Aplicações de planear a subscrição.

properties.targetWorkerCount
  • integer

Contagem de trabalhadores de escalonamento.

properties.targetWorkerSizeId
  • integer

Identificação do tamanho do trabalhador.

properties.workerTierName
  • string

Nível de trabalhador-alvo atribuído ao plano de Serviço de Aplicações.

properties.zoneRedundant
  • boolean
False

Setrue, este Plano Serviço de Aplicações realizar o equilíbrio da zona de disponibilidade. Sefalse, este Plano Serviço de Aplicações não realizar o equilíbrio da zona de disponibilidade.

sku

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

tags
  • object

Etiquetas de recursos.

type
  • string

Tipo de recurso.

Capability

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

Name Type Description
name
  • string

Nome da capacidade SKU.

reason
  • string

Razão da capacidade do SKU.

value
  • string

Valor da capacidade SKU.

DefaultErrorResponse

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

Name Type Description
error

Modelo de erro.

Details

Name Type Description
code
  • string

Cadeia padronizada para identificar programáticamente o erro.

message
  • string

Descrição detalhada do erro e depuragem de informação.

target
  • string

Descrição detalhada do erro e depuragem de informação.

Error

Modelo de erro.

Name Type Description
code
  • string

Cadeia padronizada para identificar programáticamente o erro.

details

Erros detalhados.

innererror
  • string

Mais informações para depurar erro.

message
  • string

Descrição detalhada do erro e depuragem de informação.

target
  • string

Descrição detalhada do erro e depuragem de informação.

ExtendedLocation

Localização estendida.

Name Type Description
name
  • string

Nome da localização estendida.

type
  • string

Tipo de localização estendida.

HostingEnvironmentProfile

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

Name Type Description
id
  • string

Identificação de recursos do Ambiente do Serviço de Aplicações.

name
  • string

O 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 Kubernetes para usar para este recurso.

Name Type Description
id
  • string

Identificação de recursos do Ambiente Kubernetes.

name
  • string

Nome do Ambiente Kubernetes.

type
  • string

Tipo de recurso do Ambiente Kubernetes.

ProvisioningState

Estado de provisão do Plano Serviço de Aplicações.

Name Type Description
Canceled
  • string
Deleting
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string

SkuCapacity

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

Name Type Description
default
  • integer

O número predefinido de trabalhadores para este plano Serviço de Aplicações SKU.

elasticMaximum
  • integer

Número máximo de trabalhadores elásticos para este plano Serviço de Aplicações SKU.

maximum
  • integer

O número máximo de trabalhadores para este Serviço de Aplicações plano SKU.

minimum
  • integer

O número mínimo de trabalhadores para este Serviço de Aplicações plano SKU.

scaleType
  • string

Configurações de escala disponíveis para um plano Serviço de Aplicações.

SkuDescription

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

Name Type Description
capabilities

As capacidades do SKU, por exemplo, estão ativadas pelo gestor de tráfego?

capacity
  • integer

Número atual de casos atribuídos ao recurso.

family
  • string

Código familiar do recurso SKU.

locations
  • string[]

Localizações do SKU.

name
  • string

Nome do recurso SKU.

size
  • string

Especificador de tamanho do recurso SKU.

skuCapacity

Valores de escala min, máx e padrão do SKU.

tier
  • string

Nível de serviço do recurso SKU.

StatusOptions

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

Name Type Description
Creating
  • string
Pending
  • string
Ready
  • string