App Service Plans - Get

Service:: App Service

API-versie:: 2025-03-01

Beschrijving voor Een App Service-abonnement aanvragen.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	De naam van het App Service-plan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	AppServicePlan	De Azure-bewerking is voltooid.
404 Not Found		De aangevraagde resource kan niet worden gevonden op de server.
Other Status Codes	DefaultErrorResponse	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get App Service plan

Voorbeeldaanvraag

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


/**
 * Samples for AppServicePlans GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetAppServicePlan.json
     */
    /**
     * Sample code: Get App Service plan.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAppServicePlan(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().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

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_app_service_plan.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_plans.get(
        resource_group_name="testrg123",
        name="testsf6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetAppServicePlan.json
if __name__ == "__main__":
    main()

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/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("<subscription-id>", 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.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

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Get an App Service plan.
 *
 * @summary Description for Get an App Service plan.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetAppServicePlan.json
 */
async function getAppServicePlan() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "testsf6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServicePlans.get(resourceGroupName, name);
  console.log(result);
}

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

Voorbeeldrespons

Statuscode:: 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"
  }
}

Statuscode:: 404

Definities

Name	Description
AppServicePlan	App Service-plan.
Capability	Beschrijft de mogelijkheden/functies die zijn toegestaan voor een specifieke SKU.
createdByType	Het type identiteit waarmee de resource is gemaakt.
DefaultErrorResponse	Foutreactie van App Service.
DefaultErrorResponseError	Foutmodel.
DefaultErrorResponseErrorDetailsItem	Gedetailleerde fouten.
DefaultIdentity
ExtendedLocation	Uitgebreide locatie.
HostingEnvironmentProfile	Specificatie voor een App Service-omgeving die voor deze resource moet worden gebruikt.
InstallScript	Configuratie van het installatiescript van de serverfarm.
InstallScriptSource	Object om de verwijzing naar het installatiescript vast te houden.
InstallScriptType	Typ het installatiescript.
KeyVaultReferenceWithStatus	Object om sleutelkluisreferentie en de oplossingsstatus vast te houden
KubeEnvironmentProfile	Specificatie voor een Kubernetes-omgeving die voor deze resource moet worden gebruikt.
ManagedServiceIdentity	Beheerde service-identiteit.
ManagedServiceIdentityType	Type beheerde service-identiteit.
ProvisioningState	Inrichtingsstatus van het App Service Plan.
RegistryAdapter	Configuratie van registeradapter voor serverfarm.
RegistryAdapterType	Type van de registeradapter.
ServerFarmNetworkSettings	Netwerkinstellingen voor een app-serviceplan.
SkuCapacity	Beschrijving van de schaalopties van het App Service-abonnement.
SkuDescription	Beschrijving van een SKU voor een schaalbare resource.
StatusOptions	Status van het App Service-abonnement.
StorageMount	Configuratie van serverfarm-opslagkoppeling.
StorageMountType	Type van de opslaghouder.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UserAssignedIdentity	Door de gebruiker toegewezen identiteit.

AppServicePlan

Object

App Service-plan.

Name	Type	Description
extendedLocation	ExtendedLocation	Uitgebreide locatie.
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Beheerde service-identiteit.
kind	string	Soort resource. Als de resource een app is, kunt u verwijzen naar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference voor meer informatie over ondersteunde waarden voor soort.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.asyncScalingEnabled	boolean	Als `true`, probeert dit App Service Plan asynchroon te schalen als er onvoldoende werknemers zijn om synchroon te schalen. Als `false`dit App Service Plan alleen probeert de synchronisatie te schalen.
properties.elasticScaleEnabled	boolean	ServerFarm ondersteunt ElasticScale. Apps in dit plan worden geschaald alsof de ServerFarm ElasticPremium-sku is
properties.freeOfferExpirationTime	string (date-time)	Het tijdstip waarop de gratis aanbieding voor de serverfarm verloopt.
properties.geoRegion	string	Geografische locatie voor het App Service-abonnement.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Specificatie voor de App Service-omgeving die moet worden gebruikt voor het App Service-plan.
properties.hyperV	boolean	Als Hyper-V container-app-serviceplan `true`hebt, `false` anders.
properties.installScripts	InstallScript[]	Installeer scripts die zijn gekoppeld aan dit App Service-abonnement.
properties.isCustomMode	boolean	Of deze serverfarm zich in de aangepaste modus bevindt.
properties.isSpot	boolean	Als `true`, is dit App Service Plan eigenaar van spot-exemplaren.
properties.isXenon	boolean	Verouderd: als Hyper-V serviceplan `true`voor container-apps , `false` anders.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile	Specificatie voor de Kubernetes-omgeving die moet worden gebruikt voor het App Service-plan.
properties.maximumElasticWorkerCount	integer (int32)	Maximum aantal toegestane werknemers voor dit ElasticScaleEnabled App Service-plan
properties.maximumNumberOfWorkers	integer (int32)	Maximum aantal exemplaren dat kan worden toegewezen aan dit App Service-abonnement.
properties.network	ServerFarmNetworkSettings	Alle netwerkinstellingen voor de serverfarm.
properties.numberOfSites	integer (int32)	Het aantal apps dat aan dit App Service-abonnement is toegewezen.
properties.numberOfWorkers	integer (int32)	Het aantal exemplaren dat is toegewezen aan dit App Service-abonnement.
properties.perSiteScaling	boolean	Als `true`, kunnen apps die aan dit App Service-abonnement zijn toegewezen, onafhankelijk van elkaar worden geschaald. Als `false`apps die aan dit App Service-abonnement zijn toegewezen, worden geschaald naar alle exemplaren van het abonnement.
properties.planDefaultIdentity	DefaultIdentity	Identiteit die per platform kan worden gebruikt voor verschillende functies en integraties met behulp van beheerde identiteit.
properties.provisioningState	ProvisioningState	Inrichtingsstatus van het App Service Plan.
properties.rdpEnabled	boolean	Als `true`, is RDP-toegang ingeschakeld voor dit App Service-abonnement. Alleen van toepassing op IsCustomMode ASP's. Als `false`, RDP-toegang is uitgeschakeld.
properties.registryAdapters	RegistryAdapter[]	Registeradapters die zijn gekoppeld aan dit App Service-abonnement.
properties.reserved	boolean	Als Linux app service plan `true`, `false` anders.
properties.resourceGroup	string	Resourcegroep van het App Service-plan.
properties.spotExpirationTime	string (date-time)	Het tijdstip waarop de serverfarm verloopt. Alleen geldig als het een spot-serverfarm is.
properties.status	StatusOptions	Status van het App Service-abonnement.
properties.storageMounts	StorageMount[]	Opslagkoppelingen die zijn gekoppeld aan dit App Service-abonnement.
properties.subscription	string	Abonnement op het App Service-abonnement.
properties.targetWorkerCount	integer (int32)	Het aantal werkrollen schalen.
properties.targetWorkerSizeId	integer (int32)	Schaal van werkrolgrootte-id.
properties.workerTierName	string	Doelwerklaag die is toegewezen aan het App Service-plan.
properties.zoneRedundant	boolean	Als `true`, voert dit App Service Plan een balancering van de beschikbaarheidszone uit. Als `false`, wordt met dit App Service Plan geen balancering van de beschikbaarheidszone uitgevoerd.
sku	SkuDescription	Beschrijving van een SKU voor een schaalbare resource.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Resourcetags.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

Capability

Object

Beschrijft de mogelijkheden/functies die zijn toegestaan voor een specifieke SKU.

Name	Type	Description
name	string	Naam van de SKU-mogelijkheid.
reason	string	Reden van de SKU-mogelijkheid.
value	string	Waarde van de SKU-mogelijkheid.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

Foutreactie van App Service.

Name	Type	Description
error	DefaultErrorResponseError	Foutmodel.

DefaultErrorResponseError

Object

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	DefaultErrorResponseErrorDetailsItem[]	Gedetailleerde fouten.
innererror	string	Meer informatie om fouten op te sporen.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

DefaultErrorResponseErrorDetailsItem

Object

Gedetailleerde fouten.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsinformatie.

DefaultIdentity

Object

Name	Type	Description
identityType	ManagedServiceIdentityType	Type beheerde service-identiteit.
userAssignedIdentityResourceId	string

ExtendedLocation

Object

Uitgebreide locatie.

Name	Type	Description
name	string	Naam van uitgebreide locatie.
type	string	Type uitgebreide locatie.

HostingEnvironmentProfile

Object

Specificatie voor een App Service-omgeving die voor deze resource moet worden gebruikt.

Name	Type	Description
id	string	Resource-id van de App Service-omgeving.
name	string	Naam van de App Service-omgeving.
type	string	Resourcetype van de App Service Environment.

InstallScript

Object

Configuratie van het installatiescript van de serverfarm.

Name	Type	Description
name	string	Naam van het installatiescript.
source	InstallScriptSource	Bron van het installatiescript.

InstallScriptSource

Object

Object om de verwijzing naar het installatiescript vast te houden.

Name	Type	Description
sourceUri	string	Installeer de bron-URI van het script waaruit het installatiescriptbestand wordt opgehaald.
type	InstallScriptType	Typ het installatiescript.

InstallScriptType

Opsomming

Typ het installatiescript.

Waarde	Description
RemoteAzureBlob
PlatformStorage

KeyVaultReferenceWithStatus

Object

Object om sleutelkluisreferentie en de oplossingsstatus vast te houden

Name	Type	Description
referenceStatus	string	Referentiestatus van het geheim van de sleutelkluis.
secretUri	string	Sleutelkluis geheime URI.

KubeEnvironmentProfile

Object

Specificatie voor een Kubernetes-omgeving die voor deze resource moet worden gebruikt.

Name	Type	Description
id	string	Resource-id van de Kubernetes-omgeving.
name	string	Naam van de Kubernetes-omgeving.
type	string	Resourcetype van de Kubernetes-omgeving.

ManagedServiceIdentity

Object

Beheerde service-identiteit.

Name	Type	Description
principalId	string	Principal-id van de identiteit van de beheerde service.
tenantId	string	Huurder van beheerde service-identiteit.
type	ManagedServiceIdentityType	Type beheerde service-identiteit.
userAssignedIdentities	<string, UserAssignedIdentity>	De lijst met door de gebruiker toegewezen identiteiten die aan de resource zijn gekoppeld. De referenties voor de woordenlijst van de gebruikersidentiteit zijn ARM-resource-id's in de vorm: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Opsomming

Type beheerde service-identiteit.

Waarde	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ProvisioningState

Opsomming

Inrichtingsstatus van het App Service Plan.

Waarde	Description
Succeeded
Failed
Canceled
InProgress
Deleting

RegistryAdapter

Object

Configuratie van registeradapter voor serverfarm.

Name	Type	Description
keyVaultSecretReference	KeyVaultReferenceWithStatus	Sleutelkluisverwijzing naar de waarde die op de registerlocatie wordt geplaatst
registryKey	string	Registersleutel voor de adapter.
type	RegistryAdapterType	Type van de registeradapter.

RegistryAdapterType

Opsomming

Type van de registeradapter.

Waarde	Description
Binary
String
Expand_String
Multi_String
DWord
QWord

ServerFarmNetworkSettings

Object

Netwerkinstellingen voor een app-serviceplan.

Name	Type	Description
virtualNetworkSubnetId	string	Azure Resource Manager-id van het virtuele netwerk en subnet dat moet worden toegevoegd door regionale VNET-integratie. Dit moet van het formulier /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} zijn

SkuCapacity

Object

Beschrijving van de schaalopties van het App Service-abonnement.

Name	Type	Description
default	integer (int32)	Het standaardaantal werkrollen voor deze App Service-plan-SKU.
elasticMaximum	integer (int32)	Maximum aantal elastische werkrollen voor deze App Service-plan-SKU.
maximum	integer (int32)	Maximum aantal werkrollen voor deze App Service-plan-SKU.
minimum	integer (int32)	Minimaal aantal werkrollen voor deze App Service-plan-SKU.
scaleType	string	Beschikbare schaalconfiguraties voor een App Service-plan.

SkuDescription

Object

Beschrijving van een SKU voor een schaalbare resource.

Name	Type	Description
capabilities	Capability[]	Mogelijkheden van de SKU, bijvoorbeeld, is Traffic Manager ingeschakeld?
capacity	integer (int32)	Het huidige aantal exemplaren dat is toegewezen aan de resource.
family	string	Familiecode van de resource-SKU.
locations	string[]	Locaties van de SKU.
name	string	Naam van de resource-SKU.
size	string	Grootteaanduiding van de resource-SKU.
skuCapacity	SkuCapacity	Minimale, maximale en standaardschaalwaarden van de SKU.
tier	string	Servicelaag van de resource-SKU.

StatusOptions

Opsomming

Status van het App Service-abonnement.

Waarde	Description
Ready
Pending
Creating

StorageMount

Object

Configuratie van serverfarm-opslagkoppeling.

Name	Type	Description
credentialsKeyVaultReference	KeyVaultReferenceWithStatus	KV verwijzing naar de referenties om verbinding te maken met de share.
destinationPath	string	Pad op de werknemer waar de opslag wordt aangekoppeld.
name	string	Naam van de opslaghouder.
source	string	Bron van de fileshare/opslag.
type	StorageMountType	Type van de opslaghouder.

StorageMountType

Opsomming

Type van de opslaghouder.

Waarde	Description
AzureFiles
LocalStorage
FileShare

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UserAssignedIdentity

Object

Door de gebruiker toegewezen identiteit.

Name	Type	Description
clientId	string	Client-id van door de gebruiker toegewezen identiteit
principalId	string	Principal-id van door de gebruiker toegewezen identiteit

Delen via

App Service Plans - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Get App Service plan

Voorbeeldaanvraag

Voorbeeldrespons

Definities

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