App Service Plans - Get

Služba:: App Service

Verze rozhraní API:: 2025-05-01

Popis pro Získání plánu služby App Service.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název plánu služby App Service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	AppServicePlan	Operace Azure byla úspěšně dokončena.
404 Not Found		Server nemůže najít požadovaný prostředek.
Other Status Codes	DefaultErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Get App Service plan

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 404

Definice

Name	Description
AppServicePlan	Plán služby App Service.
Capability	Popisuje možnosti a funkce povolené pro konkrétní skladovou položku.
createdByType	Typ identity, která prostředek vytvořila.
DefaultErrorResponse	Odpověď na chybu služby App Service
DefaultErrorResponseError	Chybový model
DefaultErrorResponseErrorDetailsItem	Podrobné chyby.
DefaultIdentity
ExtendedLocation	Rozšířené umístění.
HostingEnvironmentProfile	Specifikace služby App Service Environment, která se má použít pro tento prostředek.
InstallScript	Konfigurace instalačního skriptu serverové farmy.
InstallScriptSource	Objekt, který má obsahovat odkaz na instalační skript.
InstallScriptType	Typ instalačního skriptu.
KeyVaultReferenceWithStatus	Objekt pro uložení odkazu na trezor klíčů a stav řešení
KubeEnvironmentProfile	Specifikace prostředí Kubernetes, které se má použít pro tento prostředek.
ManagedServiceIdentity	Identita spravované služby
ManagedServiceIdentityType	Typ identity spravované služby
ProvisioningState	Stav zřizování plánu služby App Service
RegistryAdapter	Konfigurace adaptéru registru serverové farmy.
RegistryAdapterType	Typ adaptéru registru.
ServerFarmNetworkSettings	Nastavení sítě pro plán služby App Service.
SkuCapacity	Popis možností škálování plánu služby App Service.
SkuDescription	Popis skladové položky pro škálovatelný prostředek
StatusOptions	Stav plánu služby App Service.
StorageMount	Konfigurace připojení úložiště serverové farmy.
StorageMountType	Typ držáku úložiště.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
UserAssignedIdentity	Identita přiřazená uživatelem.

AppServicePlan

Objekt

Plán služby App Service.

Name	Typ	Description
extendedLocation	ExtendedLocation	Rozšířené umístění.
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identita spravované služby
kind	string	Druh prostředku. Pokud se jedná o prostředek aplikace, můžete se podívat na https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference, kde najdete podrobnosti o podporovaných hodnotách.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.asyncScalingEnabled	boolean	Pokud `true`, tento plán služby App Service se pokusí o asynchronní škálování, pokud není dostatek pracovníků pro synchronní škálování. Pokud `false`, tento plán služby App Service se pokusí pouze o škálování synchronizace.
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 (date-time)	Čas, kdy vyprší platnost bezplatné nabídky serverové farmy.
properties.geoRegion	string	Zeměpisné umístění plánu služby App Service.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Specifikace pro službu App Service Environment, která se má použít pro plán služby App Service.
properties.hyperV	boolean	Pokud Hyper-V plán služby Container App Service `true`, `false` jinak.
properties.installScripts	InstallScript[]	Nainstalujte skripty přidružené k tomuto plánu App Service.
properties.isCustomMode	boolean	Zda je tato serverová farma ve vlastním režimu.
properties.isSpot	boolean	Pokud `true`, tento plán služby App Service vlastní spotové instance.
properties.isXenon	boolean	Zastaralé: Pokud Hyper-V plán `true`služby Container App Service , `false` jinak.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile	Specifikace pro prostředí Kubernetes, která se má použít pro plán služby App Service.
properties.maximumElasticWorkerCount	integer (int32)	Maximální počet pracovních procesů povolených pro tento plán služby App Service ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer (int32)	Maximální počet instancí, které lze přiřadit k tomuto plánu služby App Service.
properties.network	ServerFarmNetworkSettings	Všechna nastavení sítě pro serverovou farmu.
properties.numberOfSites	integer (int32)	Počet aplikací přiřazených k tomuto plánu služby App Service.
properties.numberOfWorkers	integer (int32)	Počet instancí, které jsou přiřazeny k tomuto plánu služby App Service.
properties.perSiteScaling	boolean	Pokud `true`, aplikace přiřazené k tomuto plánu App Service lze škálovat nezávisle. Pokud `false`se aplikace přiřazené k tomuto plánu služby App Service škálují na všechny instance plánu.
properties.planDefaultIdentity	DefaultIdentity	Identita, kterou má platforma používat pro různé funkce a integrace pomocí spravované identity.
properties.provisioningState	ProvisioningState	Stav zřizování plánu služby App Service
properties.rdpEnabled	boolean	Pokud `true`je pro tento plán služby App Service povolen přístup RDP. Platí pouze pro technologie ASP v režimu IsCustomMode. Pokud `false`je přístup pomocí protokolu RDP zakázán.
properties.registryAdapters	RegistryAdapter[]	Adaptéry registru přidružené k tomuto plánu služby App Service.
properties.reserved	boolean	Pokud Linux app service plán `true`, `false` jinak.
properties.resourceGroup	string	Skupina prostředků plánu služby App Service.
properties.spotExpirationTime	string (date-time)	Čas vypršení platnosti serverové farmy Platné pouze v případě, že se jedná o spotovou serverovou farmu.
properties.status	StatusOptions	Stav plánu služby App Service.
properties.storageMounts	StorageMount[]	Připojení úložiště přidružená k tomuto plánu služby App Service.
properties.subscription	string	Předplatné plánu App Service.
properties.targetWorkerCount	integer (int32)	Škálování počtu pracovních procesů
properties.targetWorkerSizeId	integer (int32)	ID velikosti pracovního procesu
properties.workerTierName	string	Cílová úroveň pracovního procesu přiřazená k plánu služby App Service
properties.zoneRedundant	boolean	Pokud `true`, tento plán služby App Service provede vyrovnávání zón dostupnosti. Pokud `false`, tento plán služby App Service nebude provádět vyrovnávání zón dostupnosti.
sku	SkuDescription	Popis skladové položky pro škálovatelný prostředek
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Např. "Microsoft.Compute/virtualMachines" nebo "Microsoft.Storage/storageAccounts"

Capability

Objekt

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

Name	Typ	Description
name	string	Název možnosti skladové položky
reason	string	Důvod schopnosti skladové položky
value	string	Hodnota možnosti skladové položky

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

Odpověď na chybu služby App Service

Name	Typ	Description
error	DefaultErrorResponseError	Chybový model

DefaultErrorResponseError

Objekt

Chybový model

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby.
details	DefaultErrorResponseErrorDetailsItem[]	Podrobné chyby.
innererror	string	Další informace k chybě ladění.
message	string	Podrobný popis chyby a informace o ladění.
target	string	Podrobný popis chyby a informace o ladění.

DefaultErrorResponseErrorDetailsItem

Objekt

Podrobné chyby.

Name	Typ	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í.

DefaultIdentity

Objekt

Name	Typ	Description
identityType	ManagedServiceIdentityType	Typ identity spravované služby
userAssignedIdentityResourceId	string

ExtendedLocation

Objekt

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

Name	Typ	Description
name	string	Název rozšířeného umístění
type	string	Typ rozšířené lokality.

HostingEnvironmentProfile

Objekt

Specifikace služby App Service Environment, která se má použít pro tento prostředek.

Name	Typ	Description
id	string	ID prostředku služby App Service Environment
name	string	Název služby App Service Environment
type	string	Typ prostředku App Service Environment.

InstallScript

Objekt

Konfigurace instalačního skriptu serverové farmy.

Name	Typ	Description
name	string	Název instalačního skriptu.
source	InstallScriptSource	Zdroj instalačního skriptu.

InstallScriptSource

Objekt

Objekt, který má obsahovat odkaz na instalační skript.

Name	Typ	Description
sourceUri	string	Identifikátor URI zdroje instalačního skriptu, ze kterého se bude soubor instalačního skriptu načítat.
type	InstallScriptType	Typ instalačního skriptu.

InstallScriptType

Výčet

Typ instalačního skriptu.

Hodnota	Description
RemoteAzureBlob
PlatformStorage

KeyVaultReferenceWithStatus

Objekt

Objekt pro uložení odkazu na trezor klíčů a stav řešení

Name	Typ	Description
referenceStatus	string	Referenční stav tajného klíče trezoru klíčů.
secretUri	string	Identifikátor URI tajného klíče trezoru klíčů.

KubeEnvironmentProfile

Objekt

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

Name	Typ	Description
id	string	ID prostředku prostředí Kubernetes
name	string	Název prostředí Kubernetes.
type	string	Typ prostředku prostředí Kubernetes.

ManagedServiceIdentity

Objekt

Identita spravované služby

Name	Typ	Description
principalId	string	ID objektu zabezpečení identity spravované služby.
tenantId	string	Tenant identity spravované služby.
type	ManagedServiceIdentityType	Typ identity spravované služby
userAssignedIdentities	<string, UserAssignedIdentity>	Seznam identit přiřazených uživatelem přidružených k prostředku Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Výčet

Typ identity spravované služby

Hodnota	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ProvisioningState

Výčet

Stav zřizování plánu služby App Service

Hodnota	Description
Succeeded
Failed
Canceled
InProgress
Deleting

RegistryAdapter

Objekt

Konfigurace adaptéru registru serverové farmy.

Name	Typ	Description
keyVaultSecretReference	KeyVaultReferenceWithStatus	Odkaz na hodnotu trezoru klíčů umístěnou do umístění registru
registryKey	string	Klíč registru pro adaptér.
type	RegistryAdapterType	Typ adaptéru registru.

RegistryAdapterType

Výčet

Typ adaptéru registru.

Hodnota	Description
Binary
String
Expand_String
Multi_String
DWord
QWord

ServerFarmNetworkSettings

Objekt

Nastavení sítě pro plán služby App Service.

Name	Typ	Description
virtualNetworkSubnetId	string	ID Azure Resource Manageru virtuální sítě a podsítě, které se mají připojit k místní integraci virtuální sítě. Musí to být formulář /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

SkuCapacity

Objekt

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

Name	Typ	Description
default	integer (int32)	Výchozí počet pracovních procesů pro tuto skladovou položku plánu služby App Service
elasticMaximum	integer (int32)	Maximální počet elastických pracovních procesů pro tuto skladovou položku plánu služby App Service
maximum	integer (int32)	Maximální počet pracovních procesů pro tuto skladovou položku plánu služby App Service
minimum	integer (int32)	Minimální počet pracovních procesů pro tuto skladovou položku plánu služby App Service
scaleType	string	Dostupné konfigurace škálování pro plán služby App Service

SkuDescription

Objekt

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

Name	Typ	Description
capabilities	Capability[]	Jsou povolené možnosti skladové položky, například Traffic Manager?
capacity	integer (int32)	Aktuální počet instancí přiřazených k prostředku
family	string	Rodinný kód 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	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

Výčet

Stav plánu služby App Service.

Hodnota	Description
Ready
Pending
Creating

StorageMount

Objekt

Konfigurace připojení úložiště serverové farmy.

Name	Typ	Description
credentialsKeyVaultReference	KeyVaultReferenceWithStatus	KV odkaz na přihlašovací údaje pro připojení ke sdílené složce.
destinationPath	string	Cesta na workeru, kde se bude úložiště připojovat.
name	string	Název držáku úložiště.
source	string	Zdroj sdílené složky/úložiště.
type	StorageMountType	Typ držáku úložiště.

StorageMountType

Výčet

Typ držáku úložiště.

Hodnota	Description
AzureFiles
LocalStorage
FileShare

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

UserAssignedIdentity

Objekt

Identita přiřazená uživatelem.

Name	Typ	Description
clientId	string	ID klienta identity přiřazené uživatelem
principalId	string	Hlavní ID identity přiřazené uživatelem

Sdílet prostřednictvím

App Service Plans - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Get App Service plan

Ukázkový požadavek

Ukázková odpověď

Definice

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