App Service Plans - Get

Popis získání plánu App Service

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

Parametry identifikátoru URI

Name In Required Type Description
name
path True
  • string

Název plánu služby App Service.

resourceGroupName
path True
  • string

Název skupiny prostředků, do které prostředek patří.

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

subscriptionId
path True
  • string

ID vašeho předplatného Azure Jedná se o řetězec formátovaný identifikátorem GUID (např. 00000000-0000-0000-0000-000000000000000).

api-version
query True
  • string

Verze rozhraní API

Odpovědi

Name Type Description
200 OK

OK.

404 Not Found

Nenalezena.

Other Status Codes

App Service chybovou odpověď.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

Definice

AppServicePlan

App Service plán.

Capability

Popisuje možnosti a funkce povolené pro konkrétní skladovou položku.

DefaultErrorResponse

App Service chybovou odpověď.

Details
Error

Model chyby.

ExtendedLocation

Rozšířené umístění.

HostingEnvironmentProfile

Specifikace App Service Environment pro tento prostředek.

KubeEnvironmentProfile

Specifikace pro prostředí Kubernetes, které se má pro tento prostředek použít.

ProvisioningState

Stav zřizování plánu App Service

SkuCapacity

Popis možností škálování plánu App Service

SkuDescription

Popis skladové položky pro škálovatelný prostředek

StatusOptions

App Service stav plánu.

AppServicePlan

App Service plán.

Name Type Default Value Description
extendedLocation

Rozšířené umístění.

id
  • string

ID prostředku.

kind
  • string

Druh prostředku.

location
  • string

Umístění prostředku.

name
  • string

Název prostředku.

properties.elasticScaleEnabled
  • boolean

ServerFarm podporuje ElasticScale. Aplikace v tomto plánu se budou škálovat, jako by serverFarm byl skladová položka ElasticPremium.

properties.freeOfferExpirationTime
  • string

Čas, kdy vyprší platnost bezplatné nabídky serverové farmy.

properties.geoRegion
  • string

Zeměpisné umístění plánu App Service

properties.hostingEnvironmentProfile

Specifikace App Service Environment, která se má použít pro plán App Service.

properties.hyperV
  • boolean
False

Pokud je plán trueslužby App Service kontejneru Hyper-V , false jinak.

properties.isSpot
  • boolean

Pokud truetato App Service Plan vlastní spotové instance.

properties.isXenon
  • boolean
False

Zastaralé: Pokud je plán trueslužby App Service kontejneru Hyper-V , false jinak.

properties.kubeEnvironmentProfile

Specifikace pro prostředí Kubernetes, která se má použít pro plán App Service

properties.maximumElasticWorkerCount
  • integer

Maximální počet pracovních procesů povolených pro tento plán ElasticScaleEnabled App Service

properties.maximumNumberOfWorkers
  • integer

Maximální počet instancí, které lze přiřadit k tomuto plánu App Service.

properties.numberOfSites
  • integer

Počet aplikací přiřazených k tomuto plánu App Service

properties.numberOfWorkers
  • integer

Počet instancí přiřazených k tomuto plánu App Service.

properties.perSiteScaling
  • boolean
False

Pokud trueje možné nezávisle škálovat aplikace přiřazené k tomuto plánu App Service. Pokud falsese aplikace přiřazené k tomuto plánu App Service škálují na všechny instance plánu.

properties.provisioningState

Stav zřizování plánu App Service

properties.reserved
  • boolean
False

Pokud plán trueslužby App Service pro Linux , false jinak.

properties.resourceGroup
  • string

Skupina prostředků plánu App Service

properties.spotExpirationTime
  • string

Čas vypršení platnosti serverové farmy Platné pouze v případě, že se jedná o spotovou serverovou farmu.

properties.status

App Service stav plánu.

properties.subscription
  • string

App Service předplatné plánu.

properties.targetWorkerCount
  • integer

Škálování počtu pracovních procesů

properties.targetWorkerSizeId
  • integer

ID velikosti pracovního procesu

properties.workerTierName
  • string

Cílová úroveň pracovního procesu přiřazená plánu App Service

properties.zoneRedundant
  • boolean
False

Pokud truebude tento plán App Service provádět vyrovnávání zóny dostupnosti. Pokud falsetento plán App Service nebude provádět vyrovnávání zóny dostupnosti.

sku

Popis skladové položky pro škálovatelný prostředek

tags
  • object

Značky prostředků

type
  • string

Typ prostředku.

Capability

Popisuje možnosti a funkce povolené pro konkrétní skladovou položku.

Name Type Description
name
  • string

Název možnosti skladové položky.

reason
  • string

Důvod schopnosti skladové položky.

value
  • string

Hodnota funkce skladové položky.

DefaultErrorResponse

App Service chybovou odpověď.

Name Type Description
error

Model chyby.

Details

Name Type Description
code
  • string

Standardizovaný řetězec pro programovou identifikaci chyby

message
  • string

Podrobný popis chyby a informace o ladění

target
  • string

Podrobný popis chyby a informace o ladění

Error

Model chyby.

Name Type Description
code
  • string

Standardizovaný řetězec pro programovou identifikaci chyby

details

Podrobné chyby.

innererror
  • string

Další informace o ladění chyby

message
  • string

Podrobný popis chyby a informace o ladění

target
  • string

Podrobný popis chyby a informace o ladění

ExtendedLocation

Rozšířené umístění.

Name Type Description
name
  • string

Název rozšířeného umístění

type
  • string

Typ rozšířeného umístění.

HostingEnvironmentProfile

Specifikace App Service Environment pro tento prostředek.

Name Type Description
id
  • string

ID prostředku App Service Environment

name
  • string

Název App Service Environment.

type
  • string

Typ prostředku App Service Environment

KubeEnvironmentProfile

Specifikace pro prostředí Kubernetes, které se má pro tento prostředek použít.

Name Type Description
id
  • string

ID prostředku prostředí Kubernetes

name
  • string

Název prostředí Kubernetes.

type
  • string

Typ prostředku prostředí Kubernetes

ProvisioningState

Stav zřizování plánu App Service

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

SkuCapacity

Popis možností škálování plánu App Service

Name Type Description
default
  • integer

Výchozí počet pracovních procesů pro tuto skladovou položku plánu App Service

elasticMaximum
  • integer

Maximální počet elastických pracovních procesů pro tuto skladovou položku plánu App Service

maximum
  • integer

Maximální počet pracovních procesů pro tuto skladovou položku plánu App Service

minimum
  • integer

Minimální počet pracovních procesů pro tuto skladovou položku plánu App Service.

scaleType
  • string

Dostupné konfigurace škálování pro plán App Service

SkuDescription

Popis skladové položky pro škálovatelný prostředek

Name Type Description
capabilities

Jsou povolené možnosti skladové položky, například Traffic Manager?

capacity
  • integer

Aktuální počet instancí přiřazených k prostředku

family
  • string

Kód řady skladové položky prostředku.

locations
  • string[]

Umístění skladové položky.

name
  • string

Název skladové položky prostředku.

size
  • string

Specifikátor velikosti skladové položky prostředku

skuCapacity

Minimální, maximální a výchozí hodnoty škálování skladové položky.

tier
  • string

Úroveň služby skladové položky prostředku

StatusOptions

App Service stav plánu.

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