App Service Plans - Get

Opis pobierania planu App Service.

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

Parametry identyfikatora URI

Name In Required Type Description
name
path True
  • string

Nazwa planu usługi App Service.

resourceGroupName
path True
  • string

Nazwa grupy zasobów, do której należy zasób.

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

subscriptionId
path True
  • string

Identyfikator subskrypcji platformy Azure. Jest to ciąg sformatowany przez identyfikator GUID (np. 00000000-0000-0000-0000-00000000000000000000000000000000000000000000000000 00000).

api-version
query True
  • string

Wersja interfejsu API

Odpowiedzi

Name Type Description
200 OK

OK.

404 Not Found

Nie znaleziono.

Other Status Codes

App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Name Description
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

AppServicePlan

App Service plan.

Capability

Opisuje możliwości/funkcje dozwolone dla określonej jednostki SKU.

DefaultErrorResponse

App Service odpowiedź na błąd.

Details
Error

Model błędu.

ExtendedLocation

Lokalizacja rozszerzona.

HostingEnvironmentProfile

Specyfikacja App Service Environment do użycia dla tego zasobu.

KubeEnvironmentProfile

Specyfikacja środowiska Kubernetes do użycia dla tego zasobu.

ProvisioningState

Stan aprowizacji planu App Service.

SkuCapacity

Opis opcji skalowania planu App Service.

SkuDescription

Opis jednostki SKU dla skalowalnego zasobu.

StatusOptions

App Service stan planu.

AppServicePlan

App Service plan.

Name Type Default Value Description
extendedLocation

Lokalizacja rozszerzona.

id
  • string

Identyfikator zasobu.

kind
  • string

Rodzaj zasobu.

location
  • string

Lokalizacja zasobu.

name
  • string

Nazwa zasobu.

properties.elasticScaleEnabled
  • boolean

Narzędzie ServerFarm obsługuje usługę ElasticScale. Aplikacje w tym planie będą skalowane tak, jakby serwerFarm był jednostka SKU ElasticPremium

properties.freeOfferExpirationTime
  • string

Czas wygaśnięcia bezpłatnej oferty farmy serwerów.

properties.geoRegion
  • string

Lokalizacja geograficzna planu App Service.

properties.hostingEnvironmentProfile

Specyfikacja App Service Environment do użycia dla planu App Service.

properties.hyperV
  • boolean
False

Jeśli plan trueusługi App Service kontenera funkcji Hyper-V , false w przeciwnym razie.

properties.isSpot
  • boolean

Jeśli trueta App Service Plan jest właścicielem wystąpień typu spot.

properties.isXenon
  • boolean
False

Przestarzałe: jeśli plan trueusługi App Service kontenera funkcji Hyper-V , false w przeciwnym razie.

properties.kubeEnvironmentProfile

Specyfikacja środowiska Kubernetes do użycia dla planu App Service.

properties.maximumElasticWorkerCount
  • integer

Maksymalna liczba całkowitych procesów roboczych dozwolonych dla tego planu ElasticScaleEnabled App Service

properties.maximumNumberOfWorkers
  • integer

Maksymalna liczba wystąpień, które można przypisać do tego planu App Service.

properties.numberOfSites
  • integer

Liczba aplikacji przypisanych do tego planu App Service.

properties.numberOfWorkers
  • integer

Liczba wystąpień przypisanych do tego planu App Service.

properties.perSiteScaling
  • boolean
False

Jeśli trueaplikacje przypisane do tego planu App Service można skalować niezależnie. W przypadku falseprogramu aplikacje przypisane do tego planu App Service będą skalowane do wszystkich wystąpień planu.

properties.provisioningState

Stan aprowizacji planu App Service.

properties.reserved
  • boolean
False

Jeśli plan trueusługi App Service systemu Linux , false w przeciwnym razie.

properties.resourceGroup
  • string

Grupa zasobów planu App Service.

properties.spotExpirationTime
  • string

Czas wygaśnięcia farmy serwerów. Prawidłowe tylko wtedy, gdy jest to farma serwerów typu spot.

properties.status

App Service stan planu.

properties.subscription
  • string

App Service subskrypcji planu.

properties.targetWorkerCount
  • integer

Liczba procesów roboczych skalowania.

properties.targetWorkerSizeId
  • integer

Identyfikator rozmiaru procesu roboczego skalowania.

properties.workerTierName
  • string

Docelowa warstwa procesu roboczego przypisana do planu App Service.

properties.zoneRedundant
  • boolean
False

Jeśli trueta App Service plan wykona równoważenie strefy dostępności. Jeśli falseta App Service plan nie będzie wykonywać równoważenia strefy dostępności.

sku

Opis jednostki SKU dla skalowalnego zasobu.

tags
  • object

Tagi zasobów.

type
  • string

Typ zasobu.

Capability

Opisuje możliwości/funkcje dozwolone dla określonej jednostki SKU.

Name Type Description
name
  • string

Nazwa możliwości jednostki SKU.

reason
  • string

Przyczyna możliwości jednostki SKU.

value
  • string

Wartość możliwości jednostki SKU.

DefaultErrorResponse

App Service odpowiedź na błąd.

Name Type Description
error

Model błędu.

Details

Name Type Description
code
  • string

Ustandaryzowany ciąg w celu programowego identyfikowania błędu.

message
  • string

Szczegółowy opis błędu i informacje o debugowaniu.

target
  • string

Szczegółowy opis błędu i informacje o debugowaniu.

Error

Model błędu.

Name Type Description
code
  • string

Ustandaryzowany ciąg w celu programowego identyfikowania błędu.

details

Szczegółowe błędy.

innererror
  • string

Więcej informacji na temat błędu debugowania.

message
  • string

Szczegółowy opis błędu i informacje o debugowaniu.

target
  • string

Szczegółowy opis błędu i informacje o debugowaniu.

ExtendedLocation

Lokalizacja rozszerzona.

Name Type Description
name
  • string

Nazwa lokalizacji rozszerzonej.

type
  • string

Typ lokalizacji rozszerzonej.

HostingEnvironmentProfile

Specyfikacja App Service Environment do użycia dla tego zasobu.

Name Type Description
id
  • string

Identyfikator zasobu App Service Environment.

name
  • string

Nazwa App Service Environment.

type
  • string

Typ zasobu App Service Environment.

KubeEnvironmentProfile

Specyfikacja środowiska Kubernetes do użycia dla tego zasobu.

Name Type Description
id
  • string

Identyfikator zasobu środowiska Kubernetes.

name
  • string

Nazwa środowiska Kubernetes.

type
  • string

Typ zasobu środowiska Kubernetes.

ProvisioningState

Stan aprowizacji planu App Service.

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

SkuCapacity

Opis opcji skalowania planu App Service.

Name Type Description
default
  • integer

Domyślna liczba procesów roboczych dla tej jednostki SKU planu App Service.

elasticMaximum
  • integer

Maksymalna liczba elastycznych procesów roboczych dla tej jednostki SKU planu App Service.

maximum
  • integer

Maksymalna liczba procesów roboczych dla tej jednostki SKU planu App Service.

minimum
  • integer

Minimalna liczba procesów roboczych dla tej jednostki SKU planu App Service.

scaleType
  • string

Dostępne konfiguracje skalowania dla planu App Service.

SkuDescription

Opis jednostki SKU dla skalowalnego zasobu.

Name Type Description
capabilities

Możliwości jednostki SKU, np. czy usługa Traffic Manager jest włączona?

capacity
  • integer

Bieżąca liczba wystąpień przypisanych do zasobu.

family
  • string

Kod rodziny jednostki SKU zasobu.

locations
  • string[]

Lokalizacje jednostki SKU.

name
  • string

Nazwa jednostki SKU zasobu.

size
  • string

Specyfikator rozmiaru jednostki SKU zasobu.

skuCapacity

Minimalne, maksymalne i domyślne wartości skalowania jednostki SKU.

tier
  • string

Warstwa usługi jednostki SKU zasobu.

StatusOptions

App Service stan planu.

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