App Service Plans - Get

Deskripsi untuk Dapatkan paket App Service.

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

Parameter URI

Name In Required Type Description
name
path True
  • string

Nama paket App Service.

resourceGroupName
path True
  • string

Nama grup sumber daya tempat sumber daya berada.

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

subscriptionId
path True
  • string

ID langganan Azure Anda. Ini adalah string berformat GUID (misalnya 000000000-0000-0000-0000-000000000000).

api-version
query True
  • string

Versi API

Respons

Name Type Description
200 OK

OK.

404 Not Found

Tidak ditemukan.

Other Status Codes

App Service respons kesalahan.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

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

Definisi

AppServicePlan

Paket App Service.

Capability

Menjelaskan kemampuan/fitur yang diizinkan untuk SKU tertentu.

DefaultErrorResponse

App Service respons kesalahan.

Details
Error

Model kesalahan.

ExtendedLocation

Lokasi Yang Diperluas.

HostingEnvironmentProfile

Spesifikasi untuk Lingkungan App Service yang digunakan untuk sumber daya ini.

KubeEnvironmentProfile

Spesifikasi untuk Lingkungan Kubernetes yang akan digunakan untuk sumber daya ini.

ProvisioningState

Status penyediaan Paket App Service.

SkuCapacity

Deskripsi opsi skala paket App Service.

SkuDescription

Deskripsi SKU untuk sumber daya yang dapat diskalakan.

StatusOptions

App Service status paket.

AppServicePlan

Paket App Service.

Name Type Default Value Description
extendedLocation

Lokasi Yang Diperluas.

id
  • string

Id Sumber Daya.

kind
  • string

Jenis sumber daya.

location
  • string

Lokasi Sumber Daya.

name
  • string

Nama Sumber Daya.

properties.elasticScaleEnabled
  • boolean

ServerFarm mendukung ElasticScale. Aplikasi dalam paket ini akan menskalakan seolah-olah ServerFarm adalah sku ElasticPremium

properties.freeOfferExpirationTime
  • string

Waktu ketika penawaran gratis farm server kedaluwarsa.

properties.geoRegion
  • string

Lokasi geografis untuk paket App Service.

properties.hostingEnvironmentProfile

Spesifikasi untuk Lingkungan App Service yang digunakan untuk paket App Service.

properties.hyperV
  • boolean
False

Jika paket truelayanan aplikasi kontainer Hyper-V , false jika tidak.

properties.isSpot
  • boolean

Jika true, paket App Service ini memiliki instans spot.

properties.isXenon
  • boolean
False

Usang: Jika paket truelayanan aplikasi kontainer Hyper-V , false jika tidak.

properties.kubeEnvironmentProfile

Spesifikasi untuk Lingkungan Kubernetes yang akan digunakan untuk paket App Service.

properties.maximumElasticWorkerCount
  • integer

Jumlah maksimum total pekerja yang diizinkan untuk Paket App Service ElasticScaleEnabled ini

properties.maximumNumberOfWorkers
  • integer

Jumlah maksimum instans yang dapat ditetapkan ke paket App Service ini.

properties.numberOfSites
  • integer

Jumlah aplikasi yang ditetapkan ke paket App Service ini.

properties.numberOfWorkers
  • integer

Jumlah instans yang ditetapkan ke paket App Service ini.

properties.perSiteScaling
  • boolean
False

Jika true, aplikasi yang ditetapkan ke paket App Service ini dapat diskalakan secara independen. Jika false, aplikasi yang ditetapkan ke paket App Service ini akan menskalakan ke semua instans paket.

properties.provisioningState

Status penyediaan Paket App Service.

properties.reserved
  • boolean
False

Jika paket truelayanan aplikasi Linux , false jika tidak.

properties.resourceGroup
  • string

Grup sumber daya paket App Service.

properties.spotExpirationTime
  • string

Waktu ketika farm server kedaluwarsa. Valid hanya jika itu adalah farm server spot.

properties.status

App Service status paket.

properties.subscription
  • string

App Service langganan paket.

properties.targetWorkerCount
  • integer

Menskalakan jumlah pekerja.

properties.targetWorkerSizeId
  • integer

MENSKALAKAN ID ukuran pekerja.

properties.workerTierName
  • string

Tingkat pekerja target yang ditetapkan ke paket App Service.

properties.zoneRedundant
  • boolean
False

Jika true, Paket App Service ini akan melakukan penyeimbangan zona ketersediaan. Jika false, Paket App Service ini tidak akan melakukan penyeimbangan zona ketersediaan.

sku

Deskripsi SKU untuk sumber daya yang dapat diskalakan.

tags
  • object

Tag sumber daya.

type
  • string

Jenis sumber daya

Capability

Menjelaskan kemampuan/fitur yang diizinkan untuk SKU tertentu.

Name Type Description
name
  • string

Nama kemampuan SKU.

reason
  • string

Alasan kemampuan SKU.

value
  • string

Nilai kemampuan SKU.

DefaultErrorResponse

App Service respons kesalahan.

Name Type Description
error

Model kesalahan.

Details

Name Type Description
code
  • string

String standar untuk mengidentifikasi kesalahan secara terprogram.

message
  • string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

target
  • string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

Error

Model kesalahan.

Name Type Description
code
  • string

String standar untuk mengidentifikasi kesalahan secara terprogram.

details

Kesalahan terperinci.

innererror
  • string

Informasi selengkapnya untuk men-debug kesalahan.

message
  • string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

target
  • string

Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

ExtendedLocation

Lokasi Yang Diperluas.

Name Type Description
name
  • string

Nama lokasi yang diperluas.

type
  • string

Jenis lokasi yang diperluas.

HostingEnvironmentProfile

Spesifikasi untuk Lingkungan App Service yang digunakan untuk sumber daya ini.

Name Type Description
id
  • string

ID sumber daya lingkungan App Service.

name
  • string

Nama Lingkungan App Service.

type
  • string

Jenis sumber daya lingkungan App Service.

KubeEnvironmentProfile

Spesifikasi untuk Lingkungan Kubernetes yang akan digunakan untuk sumber daya ini.

Name Type Description
id
  • string

ID Sumber Daya Lingkungan Kubernetes.

name
  • string

Nama Lingkungan Kubernetes.

type
  • string

Jenis sumber daya Lingkungan Kubernetes.

ProvisioningState

Status penyediaan Paket App Service.

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

SkuCapacity

Deskripsi opsi skala paket App Service.

Name Type Description
default
  • integer

Jumlah default pekerja untuk SKU paket App Service ini.

elasticMaximum
  • integer

Jumlah maksimum pekerja Elastic untuk SKU paket App Service ini.

maximum
  • integer

Jumlah maksimum pekerja untuk SKU paket App Service ini.

minimum
  • integer

Jumlah minimum pekerja untuk SKU paket App Service ini.

scaleType
  • string

Konfigurasi skala yang tersedia untuk paket App Service.

SkuDescription

Deskripsi SKU untuk sumber daya yang dapat diskalakan.

Name Type Description
capabilities

Kemampuan SKU, misalnya, apakah traffic manager diaktifkan?

capacity
  • integer

Jumlah instans saat ini yang ditetapkan ke sumber daya.

family
  • string

Kode keluarga SKU sumber daya.

locations
  • string[]

Lokasi SKU.

name
  • string

Nama SKU sumber daya.

size
  • string

Penentu ukuran SKU sumber daya.

skuCapacity

Nilai skala min, maks, dan default SKU.

tier
  • string

Tingkat layanan SKU sumber daya.

StatusOptions

App Service status paket.

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