你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
App Service Plans - Get
获取App 服务计划的说明。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}?api-version=2023-12-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
name
|
path | True |
string |
应用服务计划的名称。 |
resource
|
path | True |
string |
资源所属的资源组的名称。 Regex pattern: |
subscription
|
path | True |
string |
Azure 订阅 ID。 这是一个 GUID 格式的字符串, (例如 00000000-0000-0000-0000-0000000000000) 。 |
api-version
|
query | True |
string |
API 版本 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 |
|
404 Not Found |
未找到。 |
|
Other Status Codes |
App 服务错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Get App Service plan
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141?api-version=2023-12-01
Sample Response
{
"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
}
}
定义
名称 | 说明 |
---|---|
App |
应用服务计划。 |
Capability |
描述特定 SKU 允许的功能/功能。 |
Default |
App 服务错误响应。 |
Details | |
Error |
错误模型。 |
Extended |
扩展位置。 |
Hosting |
要用于此资源的应用服务环境的规范。 |
Kube |
要用于此资源的 Kubernetes 环境的规范。 |
Provisioning |
App 服务计划的预配状态。 |
Sku |
App 服务计划缩放选项的说明。 |
Sku |
可缩放资源的 SKU 说明。 |
Status |
App 服务计划状态。 |
AppServicePlan
应用服务计划。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
extendedLocation |
扩展位置。 |
||
id |
string |
资源 ID。 |
|
kind |
string |
资源类型。 |
|
location |
string |
资源位置。 |
|
name |
string |
资源名称。 |
|
properties.elasticScaleEnabled |
boolean |
ServerFarm 支持 ElasticScale。 此计划中的应用将缩放,就像 ServerFarm 是 ElasticPremium SKU 一样 |
|
properties.freeOfferExpirationTime |
string |
服务器场免费套餐过期的时间。 |
|
properties.geoRegion |
string |
App 服务计划的地理位置。 |
|
properties.hostingEnvironmentProfile |
用于App 服务计划的应用服务环境规范。 |
||
properties.hyperV |
boolean |
False |
如果 Hyper-V 容器应用服务计划 |
properties.isSpot |
boolean |
如果 |
|
properties.isXenon |
boolean |
False |
已过时:如果 Hyper-V 容器应用服务计划 |
properties.kubeEnvironmentProfile |
用于App 服务计划的 Kubernetes 环境的规范。 |
||
properties.maximumElasticWorkerCount |
integer |
此 ElasticScaleEnabled App 服务 计划允许的最大辅助角色总数 |
|
properties.maximumNumberOfWorkers |
integer |
可分配给此App 服务计划的最大实例数。 |
|
properties.numberOfSites |
integer |
分配给此App 服务计划的应用数。 |
|
properties.numberOfWorkers |
integer |
分配给此App 服务计划的实例数。 |
|
properties.perSiteScaling |
boolean |
False |
如果 |
properties.provisioningState |
App 服务计划的预配状态。 |
||
properties.reserved |
boolean |
False |
如果 Linux 应用服务计划 |
properties.resourceGroup |
string |
App 服务计划的资源组。 |
|
properties.spotExpirationTime |
string |
服务器场过期的时间。 仅当它是现成服务器场时有效。 |
|
properties.status |
App 服务计划状态。 |
||
properties.subscription |
string |
App 服务计划订阅。 |
|
properties.targetWorkerCount |
integer |
缩放辅助角色计数。 |
|
properties.targetWorkerSizeId |
integer |
缩放辅助角色大小 ID。 |
|
properties.workerTierName |
string |
分配给App 服务计划的目标辅助角色层。 |
|
properties.zoneRedundant |
boolean |
False |
如果 |
sku |
可缩放资源的 SKU 说明。 |
||
tags |
object |
资源标记。 |
|
type |
string |
资源类型。 |
Capability
描述特定 SKU 允许的功能/功能。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
SKU 功能的名称。 |
reason |
string |
SKU 功能的原因。 |
value |
string |
SKU 功能的值。 |
DefaultErrorResponse
App 服务错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误模型。 |
Details
名称 | 类型 | 说明 |
---|---|---|
code |
string |
标准化字符串,用于以编程方式标识错误。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
Error
错误模型。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
标准化字符串,用于以编程方式标识错误。 |
details |
Details[] |
详细错误。 |
innererror |
string |
调试错误的详细信息。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
ExtendedLocation
扩展位置。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
扩展位置的名称。 |
type |
string |
扩展位置的类型。 |
HostingEnvironmentProfile
要用于此资源的应用服务环境的规范。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
应用服务环境的资源 ID。 |
name |
string |
应用服务环境的名称。 |
type |
string |
应用服务环境的资源类型。 |
KubeEnvironmentProfile
要用于此资源的 Kubernetes 环境的规范。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
Kubernetes 环境的资源 ID。 |
name |
string |
Kubernetes 环境的名称。 |
type |
string |
Kubernetes 环境的资源类型。 |
ProvisioningState
App 服务计划的预配状态。
名称 | 类型 | 说明 |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
SkuCapacity
App 服务计划缩放选项的说明。
名称 | 类型 | 说明 |
---|---|---|
default |
integer |
此App 服务计划 SKU 的默认辅助角色数。 |
elasticMaximum |
integer |
此App 服务计划 SKU 的最大弹性辅助角色数。 |
maximum |
integer |
此App 服务计划 SKU 的最大辅助角色数。 |
minimum |
integer |
此App 服务计划 SKU 的最小辅助角色数。 |
scaleType |
string |
App 服务计划的可用缩放配置。 |
SkuDescription
可缩放资源的 SKU 说明。
名称 | 类型 | 说明 |
---|---|---|
capabilities |
SKU 的功能,例如是否启用了流量管理器? |
|
capacity |
integer |
分配给资源的当前实例数。 |
family |
string |
资源 SKU 的系列代码。 |
locations |
string[] |
SKU 的位置。 |
name |
string |
资源 SKU 的名称。 |
size |
string |
资源 SKU 的大小说明符。 |
skuCapacity |
SKU 的最小、最大和默认缩放值。 |
|
tier |
string |
资源 SKU 的服务层。 |
StatusOptions
App 服务计划状态。
名称 | 类型 | 说明 |
---|---|---|
Creating |
string |
|
Pending |
string |
|
Ready |
string |