App Service Plans - Get

Referentie

Service:: App Service

API-versie:: 2024-04-01

Beschrijving voor Een App Service-plan ophalen.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van het App Service-plan.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Naam van de resourcegroep waartoe de resource behoort.
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	API-versie

Antwoorden

Name	Type	Description
200 OK	AppServicePlan	OK.
404 Not Found		Niet gevonden.
Other Status Codes	DefaultErrorResponse	Foutreactie van App Service.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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=2024-04-01


/**
 * Samples for AppServicePlans GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-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/stable/2024-04-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/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-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/stable/2024-04-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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetAppServicePlan.json
// this example is just showing the usage of "AppServicePlans_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AppServicePlanResource created on azure
// for more information of creating AppServicePlanResource, please refer to the document of AppServicePlanResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "testsf6141";
ResourceIdentifier appServicePlanResourceId = AppServicePlanResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
AppServicePlanResource appServicePlan = client.GetAppServicePlanResource(appServicePlanResourceId);

// invoke the operation
AppServicePlanResource result = await appServicePlan.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppServicePlanData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

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

Statuscode:: 404

Definities

Name	Description
AppServicePlan	App Service-plan.
Capability	Beschrijft de mogelijkheden/functies die zijn toegestaan voor een specifieke SKU.
DefaultErrorResponse	Foutreactie van App Service.
Details
Error	Foutmodel.
ExtendedLocation	Uitgebreide locatie.
HostingEnvironmentProfile	Specificatie voor een App Service-omgeving die voor deze resource moet worden gebruikt.
KubeEnvironmentProfile	Specificatie voor een Kubernetes-omgeving die voor deze resource moet worden gebruikt.
ProvisioningState	Inrichtingsstatus van het App Service-plan.
SkuCapacity	Beschrijving van de schaalopties van het App Service-plan.
SkuDescription	Beschrijving van een SKU voor een schaalbare resource.
StatusOptions	Status van App Service-plan.

AppServicePlan

Object

App Service-plan.

Name	Type	Default value	Description
extendedLocation	ExtendedLocation		Uitgebreide locatie.
id	string		Resource-id.
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		Resourcelocatie.
name	string		Resourcenaam.
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-plan.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Specificatie voor de App Service-omgeving die moet worden gebruikt voor het App Service-plan.
properties.hyperV	boolean	False	Als Hyper-V Container App Service-plan `true`, `false` anders.
properties.isSpot	boolean		Als `true`, is dit App Service-plan eigenaar van spot-exemplaren.
properties.isXenon	boolean	False	Verouderd: als Hyper-V Container App Service-plan `true`, `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-plan.
properties.numberOfSites	integer (int32)		Het aantal apps dat is toegewezen aan dit App Service-plan.
properties.numberOfWorkers	integer (int32)		Het aantal exemplaren dat is toegewezen aan dit App Service-plan.
properties.perSiteScaling	boolean	False	Als `true`, kunnen apps die aan dit App Service-plan zijn toegewezen onafhankelijk worden geschaald. Als `false`, worden apps die aan dit App Service-plan zijn toegewezen, geschaald naar alle exemplaren van het plan.
properties.provisioningState	ProvisioningState		Inrichtingsstatus van het App Service-plan.
properties.reserved	boolean	False	Als het 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 App Service-plan.
properties.subscription	string		Abonnement op App Service-plan.
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	False	Als `true`, voert dit App Service-plan de taakverdeling van de beschikbaarheidszone uit. Als `false`, wordt met dit App Service-plan geen taakverdeling in de beschikbaarheidszone uitgevoerd.
sku	SkuDescription		Beschrijving van een SKU voor een schaalbare resource.
tags	object		Resourcetags.
type	string		Resourcetype.

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.

DefaultErrorResponse

Object

Foutreactie van App Service.

Name	Type	Description
error	Error	Foutmodel.

Details

Object

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

Error

Object

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Gedetailleerde fouten.
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

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-omgeving.

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.

ProvisioningState

Inventarisatie

Inrichtingsstatus van het App Service-plan.

Waarde	Description
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Object

Beschrijving van de schaalopties van het App Service-plan.

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

Inventarisatie

Status van App Service-plan.

Waarde	Description
Creating
Pending
Ready