Compartir a través de


App Service Plans - Get

Descripción para Obtener un plan de App Service.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
name
path True

string

Nombre del plan de App Service.

resourceGroupName
path True

string

Nombre del grupo de recursos al que pertenece el recurso.

Patrón de Regex: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-00000000000000).

api-version
query True

string

Versión de la API

Respuestas

Nombre Tipo Description
200 OK

AppServicePlan

Aceptar.

404 Not Found

Not found.

Other Status Codes

DefaultErrorResponse

App Service respuesta de error.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

Get App Service plan

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AppServicePlan

Plan de App Service.

Capability

Describe las funcionalidades y características permitidas para una SKU específica.

DefaultErrorResponse

App Service respuesta de error.

Details
Error

Modelo de error.

ExtendedLocation

Ubicación extendida.

HostingEnvironmentProfile

Especificación de un App Service Environment que se va a usar para este recurso.

KubeEnvironmentProfile

Especificación de un entorno de Kubernetes que se va a usar para este recurso.

ProvisioningState

Estado de aprovisionamiento del plan de App Service.

SkuCapacity

Descripción de las opciones de escalado del plan de App Service.

SkuDescription

Descripción de una SKU para un recurso escalable.

StatusOptions

App Service estado del plan.

AppServicePlan

Plan de App Service.

Nombre Tipo Valor predeterminado Description
extendedLocation

ExtendedLocation

Ubicación extendida.

id

string

Id. de recurso.

kind

string

Tipo de recurso.

location

string

Ubicación del recurso.

name

string

Nombre del recurso.

properties.elasticScaleEnabled

boolean

ServerFarm admite ElasticScale. Las aplicaciones de este plan se escalarán como si serverFarm fuera la SKU elasticPremium.

properties.freeOfferExpirationTime

string

Hora a la que expira la oferta gratuita de la granja de servidores.

properties.geoRegion

string

Ubicación geográfica del plan de App Service.

properties.hostingEnvironmentProfile

HostingEnvironmentProfile

Especificación del App Service Environment que se va a usar para el plan de App Service.

properties.hyperV

boolean

False

Si el plan truede App Service de contenedor de Hyper-V es , false en caso contrario.

properties.isSpot

boolean

Si truees , este App Service Plan posee instancias de acceso puntual.

properties.isXenon

boolean

False

Obsoleto: si el plan truede App Service de contenedor de Hyper-V es , false en caso contrario.

properties.kubeEnvironmentProfile

KubeEnvironmentProfile

Especificación del entorno de Kubernetes que se va a usar para el plan de App Service.

properties.maximumElasticWorkerCount

integer

Número máximo de trabajos totales permitidos para este plan de App Service ElasticScaleEnabled

properties.maximumNumberOfWorkers

integer

Número máximo de instancias que se pueden asignar a este plan de App Service.

properties.numberOfSites

integer

Número de aplicaciones asignadas a este plan de App Service.

properties.numberOfWorkers

integer

Número de instancias asignadas a este plan de App Service.

properties.perSiteScaling

boolean

False

Si truees , las aplicaciones asignadas a este plan de App Service se pueden escalar de forma independiente. Si falsees , las aplicaciones asignadas a este plan App Service escalarán a todas las instancias del plan.

properties.provisioningState

ProvisioningState

Estado de aprovisionamiento del plan de App Service.

properties.reserved

boolean

False

Si el plan truede App Service de Linux es , false en caso contrario.

properties.resourceGroup

string

Grupo de recursos del plan de App Service.

properties.spotExpirationTime

string

Hora a la que expira la granja de servidores. Válido solo si es una granja de servidores de acceso puntual.

properties.status

StatusOptions

App Service estado del plan.

properties.subscription

string

App Service suscripción del plan.

properties.targetWorkerCount

integer

Escalado del recuento de trabajos.

properties.targetWorkerSizeId

integer

Id. de tamaño de trabajo de escalado.

properties.workerTierName

string

Nivel de trabajo de destino asignado al plan de App Service.

properties.zoneRedundant

boolean

False

Si truees , este plan de App Service realizará el equilibrio de zona de disponibilidad. Si falsees , este plan de App Service no realizará el equilibrio de zona de disponibilidad.

sku

SkuDescription

Descripción de una SKU para un recurso escalable.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso.

Capability

Describe las funcionalidades y características permitidas para una SKU específica.

Nombre Tipo Description
name

string

Nombre de la funcionalidad de SKU.

reason

string

Motivo de la funcionalidad de SKU.

value

string

Valor de la funcionalidad de SKU.

DefaultErrorResponse

App Service respuesta de error.

Nombre Tipo Description
error

Error

Modelo de error.

Details

Nombre Tipo Description
code

string

Cadena estandarizada para identificar mediante programación el error.

message

string

Descripción detallada del error e información de depuración.

target

string

Descripción detallada del error e información de depuración.

Error

Modelo de error.

Nombre Tipo Description
code

string

Cadena estandarizada para identificar mediante programación el error.

details

Details[]

Errores detallados.

innererror

string

Más información para depurar el error.

message

string

Descripción detallada del error e información de depuración.

target

string

Descripción detallada del error e información de depuración.

ExtendedLocation

Ubicación extendida.

Nombre Tipo Description
name

string

Nombre de la ubicación extendida.

type

string

Tipo de ubicación extendida.

HostingEnvironmentProfile

Especificación de un App Service Environment que se va a usar para este recurso.

Nombre Tipo Description
id

string

Identificador de recurso del App Service Environment.

name

string

Nombre del App Service Environment.

type

string

Tipo de recurso del App Service Environment.

KubeEnvironmentProfile

Especificación de un entorno de Kubernetes que se va a usar para este recurso.

Nombre Tipo Description
id

string

Identificador de recurso del entorno de Kubernetes.

name

string

Nombre del entorno de Kubernetes.

type

string

Tipo de recurso del entorno de Kubernetes.

ProvisioningState

Estado de aprovisionamiento del plan de App Service.

Nombre Tipo Description
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

SkuCapacity

Descripción de las opciones de escalado del plan de App Service.

Nombre Tipo Description
default

integer

Número predeterminado de trabajos para esta SKU de plan de App Service.

elasticMaximum

integer

Número máximo de trabajos elásticos para esta SKU de plan de App Service.

maximum

integer

Número máximo de trabajos para esta SKU de plan de App Service.

minimum

integer

Número mínimo de trabajos para esta SKU de plan de App Service.

scaleType

string

Configuraciones de escala disponibles para un plan de App Service.

SkuDescription

Descripción de una SKU para un recurso escalable.

Nombre Tipo Description
capabilities

Capability[]

¿Las funcionalidades de la SKU, por ejemplo, están habilitadas para Traffic Manager?

capacity

integer

Número actual de instancias asignadas al recurso.

family

string

Código de familia de la SKU de recursos.

locations

string[]

Ubicaciones de la SKU.

name

string

Nombre de la SKU del recurso.

size

string

Especificador de tamaño de la SKU de recursos.

skuCapacity

SkuCapacity

Valores de escala mínimo, máximo y predeterminado de la SKU.

tier

string

Nivel de servicio de la SKU de recursos.

StatusOptions

App Service estado del plan.

Nombre Tipo Description
Creating

string

Pending

string

Ready

string