App Service Plans - Get

Référence

Service:: App Service

Version d'API:: 2024-04-01

Description de l’obtention d’un plan App Service.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom du plan App Service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nom du groupe de ressources auquel appartient la ressource.
subscriptionId	path	True	string	VOTRE ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000000-0000-0000-0000-00000000000000000000000).
api-version	query	True	string	Version de l’API

Réponses

Nom	Type	Description
200 OK	AppServicePlan	D’ACCORD.
404 Not Found		Introuvable.
Other Status Codes	DefaultErrorResponse	Réponse d’erreur App Service.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get App Service plan

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
  }
}

Code d’état:: 404

Définitions

Nom	Description
AppServicePlan	Plan App Service.
Capability	Décrit les fonctionnalités/fonctionnalités autorisées pour une référence SKU spécifique.
DefaultErrorResponse	Réponse d’erreur App Service.
Details
Error	Modèle d’erreur.
ExtendedLocation	Emplacement étendu.
HostingEnvironmentProfile	Spécification d’un environnement App Service à utiliser pour cette ressource.
KubeEnvironmentProfile	Spécification d’un environnement Kubernetes à utiliser pour cette ressource.
ProvisioningState	État d’approvisionnement du plan App Service.
SkuCapacity	Description des options de mise à l’échelle du plan App Service.
SkuDescription	Description d’une référence SKU pour une ressource évolutive.
StatusOptions	État du plan App Service.

AppServicePlan

Object

Plan App Service.

Nom	Type	Valeur par défaut	Description
extendedLocation	ExtendedLocation		Emplacement étendu.
id	string		ID de ressource.
kind	string		Type de ressource. Si la ressource est une application, vous pouvez faire référence à https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference pour plus d’informations sur les valeurs prises en charge pour le type.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.elasticScaleEnabled	boolean		ServerFarm prend en charge ElasticScale. Les applications de ce plan sont mises à l’échelle comme si le serveurFarm était elasticPremium sku
properties.freeOfferExpirationTime	string (date-time)		Heure à laquelle l’offre gratuite de batterie de serveurs expire.
properties.geoRegion	string		Emplacement géographique du plan App Service.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Spécification de l’environnement App Service à utiliser pour le plan App Service.
properties.hyperV	boolean	False	Si Hyper-V plan app service conteneur `true`, `false` sinon.
properties.isSpot	boolean		Si `true`, ce plan App Service possède des instances spot.
properties.isXenon	boolean	False	Obsolète : si Hyper-V plan app service conteneur `true`, `false` sinon.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Spécification de l’environnement Kubernetes à utiliser pour le plan App Service.
properties.maximumElasticWorkerCount	integer (int32)		Nombre maximal de workers autorisés pour ce plan App Service ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer (int32)		Nombre maximal d’instances qui peuvent être affectées à ce plan App Service.
properties.numberOfSites	integer (int32)		Nombre d’applications affectées à ce plan App Service.
properties.numberOfWorkers	integer (int32)		Nombre d’instances affectées à ce plan App Service.
properties.perSiteScaling	boolean	False	Si `true`, les applications affectées à ce plan App Service peuvent être mises à l’échelle indépendamment. Si `false`, les applications affectées à ce plan App Service sont mises à l’échelle vers toutes les instances du plan.
properties.provisioningState	ProvisioningState		État d’approvisionnement du plan App Service.
properties.reserved	boolean	False	Si le plan App Service Linux `true`, `false` sinon.
properties.resourceGroup	string		Groupe de ressources du plan App Service.
properties.spotExpirationTime	string (date-time)		Heure à laquelle la batterie de serveurs expire. Valide uniquement s’il s’agit d’une batterie de serveurs spot.
properties.status	StatusOptions		État du plan App Service.
properties.subscription	string		Abonnement au plan App Service.
properties.targetWorkerCount	integer (int32)		Mise à l’échelle du nombre de workers.
properties.targetWorkerSizeId	integer (int32)		Mise à l’échelle de l’ID de taille du worker.
properties.workerTierName	string		Niveau Worker cible affecté au plan App Service.
properties.zoneRedundant	boolean	False	Si `true`, ce plan App Service effectue l’équilibrage de zone de disponibilité. Si `false`, ce plan App Service n’effectue pas d’équilibrage de zone de disponibilité.
sku	SkuDescription		Description d’une référence SKU pour une ressource évolutive.
tags	object		Balises de ressource.
type	string		Type de ressource.

Capability

Object

Décrit les fonctionnalités/fonctionnalités autorisées pour une référence SKU spécifique.

Nom	Type	Description
name	string	Nom de la fonctionnalité de référence SKU.
reason	string	Raison de la fonctionnalité de référence SKU.
value	string	Valeur de la fonctionnalité de référence SKU.

DefaultErrorResponse

Object

Réponse d’erreur App Service.

Nom	Type	Description
error	Error	Modèle d’erreur.

Details

Object

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
message	string	Description détaillée des erreurs et informations de débogage.
target	string	Description détaillée des erreurs et informations de débogage.

Error

Object

Modèle d’erreur.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
details	Details[]	Erreurs détaillées.
innererror	string	Pour plus d’informations sur l’erreur de débogage.
message	string	Description détaillée des erreurs et informations de débogage.
target	string	Description détaillée des erreurs et informations de débogage.

ExtendedLocation

Object

Emplacement étendu.

Nom	Type	Description
name	string	Nom de l’emplacement étendu.
type	string	Type d’emplacement étendu.

HostingEnvironmentProfile

Object

Spécification d’un environnement App Service à utiliser pour cette ressource.

Nom	Type	Description
id	string	ID de ressource de l’environnement App Service.
name	string	Nom de l’environnement App Service.
type	string	Type de ressource de l’environnement App Service.

KubeEnvironmentProfile

Object

Spécification d’un environnement Kubernetes à utiliser pour cette ressource.

Nom	Type	Description
id	string	ID de ressource de l’environnement Kubernetes.
name	string	Nom de l’environnement Kubernetes.
type	string	Type de ressource de l’environnement Kubernetes.

ProvisioningState

Énumération

État d’approvisionnement du plan App Service.

Valeur	Description
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Object

Description des options de mise à l’échelle du plan App Service.

Nom	Type	Description
default	integer (int32)	Nombre de workers par défaut pour cette référence SKU de plan App Service.
elasticMaximum	integer (int32)	Nombre maximal de workers élastiques pour cette référence SKU de plan App Service.
maximum	integer (int32)	Nombre maximal de workers pour cette référence SKU de plan App Service.
minimum	integer (int32)	Nombre minimal de workers pour cette référence SKU de plan App Service.
scaleType	string	Configurations de mise à l’échelle disponibles pour un plan App Service.

SkuDescription

Object

Description d’une référence SKU pour une ressource évolutive.

Nom	Type	Description
capabilities	Capability[]	Les fonctionnalités de la référence SKU, par exemple, traffic Manager sont-ils activées ?
capacity	integer (int32)	Nombre actuel d’instances affectées à la ressource.
family	string	Code de famille de la référence SKU de ressource.
locations	string[]	Emplacements de la référence SKU.
name	string	Nom de la référence SKU de ressource.
size	string	Spécificateur de taille de la référence SKU de ressource.
skuCapacity	SkuCapacity	Valeurs d’échelle min, max et par défaut de la référence SKU.
tier	string	Niveau de service de la référence SKU de ressource.

StatusOptions

Énumération

État du plan App Service.

Valeur	Description
Creating
Pending
Ready