App Service Plans - Get

服務:

App Service

API 版本:

2024-04-01

取得 App Service 方案的描述。

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

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	App Service 方案的名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	資源所屬的資源群組名稱。
subscriptionId	path	True	string	您的 Azure 訂用帳戶標識碼。 這是 GUID 格式的字串（例如 0000000000-0000-0000-0000-0000000000000000）。
api-version	query	True	string	API 版本

回應

名稱	類型	Description
200 OK	AppServicePlan	還行。
404 Not Found		找不到。
Other Status Codes	DefaultErrorResponse	App Service 錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get App Service plan

範例要求

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

dotnet

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

範例回覆

狀態碼:

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

狀態碼:

404

定義

名稱	Description
AppServicePlan	App Service 方案。
Capability	描述特定 SKU 允許的功能/功能。
DefaultErrorResponse	App Service 錯誤回應。
Details
Error	錯誤模型。
ExtendedLocation	擴充位置。
HostingEnvironmentProfile	要用於此資源的 App Service 環境規格。
KubeEnvironmentProfile	要用於此資源的 Kubernetes 環境規格。
ProvisioningState	App Service 方案的布建狀態。
SkuCapacity	App Service 方案調整選項的描述。
SkuDescription	可調整資源的 SKU 描述。
StatusOptions	App Service 方案狀態。

AppServicePlan

Object

App Service 方案。

名稱	類型	預設值	Description
extendedLocation	ExtendedLocation		擴充位置。
id	string		資源標識碼。
kind	string		資源種類。 如果資源是應用程式，您可以參考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 以取得種類支援的詳細值。
location	string		資源位置。
name	string		資源名稱。
properties.elasticScaleEnabled	boolean		ServerFarm 支援 ElasticScale。 此方案中的應用程式會像 ServerFarm 是 ElasticPremium sku 一樣調整
properties.freeOfferExpirationTime	string (date-time)		伺服器數位免費供應專案到期的時間。
properties.geoRegion	string		App Service 方案的地理位置。
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		App Service 環境用於 App Service 方案的規格。
properties.hyperV	boolean	False	如果 Hyper-V 容器 App Service 方案 true，則為 ，否則為 false。
properties.isSpot	boolean		如果 true，則此 App Service 方案擁有現成實例。
properties.isXenon	boolean	False	過時：如果 Hyper-V 容器 App Service 方案 true，則為 ，否則為 false。
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		要用於 App Service 方案的 Kubernetes Environment 規格。
properties.maximumElasticWorkerCount	integer (int32)		此 ElasticScaleEnabled App Service 方案允許的工作者總數上限
properties.maximumNumberOfWorkers	integer (int32)		可指派給此 App Service 方案的實例數目上限。
properties.numberOfSites	integer (int32)		指派給此 App Service 方案的應用程式數目。
properties.numberOfWorkers	integer (int32)		指派給此 App Service 方案的實例數目。
properties.perSiteScaling	boolean	False	如果 true，則指派給此 App Service 方案的應用程式可以獨立調整。 如果 false，指派給此 App Service 方案的應用程式將會調整為方案的所有實例。
properties.provisioningState	ProvisioningState		App Service 方案的布建狀態。
properties.reserved	boolean	False	如果 Linux App Service 方案 true，則為 ，否則為 false。
properties.resourceGroup	string		App Service 方案的資源群組。
properties.spotExpirationTime	string (date-time)		伺服器陣列到期的時間。 只有在它是現成伺服器陣列時才有效。
properties.status	StatusOptions		App Service 方案狀態。
properties.subscription	string		App Service 方案訂用帳戶。
properties.targetWorkerCount	integer (int32)		調整背景工作計數。
properties.targetWorkerSizeId	integer (int32)		調整背景工作角色大小標識碼。
properties.workerTierName	string		指派給 App Service 方案的目標背景工作層。
properties.zoneRedundant	boolean	False	如果 true，此 App Service 方案將會執行可用性區域平衡。 如果 false，此 App Service 方案將不會執行可用性區域平衡。
sku	SkuDescription		可調整資源的 SKU 描述。
tags	object		資源標籤。
type	string		資源類型。

Capability

Object

描述特定 SKU 允許的功能/功能。

名稱	類型	Description
name	string	SKU 功能的名稱。
reason	string	SKU 功能的原因。
value	string	SKU 功能的值。

DefaultErrorResponse

Object

App Service 錯誤回應。

名稱	類型	Description
error	Error	錯誤模型。

Details

Object

名稱	類型	Description
code	string	以程式設計方式識別錯誤的標準化字串。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。

Error

Object

錯誤模型。

名稱	類型	Description
code	string	以程式設計方式識別錯誤的標準化字串。
details	Details[]	詳細的錯誤。
innererror	string	偵錯錯誤的詳細資訊。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。

ExtendedLocation

Object

擴充位置。

名稱	類型	Description
name	string	擴充位置的名稱。
type	string	擴充位置的類型。

HostingEnvironmentProfile

Object

要用於此資源的 App Service 環境規格。

名稱	類型	Description
id	string	App Service 環境的資源標識符。
name	string	App Service 環境的名稱。
type	string	App Service 環境的資源類型。

KubeEnvironmentProfile

Object

要用於此資源的 Kubernetes 環境規格。

名稱	類型	Description
id	string	Kubernetes 環境的資源標識碼。
name	string	Kubernetes 環境的名稱。
type	string	Kubernetes 環境的資源類型。

ProvisioningState

列舉型別

App Service 方案的布建狀態。

值	Description
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Object

App Service 方案調整選項的描述。

名稱	類型	Description
default	integer (int32)	此 App Service 方案 SKU 的預設背景工作角色數目。
elasticMaximum	integer (int32)	此 App Service 方案 SKU 的彈性背景工作角色數目上限。
maximum	integer (int32)	此 App Service 方案 SKU 的工作者數目上限。
minimum	integer (int32)	此 App Service 方案 SKU 的最小背景工作角色數目。
scaleType	string	App Service 方案的可用調整組態。

SkuDescription

Object

可調整資源的 SKU 描述。

名稱	類型	Description
capabilities	Capability[]	SKU 的功能，例如流量管理員是否已啟用？
capacity	integer (int32)	目前指派給資源的實例數目。
family	string	資源 SKU 的系列程式代碼。
locations	string[]	SKU 的位置。
name	string	資源 SKU 的名稱。
size	string	資源 SKU 的大小規範。
skuCapacity	SkuCapacity	SKU 的最小、最大值和預設小數字數值。
tier	string	資源 SKU 的服務層級。

StatusOptions

列舉型別

App Service 方案狀態。

值	Description
Creating
Pending
Ready