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

Scaling Plans - Get

获取缩放计划。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}?api-version=2022-02-10-preview

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

scalingPlanName
path True

string

缩放计划的名称。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

ScalingPlan

已成功检索缩放计划。

Other Status Codes

CloudError

描述操作失败原因的自动化错误响应。

示例

ScalingPlans_Get

示例请求

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1?api-version=2022-02-10-preview

示例响应

{
  "name": "workspace1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1",
  "type": "Microsoft.DesktopVirtualization/scalingPlans",
  "location": "centralus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "objectId": "00000000-0000-0000-0000-000000000000",
    "description": "Description of scaling plan",
    "friendlyName": "Scaling Plan 1",
    "timeZone": "Central Standard Time",
    "hostPoolType": "Pooled",
    "exclusionTag": "value",
    "schedules": [
      {
        "name": "schedule1",
        "daysOfWeek": [
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday"
        ],
        "rampUpStartTime": {
          "hour": 6,
          "minute": 0
        },
        "rampUpLoadBalancingAlgorithm": "DepthFirst",
        "rampUpMinimumHostsPct": 20,
        "rampUpCapacityThresholdPct": 80,
        "peakStartTime": {
          "hour": 8,
          "minute": 0
        },
        "peakLoadBalancingAlgorithm": "BreadthFirst",
        "rampDownStartTime": {
          "hour": 18,
          "minute": 0
        },
        "rampDownLoadBalancingAlgorithm": "DepthFirst",
        "rampDownMinimumHostsPct": 20,
        "rampDownCapacityThresholdPct": 50,
        "rampDownForceLogoffUsers": true,
        "rampDownWaitTimeMinutes": 30,
        "rampDownNotificationMessage": "message",
        "offPeakStartTime": {
          "hour": 20,
          "minute": 0
        },
        "offPeakLoadBalancingAlgorithm": "DepthFirst"
      }
    ],
    "hostPoolReferences": [
      {
        "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
        "scalingPlanEnabled": true
      }
    ]
  }
}

定义

名称 说明
CloudError

云错误对象。

CloudErrorProperties

云错误对象属性。

createdByType

创建资源的标识类型。

DaysOfWeek

此计划处于活动状态的一周中的天数集。

Identity
Plan
ResourceIdentityType

标识类型。

ScalingHostPoolReference

对主机池的缩放计划引用。

ScalingHostPoolType

桌面的 HostPool 类型。

ScalingPlan

ScalingPlan

ScalingSchedule

缩放计划计划。

SessionHostLoadBalancingAlgorithm

增加时段的负载均衡算法。

Sku
SkuTier

如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。

StopHostsWhen

指定在下降期间何时停止主机。

systemData

与资源的创建和上次修改相关的元数据。

Time

执行缩放操作的时间。

CloudError

云错误对象。

名称 类型 说明
error

CloudErrorProperties

云错误对象属性。

CloudErrorProperties

云错误对象属性。

名称 类型 说明
code

string

错误代码

message

string

指示操作失败原因的错误消息。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

此计划处于活动状态的一周中的天数集。

名称 类型 说明
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

Identity

名称 类型 说明
principalId

string

资源标识的主体 ID。

tenantId

string

资源的租户 ID。

type

ResourceIdentityType

标识类型。

Plan

名称 类型 说明
name

string

正在采购的第三方项目的用户定义名称。

product

string

正在采购的第三方项目。 例如 NewRelic。 产品映射到加入数据市场时为项目指定的 OfferID。

promotionCode

string

发布者为上述产品/项目提供了在数据市场中预配的促销代码。

publisher

string

正在购买的第三方项目的发布者。 例如,NewRelic

version

string

所需产品/项目的版本。

ResourceIdentityType

标识类型。

名称 类型 说明
SystemAssigned

string

ScalingHostPoolReference

对主机池的缩放计划引用。

名称 类型 说明
hostPoolArmPath

string

引用的主机池的 Arm 路径。

scalingPlanEnabled

boolean

是否为此主机池启用了缩放计划。

ScalingHostPoolType

桌面的 HostPool 类型。

名称 类型 说明
Pooled

string

每次连接到 HostPool 时,用户都会获得一个新的 (随机) SessionHost。

ScalingPlan

ScalingPlan

名称 类型 说明
etag

string

etag 字段 是必需的。 如果响应正文中提供了它,则还必须根据常规 etag 约定将其作为标头提供。 实体标记用于比较同一请求资源中的两个或多个实体。 HTTP/1.1 使用 etag (第 14.19 节) 、If-Match (第 14.24 节) 、If-None-Match (第 14.26 节) 中的实体标记,以及 If-Range (第 14.27 节) 标头字段。

id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

kind

string

门户/工具等用于呈现相同类型资源的不同 UX 体验的元数据;例如,ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持,资源提供程序必须验证并保留此值。

location

string

资源所在的地理位置

managedBy

string

管理此资源的资源的完全限定的资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况,如果从模板中删除资源,则完整模式部署不会删除该资源,因为它由另一个资源管理。

name

string

资源的名称

plan

Plan

properties.description

string

缩放计划的说明。

properties.exclusionTag

string

缩放计划的排除标记。

properties.friendlyName

string

缩放计划的用户友好名称。

properties.hostPoolReferences

ScalingHostPoolReference[]

ScalingHostPoolReference 定义列表。

properties.hostPoolType

ScalingHostPoolType

桌面的 HostPool 类型。

properties.objectId

string

缩放计划的 ObjectId。 (内部使用)

properties.schedules

ScalingSchedule[]

ScalingSchedule 定义列表。

properties.timeZone

string

缩放计划的时区。

sku

Sku

systemData

systemData

与资源的创建和上次修改相关的元数据。

tags

object

资源标记。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ScalingSchedule

缩放计划计划。

名称 类型 说明
daysOfWeek

DaysOfWeek[]

此计划处于活动状态的一周中的天数集。

name

string

缩放计划的名称。

offPeakLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

非高峰期的负载均衡算法。

offPeakStartTime

Time

非高峰期的开始时间。

peakLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

高峰期的负载均衡算法。

peakStartTime

Time

高峰期的开始时间。

rampDownCapacityThresholdPct

integer

下降期间的容量阈值。

rampDownForceLogoffUsers

boolean

应从主机强制注销用户。

rampDownLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

负载均衡算法,用于降低周期。

rampDownMinimumHostsPct

integer

下降期间的最小主机百分比。

rampDownNotificationMessage

string

在斜坡期间向用户发送通知消息。

rampDownStartTime

Time

下降周期的开始时间。

rampDownStopHostsWhen

StopHostsWhen

指定在下降期间何时停止主机。

rampDownWaitTimeMinutes

integer

在下降期间等待停止主机的分钟数。

rampUpCapacityThresholdPct

integer

增加期间的容量阈值。

rampUpLoadBalancingAlgorithm

SessionHostLoadBalancingAlgorithm

增加时段的负载均衡算法。

rampUpMinimumHostsPct

integer

增加时段的最小主机百分比。

rampUpStartTime

Time

增加时段的开始时间。

SessionHostLoadBalancingAlgorithm

增加时段的负载均衡算法。

名称 类型 说明
BreadthFirst

string

DepthFirst

string

Sku

名称 类型 说明
capacity

integer

如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果无法对资源进行横向扩展/缩减,则可能会省略此项。

family

string

如果服务针对同一 SKU 具有不同代系的硬件,则可以在此处捕获。

name

string

SKU 的名称。 例如 - P3。 它通常是字母+数字代码

size

string

SKU 大小。 当名称字段是层和一些其他值的组合时,这将是独立代码。

tier

SkuTier

如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。

SkuTier

如果服务具有多个层,但 PUT 上不需要此字段,则资源提供程序需要实现此字段。

名称 类型 说明
Basic

string

Free

string

Premium

string

Standard

string

StopHostsWhen

指定在下降期间何时停止主机。

名称 类型 说明
ZeroActiveSessions

string

ZeroSessions

string

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

Time

执行缩放操作的时间。

名称 类型 说明
hour

integer

小时。

minute

integer

分钟。