App Service Plans - Get

Layanan:: App Service

Versi API:: 2025-05-01

Deskripsi untuk Mendapatkan paket App Service.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
name	path	True	string	Nama paket App Service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	AppServicePlan	Operasi Azure berhasil diselesaikan.
404 Not Found		Server tidak dapat menemukan sumber daya yang diminta.
Other Status Codes	DefaultErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get App Service plan

Permintaan sampel

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


/**
 * Samples for AppServicePlans GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/GetAppServicePlan.json
     */
    /**
     * Sample code: Get App Service plan.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void getAppServicePlan(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getAppServicePlans().getByResourceGroupWithResponse("testrg123", "testsf6141",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/GetAppServicePlan.json
func ExamplePlansClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPlansClient().Get(ctx, "testrg123", "testsf6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.PlansClientGetResponse{
	// 	Plan: &armappservice.Plan{
	// 		Name: to.Ptr("testsf6141"),
	// 		Type: to.Ptr("Microsoft.Web/serverfarms"),
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141"),
	// 		Kind: to.Ptr("app"),
	// 		Location: to.Ptr("East US"),
	// 		Properties: &armappservice.PlanProperties{
	// 			GeoRegion: to.Ptr("East US"),
	// 			IsSpot: to.Ptr(false),
	// 			MaximumNumberOfWorkers: to.Ptr[int32](20),
	// 			NumberOfSites: to.Ptr[int32](4),
	// 			NumberOfWorkers: to.Ptr[int32](19),
	// 			ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
	// 			Reserved: to.Ptr(false),
	// 			Status: to.Ptr(armappservice.StatusOptionsReady),
	// 			TargetWorkerCount: to.Ptr[int32](0),
	// 			TargetWorkerSizeID: to.Ptr[int32](0),
	// 		},
	// 		SKU: &armappservice.SKUDescription{
	// 			Name: to.Ptr("P1"),
	// 			Capacity: to.Ptr[int32](1),
	// 			Family: to.Ptr("P"),
	// 			Size: to.Ptr("P1"),
	// 			Tier: to.Ptr("Premium"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:: 200

{
  "name": "testsf6141",
  "type": "Microsoft.Web/serverfarms",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
  "kind": "app",
  "location": "East US",
  "properties": {
    "geoRegion": "East US",
    "isSpot": false,
    "maximumNumberOfWorkers": 20,
    "numberOfSites": 4,
    "numberOfWorkers": 19,
    "provisioningState": "Succeeded",
    "reserved": false,
    "status": "Ready",
    "targetWorkerCount": 0,
    "targetWorkerSizeId": 0
  },
  "sku": {
    "name": "P1",
    "capacity": 1,
    "family": "P",
    "size": "P1",
    "tier": "Premium"
  }
}

Kode status:: 404

Definisi

Nama	Deskripsi
AppServicePlan	Paket Azure App Service.
Capability	Menjelaskan kemampuan/fitur yang diizinkan untuk SKU tertentu.
createdByType	Jenis identitas yang membuat sumber daya.
DefaultErrorResponse	Respons kesalahan App Service.
DefaultErrorResponseError	Model kesalahan.
DefaultErrorResponseErrorDetailsItem	Kesalahan terperinci.
DefaultIdentity
ExtendedLocation	Lokasi yang Diperluas.
HostingEnvironmentProfile	Spesifikasi untuk Lingkungan App Service yang akan digunakan untuk sumber daya ini.
InstallScript	Konfigurasi skrip instalasi ladang server.
InstallScriptSource	Objek untuk menahan referensi skrip instal.
InstallScriptType	Jenis skrip instal.
KeyVaultReferenceWithStatus	Objek untuk menyimpan referensi brankas kunci dan status resolusi
KubeEnvironmentProfile	Spesifikasi untuk Lingkungan Kubernetes yang akan digunakan untuk sumber daya ini.
ManagedServiceIdentity	Identitas layanan terkelola.
ManagedServiceIdentityType	Jenis identitas layanan terkelola.
ProvisioningState	Status provisi Paket App Service.
RegistryAdapter	Konfigurasi adaptor registri ladang server.
RegistryAdapterType	Jenis adaptor registri.
ServerFarmNetworkSettings	Pengaturan jaringan untuk paket layanan aplikasi.
SkuCapacity	Deskripsi opsi skala paket App Service.
SkuDescription	Deskripsi SKU untuk sumber daya yang dapat diskalakan.
StatusOptions	Status paket App Service.
StorageMount	Konfigurasi pemasangan penyimpanan farm server.
StorageMountType	Jenis dudukan penyimpanan.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserAssignedIdentity	Identitas yang ditetapkan pengguna.

AppServicePlan

Objek

Paket Azure App Service.

Nama	Jenis	Deskripsi
extendedLocation	ExtendedLocation	Lokasi yang Diperluas.
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identitas layanan terkelola.
kind	string	Jenis sumber daya. Jika sumber daya adalah aplikasi, Anda dapat merujuk ke https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference untuk detail nilai yang didukung untuk jenisnya.
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.asyncScalingEnabled	boolean	Jika `true`, Paket App Service ini akan mencoba menskalakan secara asinkron jika tidak ada cukup pekerja untuk menskalakan secara sinkron. Jika `false`, Paket App Service ini hanya akan mencoba penskalaan sinkronisasi.
properties.elasticScaleEnabled	boolean	ServerFarm mendukung ElasticScale. Aplikasi dalam paket ini akan menskalakan seolah-olah ServerFarm adalah sku ElasticPremium
properties.freeOfferExpirationTime	string (date-time)	Waktu ketika penawaran gratis farm server kedaluwarsa.
properties.geoRegion	string	Lokasi geografis untuk paket App Service.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Spesifikasi untuk Lingkungan App Service yang akan digunakan untuk paket App Service.
properties.hyperV	boolean	Jika Hyper-V paket `true`layanan aplikasi kontainer , `false` jika tidak.
properties.installScripts	InstallScript[]	Instal skrip yang terkait dengan paket App Service ini.
properties.isCustomMode	boolean	Apakah farm server ini dalam mode kustom.
properties.isSpot	boolean	Jika `true`, Paket App Service ini memiliki instans spot.
properties.isXenon	boolean	Usang: Jika Hyper-V paket `true`layanan aplikasi kontainer , `false` jika tidak.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile	Spesifikasi untuk Lingkungan Kubernetes yang akan digunakan untuk paket App Service.
properties.maximumElasticWorkerCount	integer (int32)	Jumlah maksimum total pekerja yang diizinkan untuk Paket App Service ElasticScaleEnabled ini
properties.maximumNumberOfWorkers	integer (int32)	Jumlah maksimum instans yang dapat ditetapkan ke paket App Service ini.
properties.network	ServerFarmNetworkSettings	Semua pengaturan jaringan untuk farm server.
properties.numberOfSites	integer (int32)	Jumlah aplikasi yang ditetapkan ke paket App Service ini.
properties.numberOfWorkers	integer (int32)	Jumlah instans yang ditetapkan ke paket App Service ini.
properties.perSiteScaling	boolean	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.planDefaultIdentity	DefaultIdentity	Identitas untuk digunakan oleh platform untuk berbagai fitur dan integrasi menggunakan identitas terkelola.
properties.provisioningState	ProvisioningState	Status provisi Paket App Service.
properties.rdpEnabled	boolean	Jika `true`, akses RDP diaktifkan untuk paket App Service ini. Hanya berlaku untuk ASP IsCustomMode. Jika `false`, akses RDP dinonaktifkan.
properties.registryAdapters	RegistryAdapter[]	Adaptor registri yang terkait dengan paket App Service ini.
properties.reserved	boolean	Jika paket `true`layanan aplikasi Linux , `false` jika tidak.
properties.resourceGroup	string	Grup sumber daya paket App Service.
properties.spotExpirationTime	string (date-time)	Waktu ketika farm server kedaluwarsa. Valid hanya jika ini adalah farm server spot.
properties.status	StatusOptions	Status paket App Service.
properties.storageMounts	StorageMount[]	Dudukan penyimpanan yang terkait dengan paket App Service ini.
properties.subscription	string	Langganan paket App Service.
properties.targetWorkerCount	integer (int32)	Menskalakan jumlah pekerja.
properties.targetWorkerSizeId	integer (int32)	MENSKALAKAN ID ukuran pekerja.
properties.workerTierName	string	Tingkat pekerja target yang ditetapkan ke paket App Service.
properties.zoneRedundant	boolean	Jika `true`, Paket App Service ini akan melakukan penyeimbangan zona ketersediaan. Jika `false`, Paket App Service ini tidak akan melakukan penyeimbangan zona ketersediaan.
sku	SkuDescription	Deskripsi SKU untuk sumber daya yang dapat diskalakan.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

Capability

Objek

Menjelaskan kemampuan/fitur yang diizinkan untuk SKU tertentu.

Nama	Jenis	Deskripsi
name	string	Nama kemampuan SKU.
reason	string	Alasan kemampuan SKU.
value	string	Nilai kemampuan SKU.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objek

Respons kesalahan App Service.

Nama	Jenis	Deskripsi
error	DefaultErrorResponseError	Model kesalahan.

DefaultErrorResponseError

Objek

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
details	DefaultErrorResponseErrorDetailsItem[]	Kesalahan terperinci.
innererror	string	Informasi selengkapnya untuk men-debug kesalahan.
message	string	Deskripsi kesalahan terperinci dan informasi debugging.
target	string	Deskripsi kesalahan terperinci dan informasi debugging.

DefaultErrorResponseErrorDetailsItem

Objek

Kesalahan terperinci.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
message	string	Deskripsi kesalahan terperinci dan informasi debugging.
target	string	Deskripsi kesalahan terperinci dan informasi debugging.

DefaultIdentity

Objek

Nama	Jenis	Deskripsi
identityType	ManagedServiceIdentityType	Jenis identitas layanan terkelola.
userAssignedIdentityResourceId	string

ExtendedLocation

Objek

Lokasi yang Diperluas.

Nama	Jenis	Deskripsi
name	string	Nama lokasi yang diperluas.
type	string	Jenis lokasi yang diperluas.

HostingEnvironmentProfile

Objek

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

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya Lingkungan App Service.
name	string	Nama Lingkungan App Service.
type	string	Jenis sumber daya Lingkungan App Service.

InstallScript

Objek

Konfigurasi skrip instalasi ladang server.

Nama	Jenis	Deskripsi
name	string	Nama skrip instalasi.
source	InstallScriptSource	Sumber skrip instal.

InstallScriptSource

Objek

Objek untuk menahan referensi skrip instal.

Nama	Jenis	Deskripsi
sourceUri	string	Instal URI sumber skrip tempat file skrip instal akan diambil.
type	InstallScriptType	Jenis skrip instal.

InstallScriptType

Enumerasi

Jenis skrip instal.

Nilai	Deskripsi
RemoteAzureBlob
PlatformStorage

KeyVaultReferenceWithStatus

Objek

Objek untuk menyimpan referensi brankas kunci dan status resolusi

Nama	Jenis	Deskripsi
referenceStatus	string	Status referensi rahasia brankas kunci.
secretUri	string	URI rahasia brankas kunci.

KubeEnvironmentProfile

Objek

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

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya Lingkungan Kubernetes.
name	string	Nama lingkungan Kubernetes.
type	string	Jenis sumber daya Lingkungan Kubernetes.

ManagedServiceIdentity

Objek

Identitas layanan terkelola.

Nama	Jenis	Deskripsi
principalId	string	ID Utama identitas layanan terkelola.
tenantId	string	Penyewa identitas layanan terkelola.
type	ManagedServiceIdentityType	Jenis identitas layanan terkelola.
userAssignedIdentities	<string, UserAssignedIdentity>	Daftar identitas yang ditetapkan pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumerasi

Jenis identitas layanan terkelola.

Nilai	Deskripsi
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ProvisioningState

Enumerasi

Status provisi Paket App Service.

Nilai	Deskripsi
Succeeded
Failed
Canceled
InProgress
Deleting

RegistryAdapter

Objek

Konfigurasi adaptor registri ladang server.

Nama	Jenis	Deskripsi
keyVaultSecretReference	KeyVaultReferenceWithStatus	Referensi brankas kunci ke nilai yang akan ditempatkan di lokasi registri
registryKey	string	Kunci registri untuk adaptor.
type	RegistryAdapterType	Jenis adaptor registri.

RegistryAdapterType

Enumerasi

Jenis adaptor registri.

Nilai	Deskripsi
Binary
String
Expand_String
Multi_String
DWord
QWord

ServerFarmNetworkSettings

Objek

Pengaturan jaringan untuk paket layanan aplikasi.

Nama	Jenis	Deskripsi
virtualNetworkSubnetId	string	ID Azure Resource Manager dari jaringan Virtual dan subnet yang akan digabungkan dengan Integrasi VNET Regional. Ini harus berupa formulir /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

SkuCapacity

Objek

Deskripsi opsi skala paket App Service.

Nama	Jenis	Deskripsi
default	integer (int32)	Jumlah default pekerja untuk SKU paket App Service ini.
elasticMaximum	integer (int32)	Jumlah maksimum pekerja Elastis untuk SKU paket App Service ini.
maximum	integer (int32)	Jumlah maksimum pekerja untuk SKU paket App Service ini.
minimum	integer (int32)	Jumlah minimum pekerja untuk SKU paket App Service ini.
scaleType	string	Konfigurasi skala yang tersedia untuk paket App Service.

SkuDescription

Objek

Deskripsi SKU untuk sumber daya yang dapat diskalakan.

Nama	Jenis	Deskripsi
capabilities	Capability[]	Kemampuan SKU, misalnya, apakah traffic manager diaktifkan?
capacity	integer (int32)	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	SkuCapacity	Nilai skala min, maks, dan default SKU.
tier	string	Tingkat layanan SKU sumber daya.

StatusOptions

Enumerasi

Status paket App Service.

Nilai	Deskripsi
Ready
Pending
Creating

StorageMount

Objek

Konfigurasi pemasangan penyimpanan farm server.

Nama	Jenis	Deskripsi
credentialsKeyVaultReference	KeyVaultReferenceWithStatus	Referensi KV ke kredensial untuk terhubung ke berbagi.
destinationPath	string	Jalur pada pekerja tempat penyimpanan akan dipasang.
name	string	Nama dudukan penyimpanan.
source	string	Sumber fileshare/penyimpanan.
type	StorageMountType	Jenis dudukan penyimpanan.

StorageMountType

Enumerasi

Jenis dudukan penyimpanan.

Nilai	Deskripsi
AzureFiles
LocalStorage
FileShare

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

UserAssignedIdentity

Objek

Identitas yang ditetapkan pengguna.

Nama	Jenis	Deskripsi
clientId	string	Id Klien identitas yang ditetapkan pengguna
principalId	string	Id Utama identitas yang ditetapkan pengguna

Bagikan melalui

App Service Plans - Get

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

Get App Service plan

Permintaan sampel

Respon sampel

Definisi

AppServicePlan

Capability

createdByType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

DefaultIdentity

ExtendedLocation

HostingEnvironmentProfile

InstallScript

InstallScriptSource

InstallScriptType

KeyVaultReferenceWithStatus

KubeEnvironmentProfile

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

RegistryAdapter

RegistryAdapterType

ServerFarmNetworkSettings

SkuCapacity

SkuDescription

StatusOptions

StorageMount

StorageMountType

systemData

UserAssignedIdentity