App Service Plans - Get

Riferimento

Service:: App Service

API Version:: 2023-12-01

Descrizione per Ottenere un piano di servizio app.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome del piano di servizio app.
resourceGroupName	path	True	string	Nome del gruppo di risorse a cui appartiene la risorsa. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	L'ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Versione API

Risposte

Nome	Tipo	Descrizione
200 OK	AppServicePlan	OK.
404 Not Found		Non trovato.
Other Status Codes	DefaultErrorResponse	servizio app risposta di errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AppServicePlan	Piano di servizio app.
Capability	Descrive le funzionalità/funzionalità consentite per uno SKU specifico.
DefaultErrorResponse	servizio app risposta di errore.
Details
Error	Modello di errore.
ExtendedLocation	Posizione estesa.
HostingEnvironmentProfile	Specifica per un ambiente del servizio app da usare per questa risorsa.
KubeEnvironmentProfile	Specifica per un ambiente Kubernetes da usare per questa risorsa.
ProvisioningState	Stato di provisioning del piano di servizio app.
SkuCapacity	Descrizione delle opzioni di scalabilità del piano servizio app.
SkuDescription	Descrizione di uno SKU per una risorsa scalabile.
StatusOptions	servizio app stato del piano.

AppServicePlan

Piano di servizio app.

Nome	Tipo	Valore predefinito	Descrizione
extendedLocation	ExtendedLocation		Posizione estesa.
id	string		ID risorsa.
kind	string		Tipo di risorsa.
location	string		Posizione risorsa.
name	string		Nome risorsa.
properties.elasticScaleEnabled	boolean		ServerFarm supporta ElasticScale. Le app in questo piano verranno ridimensionate come se serverFarm fosse uno SKU ElasticPremium
properties.freeOfferExpirationTime	string		Ora di scadenza dell'offerta gratuita della server farm.
properties.geoRegion	string		Posizione geografica per il piano di servizio app.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Specifica del ambiente del servizio app da usare per il piano di servizio app.
properties.hyperV	boolean	False	Se il piano `true`di servizio app contenitore Hyper-V è , `false` in caso contrario.
properties.isSpot	boolean		Se `true`, questo servizio app Plan è proprietario di istanze spot.
properties.isXenon	boolean	False	Obsoleto: se il piano `true`di servizio app contenitore Hyper-V è , `false` in caso contrario.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Specifica dell'ambiente Kubernetes da usare per il piano di servizio app.
properties.maximumElasticWorkerCount	integer		Numero massimo di ruoli di lavoro totali consentiti per questo piano di servizio app ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer		Numero massimo di istanze che è possibile assegnare a questo piano di servizio app.
properties.numberOfSites	integer		Numero di app assegnate a questo piano di servizio app.
properties.numberOfWorkers	integer		Numero di istanze assegnate a questo piano di servizio app.
properties.perSiteScaling	boolean	False	Se `true`, le app assegnate a questo piano servizio app possono essere ridimensionate in modo indipendente. Se `false`, le app assegnate a questo piano servizio app verranno ridimensionate a tutte le istanze del piano.
properties.provisioningState	ProvisioningState		Stato di provisioning del piano di servizio app.
properties.reserved	boolean	False	Se il piano `true`di servizio app Linux è , `false` in caso contrario.
properties.resourceGroup	string		Gruppo di risorse del piano di servizio app.
properties.spotExpirationTime	string		Ora di scadenza della server farm. Valido solo se si tratta di una server farm spot.
properties.status	StatusOptions		servizio app stato del piano.
properties.subscription	string		servizio app sottoscrizione del piano.
properties.targetWorkerCount	integer		Ridimensionamento del numero di ruoli di lavoro.
properties.targetWorkerSizeId	integer		Ridimensionamento dell'ID dimensione del ruolo di lavoro.
properties.workerTierName	string		Livello di lavoro di destinazione assegnato al piano di servizio app.
properties.zoneRedundant	boolean	False	Se `true`, questo servizio app Piano eseguirà il bilanciamento della zona di disponibilità. Se `false`, questo servizio app Piano non eseguirà il bilanciamento della zona di disponibilità.
sku	SkuDescription		Descrizione di uno SKU per una risorsa scalabile.
tags	object		Tag delle risorse.
type	string		Tipo di risorsa.

Capability

Descrive le funzionalità/funzionalità consentite per uno SKU specifico.

Nome	Tipo	Descrizione
name	string	Nome della funzionalità SKU.
reason	string	Motivo della funzionalità SKU.
value	string	Valore della funzionalità SKU.

DefaultErrorResponse

servizio app risposta di errore.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

Error

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
details	Details[]	Errori dettagliati.
innererror	string	Altre informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

ExtendedLocation

Posizione estesa.

Nome	Tipo	Descrizione
name	string	Nome della posizione estesa.
type	string	Tipo di posizione estesa.

HostingEnvironmentProfile

Specifica per un ambiente del servizio app da usare per questa risorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa del ambiente del servizio app.
name	string	Nome del ambiente del servizio app.
type	string	Tipo di risorsa del ambiente del servizio app.

KubeEnvironmentProfile

Specifica per un ambiente Kubernetes da usare per questa risorsa.

Nome	Tipo	Descrizione
id	string	ID risorsa dell'ambiente Kubernetes.
name	string	Nome dell'ambiente Kubernetes.
type	string	Tipo di risorsa dell'ambiente Kubernetes.

ProvisioningState

Stato di provisioning del piano di servizio app.

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

SkuCapacity

Descrizione delle opzioni di scalabilità del piano servizio app.

Nome	Tipo	Descrizione
default	integer	Numero predefinito di ruoli di lavoro per questo SKU del piano servizio app.
elasticMaximum	integer	Numero massimo di ruoli di lavoro elastici per questo SKU del piano servizio app.
maximum	integer	Numero massimo di ruoli di lavoro per questo SKU del piano servizio app.
minimum	integer	Numero minimo di ruoli di lavoro per questo SKU del piano servizio app.
scaleType	string	Configurazioni di scalabilità disponibili per un piano di servizio app.

SkuDescription

Descrizione di uno SKU per una risorsa scalabile.

Nome	Tipo	Descrizione
capabilities	Capability[]	Le funzionalità dello SKU, ad esempio Gestione traffico è abilitata?
capacity	integer	Numero corrente di istanze assegnate alla risorsa.
family	string	Codice della famiglia dello SKU della risorsa.
locations	string[]	Posizioni dello SKU.
name	string	Nome dello SKU della risorsa.
size	string	Identificatore di dimensioni dello SKU della risorsa.
skuCapacity	SkuCapacity	Valori di scala min, max e default dello SKU.
tier	string	Livello di servizio dello SKU della risorsa.

StatusOptions

servizio app stato del piano.

Nome	Tipo	Descrizione
Creating	string
Pending	string
Ready	string