App Service Plans - Get

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=2019-08-01

Parâmetros de URI

Name In Required Type 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. Essa é uma cadeia de caracteres formatada em GUID (por exemplo, 000000000-0000-0000-0000-0000000000000).

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

Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Azure Active Directory fluxo OAuth2

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

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=2019-08-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,
    "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

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.

HostingEnvironmentProfile

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

ProvisioningState

Estado de provisionamento do Ambiente do 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 escalonável.

StatusOptions

Status do plano do Serviço de Aplicativo.

AppServicePlan

Plano do Serviço de Aplicativo.

Name Type Description
id
  • string

ID do recurso.

kind
  • string

Tipo de recurso.

location
  • string

Local do recurso.

name
  • string

Nome do recurso.

properties.freeOfferExpirationTime
  • string

A hora 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

Especificação do Ambiente do Serviço de Aplicativo a ser usado para o plano do Serviço de Aplicativo.

properties.hyperV
  • boolean

Se o plano do serviço de aplicativo de contêiner do Hyper-V true for , false caso contrário, .

properties.isSpot
  • boolean

Se true , esse Plano do Serviço de Aplicativo possui instâncias spot.

properties.isXenon
  • boolean

Obsoleto: se o plano do serviço de aplicativo de contêiner do Hyper-V true for , false caso contrário, .

properties.maximumElasticWorkerCount
  • integer

Número máximo de trabalhadores totais permitidos para este Plano do Serviço de Aplicativo ElasticScaleEnabled

properties.maximumNumberOfWorkers
  • integer

Número máximo de instâncias que podem ser atribuídas a este plano do Serviço de Aplicativo.

properties.numberOfSites
  • integer

Número de aplicativos atribuídos a este plano do Serviço de Aplicativo.

properties.perSiteScaling
  • boolean

Se true , os aplicativos atribuídos a esse plano do Serviço de Aplicativo poderão ser dimensionados de forma independente. Se false , os aplicativos atribuídos a esse Plano do Serviço de Aplicativo serão dimensionados para todas as instâncias do plano.

properties.provisioningState

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

properties.reserved
  • boolean

Se o plano do serviço de aplicativo Linux true for , false caso contrário, .

properties.resourceGroup
  • string

Grupo de recursos do plano do 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

Status do plano do Serviço de Aplicativo.

properties.subscription
  • string

Assinatura do Plano do Serviço de Aplicativo.

properties.targetWorkerCount
  • integer

Dimensionamento da contagem de trabalho.

properties.targetWorkerSizeId
  • integer

Dimensionamento da ID do tamanho do trabalho.

properties.workerTierName
  • string

Camada de trabalho de destino atribuída ao plano do Serviço de Aplicativo.

sku

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

tags
  • object

Marcas de recurso.

type
  • string

Tipo de recurso.

Capability

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

Name Type Description
name
  • string

Nome da funcionalidade de SKU.

reason
  • string

Motivo da funcionalidade de SKU.

value
  • string

Valor da funcionalidade de SKU.

DefaultErrorResponse

Resposta de erro do Serviço de Aplicativo.

Name Type Description
error

Modelo de erro.

Details

Name Type Description
code
  • string

Cadeia de caracteres padronizada para identificar o erro programaticamente.

message
  • string

Informações detalhadas de depuração e descrição de erros.

target
  • string

Informações detalhadas de depuração e descrição de erros.

Error

Modelo de erro.

Name Type Description
code
  • string

Cadeia de caracteres padronizada para identificar o erro programaticamente.

details

Erros detalhados.

innererror
  • string

Mais informações para depurar o erro.

message
  • string

Informações detalhadas de depuração e descrição de erros.

target
  • string

Informações detalhadas de depuração e descrição de erros.

HostingEnvironmentProfile

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

Name Type Description
id
  • string

ID do recurso do Ambiente do Serviço de Aplicativo.

name
  • string

Nome da Ambiente do Serviço de Aplicativo.

type
  • string

Tipo de recurso do Ambiente do Serviço de Aplicativo.

ProvisioningState

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

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

SkuCapacity

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

Name Type Description
default
  • integer

Número padrão de trabalhadores para essa SKU do Plano do Serviço de Aplicativo.

maximum
  • integer

Número máximo de trabalhadores para essa SKU do Plano do Serviço de Aplicativo.

minimum
  • integer

Número mínimo de trabalhadores para essa 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

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

Name Type Description
capabilities

As funcionalidades da SKU, por exemplo, estão habilitadas para o gerenciador de tráfego?

capacity
  • integer

Número atual de instâncias atribuídas ao recurso.

family
  • string

Código de família do SKU do recurso.

locations
  • string[]

Locais da SKU.

name
  • string

Nome do SKU do recurso.

size
  • string

Especificador de tamanho do SKU do recurso.

skuCapacity

Valores de escala mínimo, máximo e padrão do SKU.

tier
  • string

Camada de serviço do SKU do recurso.

StatusOptions

Status do plano do Serviço de Aplicativo.

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