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

Standby Virtual Machine Pools - Create Or Update

服务:: Standby Pools

API 版本:: 2025-10-01

创建 StandbyVirtualMachinePoolResource

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}?api-version=2025-10-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
standbyVirtualMachinePoolName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	备用虚拟机池的名称
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
location	True	string	资源所在的地理位置
properties.virtualMachineState	True	VirtualMachineState	指定池中虚拟机的所需状态。
properties.attachedVirtualMachineScaleSetId		string (arm-id)	指定池附加到的虚拟机规模集的完全限定资源 ID。
properties.elasticityProfile		StandbyVirtualMachinePoolElasticityProfile	指定备用虚拟机池的弹性配置文件。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	StandbyVirtualMachinePoolResource	资源“StandbyVirtualMachinePoolResource”更新作成功
201 Created	StandbyVirtualMachinePoolResource	资源“StandbyVirtualMachinePoolResource”创建作成功标头 Retry-After: integer
Other Status Codes	ErrorResponse	意外错误响应。

名称

类型

说明

200 OK

StandbyVirtualMachinePoolResource

资源“StandbyVirtualMachinePoolResource”更新作成功

201 Created

StandbyVirtualMachinePoolResource

资源“StandbyVirtualMachinePoolResource”创建作成功

标头

Retry-After: integer

Other Status Codes

ErrorResponse

意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

StandbyVirtualMachinePools_CreateOrUpdate

示例请求

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool?api-version=2025-10-01

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"
  },
  "tags": {},
  "location": "West US"
}

示例响应

状态代码:: 200

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "location": "West US",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool",
  "name": "pool",
  "type": "Microsoft.StandbyPool/standbyVirtualMachinePools",
  "systemData": {
    "createdBy": "pooluser@microsoft.com",
    "createdByType": "User",
    "createdAt": "2023-09-07T16:33:22.210Z",
    "lastModifiedBy": "pooluser@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-09-07T16:33:22.210Z"
  }
}

状态代码:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "virtualMachineState": "Running",
    "attachedVirtualMachineScaleSetId": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss",
    "provisioningState": "Succeeded"
  },
  "tags": {},
  "location": "West US",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool",
  "name": "pool",
  "type": "Microsoft.StandbyPool/standbyVirtualMachinePools",
  "systemData": {
    "createdBy": "pooluser@microsoft.com",
    "createdByType": "User",
    "createdAt": "2023-09-07T16:33:22.210Z",
    "lastModifiedBy": "pooluser@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-09-07T16:33:22.210Z"
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
DynamicSizing	指定动态大小调整配置。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ProvisioningState	预配状态
StandbyVirtualMachinePoolElasticityProfile	弹性曲线的详细信息。
StandbyVirtualMachinePoolResource	StandbyVirtualMachinePoolResource。
systemData	与创建和上次修改资源相关的元数据。
VirtualMachineState	备用虚拟机的状态

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DynamicSizing

对象

指定动态大小调整配置。

名称	类型	说明
enabled	boolean	指示是否为备用池启用了动态大小调整。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ProvisioningState

枚举

预配状态

值	说明
Succeeded	已创建资源。
Failed	资源创建失败。
Canceled	资源创建已取消。
Deleting	正在删除资源。

StandbyVirtualMachinePoolElasticityProfile

对象

弹性曲线的详细信息。

名称	类型	说明
dynamicSizing	DynamicSizing	指定动态大小调整配置。
maxReadyCapacity	integer (int64) minimum: 0	指定备用虚拟机池中虚拟机的最大数目。
minReadyCapacity	integer (int64) minimum: 0	指定备用虚拟机池中所需的最小虚拟机数。 MinReadyCapacity 不能超过 MaxReadyCapacity。
postProvisioningDelay	string	指定虚拟机置备后虚拟机可供使用之前等待的持续时间。持续时间应以 ISO 8601 格式指定（例如，PT2S 2 秒）。

StandbyVirtualMachinePoolResource

对象

StandbyVirtualMachinePoolResource。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.attachedVirtualMachineScaleSetId	string (arm-id)	指定池附加到的虚拟机规模集的完全限定资源 ID。
properties.elasticityProfile	StandbyVirtualMachinePoolElasticityProfile	指定备用虚拟机池的弹性配置文件。
properties.provisioningState	ProvisioningState	上次操作的状态。
properties.virtualMachineState	VirtualMachineState	指定池中虚拟机的所需状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

systemData

对象

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

VirtualMachineState

枚举

备用虚拟机的状态

值	说明
Running	虚拟机已启动并正在运行。
Deallocated	虚拟机已释放基础硬件上的租约并已关闭电源。
Hibernated	虚拟机已释放基础硬件上的租约并已关闭电源。 VM 的内存内容存储在 OS 磁盘中。再次启动时，以前在 VM 中运行的应用程序和进程将从休眠前的状态恢复。

通过

Standby Virtual Machine Pools - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

StandbyVirtualMachinePools_CreateOrUpdate

示例请求

示例响应

定义

createdByType

DynamicSizing

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

StandbyVirtualMachinePoolElasticityProfile

StandbyVirtualMachinePoolResource

systemData

VirtualMachineState