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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
standbyVirtualMachinePoolName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	待命虛擬機集區的名稱
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源所在的地理位置
properties.virtualMachineState	True	VirtualMachineState	指定集區中虛擬機的所需狀態。
properties.attachedVirtualMachineScaleSetId		string (arm-id)	指定集區所連結之虛擬機擴展集的完整資源識別碼。
properties.elasticityProfile		StandbyVirtualMachinePoolElasticityProfile	指定待命虛擬機集區的彈性配置檔。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	StandbyVirtualMachinePoolResource	資源 'StandbyVirtualMachinePoolResource' 更新作業成功
201 Created	StandbyVirtualMachinePoolResource	資源 'StandbyVirtualMachinePoolResource' 建立作業成功標題 Retry-After: integer
Other Status Codes	ErrorResponse	非預期的錯誤回應。

名稱

類型

Description

200 OK

StandbyVirtualMachinePoolResource

資源 'StandbyVirtualMachinePoolResource' 更新作業成功

201 Created

StandbyVirtualMachinePoolResource

資源 'StandbyVirtualMachinePoolResource' 建立作業成功

標題

Retry-After: integer

Other Status Codes

ErrorResponse

非預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

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

範圍

名稱	Description
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"
  }
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
DynamicSizing	指定動態大小設定。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ProvisioningState	佈建狀態
StandbyVirtualMachinePoolElasticityProfile	彈性曲線的詳細資料。
StandbyVirtualMachinePoolResource	StandbyVirtualMachinePoolResource。
systemData	與建立和上次修改資源相關的元數據。
VirtualMachineState	待命虛擬機器的狀態

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

DynamicSizing

Object

指定動態大小設定。

名稱	類型	Description
enabled	boolean	指出是否已啟用待命集區的動態大小調整。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ProvisioningState

列舉型別

佈建狀態

值	Description
Succeeded	資源已建立。
Failed	資源建立失敗。
Canceled	資源建立已取消。
Deleting	正在刪除資源。

StandbyVirtualMachinePoolElasticityProfile

Object

彈性曲線的詳細資料。

名稱	類型	Description
dynamicSizing	DynamicSizing	指定動態大小設定。
maxReadyCapacity	integer (int64) minimum: 0	指定待命虛擬機集區中的虛擬機數目上限。
minReadyCapacity	integer (int64) minimum: 0	指定待命虛擬機集區中所需的虛擬機數目下限。 MinReadyCapacity 不能超過 MaxReadyCapacity。
postProvisioningDelay	string	指定在虛擬機器佈建之後，虛擬機器可供使用之前等待的持續時間。持續時間應以 ISO 8601 格式指定（例如，PT2S 2 秒）。

StandbyVirtualMachinePoolResource

Object

StandbyVirtualMachinePoolResource。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	資源所在的地理位置
name	string	資源的名稱
properties.attachedVirtualMachineScaleSetId	string (arm-id)	指定集區所連結之虛擬機擴展集的完整資源識別碼。
properties.elasticityProfile	StandbyVirtualMachinePoolElasticityProfile	指定待命虛擬機集區的彈性配置檔。
properties.provisioningState	ProvisioningState	上次作業的狀態。
properties.virtualMachineState	VirtualMachineState	指定集區中虛擬機的所需狀態。
systemData	systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 中繼資料。
tags	object	資源標籤。
type	string	資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

VirtualMachineState

列舉型別

待命虛擬機器的狀態

值	Description
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