Standby Virtual Machine Pools - Create Or Update

サービス:
Standby Pools
API バージョン:
2026-04-01

StandbyVirtualMachinePoolResource を作成する

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}?api-version=2026-04-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

スタンバイ仮想マシン プールの弾力性プロファイルを指定します。
properties.vmStateDistribution

VmStateDistribution

virtualMachineStateがMixに設定されたとき、プール内の仮想マシン状態の分布を指定します。
tags

object

リソース タグ。

応答

名前 型 説明
200 OK

StandbyVirtualMachinePoolResource

リソース 'StandbyVirtualMachinePoolResource' の更新操作に成功しました
201 Created

StandbyVirtualMachinePoolResource

リソース 'StandbyVirtualMachinePoolResource' の作成操作に成功しました

ヘッダー

Retry-After: integer
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

StandbyVirtualMachinePools_CreateOrUpdate
StandbyVirtualMachinePools_CreateOrUpdate_MixState

StandbyVirtualMachinePools_CreateOrUpdate

要求のサンプル

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000009/resourceGroups/rgstandbypool/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/pool?api-version=2026-04-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"
  }
}

StandbyVirtualMachinePools_CreateOrUpdate_MixState

要求のサンプル

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

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300,
      "postProvisioningDelay": "PT2S",
      "dynamicSizing": {
        "enabled": true
      }
    },
    "virtualMachineState": "Mix",
    "vmStateDistribution": {
      "runningPercent": 20,
      "deallocatedPercent": 80,
      "hibernatedPercent": 0
    },
    "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": "Mix",
    "vmStateDistribution": {
      "runningPercent": 20,
      "deallocatedPercent": 80,
      "hibernatedPercent": 0
    },
    "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": "Mix",
    "vmStateDistribution": {
      "runningPercent": 20,
      "deallocatedPercent": 80,
      "hibernatedPercent": 0
    },
    "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

リソースを作成した ID の種類。
DynamicSizing

動的サイジング構成を指定します。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
ProvisioningState

プロビジョニングの状態
StandbyVirtualMachinePoolElasticityProfile

弾性プロファイルの詳細。
StandbyVirtualMachinePoolResource

StandbyVirtualMachinePoolResourceです。
systemData

リソースの作成と最後の変更に関連するメタデータ。
VirtualMachineState

スタンバイ仮想マシンの状態
VmStateDistribution

プール内の仮想マシン状態の分布を指定します。

createdByType

列挙

リソースを作成した ID の種類。

値 説明
User
Application
ManagedIdentity
Key

DynamicSizing

Object

動的サイジング構成を指定します。

名前 型 説明
enabled

boolean

スタンバイ・プールに対して動的サイジングが有効になっているかどうかを示します。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

ProvisioningState

列挙

プロビジョニングの状態

値 説明
Succeeded

リソースが作成されました。
Failed

リソースの作成に失敗しました。
Canceled

リソースの作成が取り消されました。
Deleting

リソースが削除されています。

StandbyVirtualMachinePoolElasticityProfile

Object

弾性プロファイルの詳細。

名前 型 説明
dynamicSizing

DynamicSizing

動的サイジング構成を指定します。
maxReadyCapacity

integer (int64)

minimum: 0

スタンバイ仮想マシン プール内の仮想マシンの最大数を指定します。
minReadyCapacity

integer (int64)

minimum: 0

スタンバイ仮想マシン プール内の仮想マシンの最小数を指定します。 MinReadyCapacity は MaxReadyCapacity を超えることはできません。
postProvisioningDelay

string

仮想マシンのプロビジョニング後、仮想マシンが使用可能になるまでの待機時間を指定します。 持続時間は ISO 8601 形式で指定する必要があります (例: PT2S 2 秒間)。

StandbyVirtualMachinePoolResource

Object

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

プール内の仮想マシンの望ましい状態を指定します。
properties.vmStateDistribution

VmStateDistribution

virtualMachineStateがMixに設定されたとき、プール内の仮想マシン状態の分布を指定します。
systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags

object

リソース タグ。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

VirtualMachineState

列挙

スタンバイ仮想マシンの状態

値 説明
Running

仮想マシンが稼働しています。
Deallocated

仮想マシンは、基盤となるハードウェアのリースを解放し、電源がオフになっています。
Hibernated

仮想マシンは、基盤となるハードウェアのリースを解放し、電源がオフになっています。 VM のメモリ内容は OS ディスクに格納されます。 再起動すると、VM で以前に実行されていたアプリケーションとプロセスが休止状態の状態から再開されます。
Mix

プールにはvmStateDistributionプロパティで定義された異なる状態の仮想マシンが混在しています。

VmStateDistribution

Object

プール内の仮想マシン状態の分布を指定します。

名前 型 説明
deallocatedPercent

integer (int32)

minimum: 0
maximum: 100

スタンバイプールでDealloaded状態にある仮想マシンの割合を指定します。
hibernatedPercent

integer (int32)

minimum: 0
maximum: 100

スタンバイプールでハイバネート状態にある仮想マシンの割合を指定します。
runningPercent

integer (int32)

minimum: 0
maximum: 100

スタンバイプールで「実行中」状態にある仮想マシンの割合を指定します。