你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

App Service Plans - Get

参考

服务:: App Service

API 版本:: 2024-11-01

获取应用服务计划的说明。

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

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用服务计划的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	资源所属的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。这是 GUID 格式的字符串（例如 000000000-0000-0000-0000-00000000000000）。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	AppServicePlan	还行。
404 Not Found		未找到。
Other Status Codes	DefaultErrorResponse	应用服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get App Service plan

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

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.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-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

定义

名称	说明
AppServicePlan	应用服务计划。
Capability	描述特定 SKU 允许的功能/功能。
DefaultErrorResponse	应用服务错误响应。
Details
Error	错误模型。
ExtendedLocation	扩展位置。
HostingEnvironmentProfile	要用于此资源的应用服务环境的规范。
KubeEnvironmentProfile	要用于此资源的 Kubernetes 环境的规范。
ProvisioningState	应用服务计划的预配状态。
SkuCapacity	应用服务计划缩放选项的说明。
SkuDescription	可缩放资源的 SKU 说明。
StatusOptions	应用服务计划状态。

AppServicePlan

Object

应用服务计划。

名称	类型	默认值	说明
extendedLocation	ExtendedLocation		扩展位置。
id	string		资源 ID。
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.asyncScalingEnabled	boolean		如果 `true`，则如果没有足够的辅助角色来同步缩放，则此应用服务计划将尝试异步缩放。如果 `false`，则此应用服务计划将仅尝试同步缩放。
properties.elasticScaleEnabled	boolean		ServerFarm 支持 ElasticScale。此计划中的应用将像 ServerFarm 是 ElasticPremium sku 一样缩放
properties.freeOfferExpirationTime	string (date-time)		服务器场免费套餐过期的时间。
properties.geoRegion	string		应用服务计划的地理位置。
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		要用于应用服务计划的应用服务环境的规范。
properties.hyperV	boolean	False	如果 Hyper-V 容器应用服务计划 `true`，则 `false` 否则。
properties.isSpot	boolean		如果 `true`，此应用服务计划将拥有现成实例。
properties.isXenon	boolean	False	已过时：如果 Hyper-V 容器应用服务计划 `true`，则 `false` 否则。
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		用于应用服务计划的 Kubernetes 环境的规范。
properties.maximumElasticWorkerCount	integer (int32)		此 ElasticScaleEnabled 应用服务计划允许的最大辅助角色数
properties.maximumNumberOfWorkers	integer (int32)		可分配给此应用服务计划的最大实例数。
properties.numberOfSites	integer (int32)		分配给此应用服务计划的应用数。
properties.numberOfWorkers	integer (int32)		分配给此应用服务计划的实例数。
properties.perSiteScaling	boolean	False	如果 `true`，可以独立缩放分配给此应用服务计划的应用。如果 `false`，分配给此应用服务计划的应用将扩展到计划的所有实例。
properties.provisioningState	ProvisioningState		应用服务计划的预配状态。
properties.reserved	boolean	False	如果 Linux 应用服务计划 `true`，则 `false` 否则。
properties.resourceGroup	string		应用服务计划的资源组。
properties.spotExpirationTime	string (date-time)		服务器场过期的时间。仅当它是现成服务器场时才有效。
properties.status	StatusOptions		应用服务计划状态。
properties.subscription	string		应用服务计划订阅。
properties.targetWorkerCount	integer (int32)		缩放工作器计数。
properties.targetWorkerSizeId	integer (int32)		缩放辅助角色大小 ID。
properties.workerTierName	string		分配给应用服务计划的目标辅助角色层。
properties.zoneRedundant	boolean	False	如果 `true`，此应用服务计划将执行可用性区域均衡。如果 `false`，则此应用服务计划不会执行可用性区域均衡。
sku	SkuDescription		可缩放资源的 SKU 说明。
tags	object		资源标记。
type	string		资源类型。

Capability

Object

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

名称	类型	说明
name	string	SKU 功能的名称。
reason	string	SKU 功能的原因。
value	string	SKU 功能的值。

DefaultErrorResponse

Object

应用服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

Object

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

Object

错误模型。

名称	类型	说明
code	string	标准化字符串，以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

ExtendedLocation

Object

扩展位置。

名称	类型	说明
name	string	扩展位置的名称。
type	string	扩展位置的类型。

HostingEnvironmentProfile

Object

要用于此资源的应用服务环境的规范。

名称	类型	说明
id	string	应用服务环境的资源 ID。
name	string	应用服务环境的名称。
type	string	应用服务环境的资源类型。

KubeEnvironmentProfile

Object

要用于此资源的 Kubernetes 环境的规范。

名称	类型	说明
id	string	Kubernetes 环境的资源 ID。
name	string	Kubernetes 环境的名称。
type	string	Kubernetes 环境的资源类型。

ProvisioningState

枚举

应用服务计划的预配状态。

值	说明
Canceled
Deleting
Failed
InProgress
Succeeded

SkuCapacity

Object

应用服务计划缩放选项的说明。

名称	类型	说明
default	integer (int32)	此应用服务计划 SKU 的默认辅助角色数。
elasticMaximum	integer (int32)	此应用服务计划 SKU 的最大弹性辅助角色数。
maximum	integer (int32)	此应用服务计划 SKU 的最大辅助角色数。
minimum	integer (int32)	此应用服务计划 SKU 的最小辅助角色数。
scaleType	string	应用服务计划的可用缩放配置。

SkuDescription

Object

可缩放资源的 SKU 说明。

名称	类型	说明
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

枚举

应用服务计划状态。

值	说明
Creating
Pending
Ready

通过

App Service Plans - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

Get App Service plan

示例请求

示例响应

定义

AppServicePlan

Capability

DefaultErrorResponse

Details

Error

ExtendedLocation

HostingEnvironmentProfile

KubeEnvironmentProfile

ProvisioningState

SkuCapacity

SkuDescription

StatusOptions