Standby Virtual Machine Pools - Create Or Update

リファレンス

サービス:: Standby Pools

API バージョン:: 2025-03-01

StandbyVirtualMachinePoolResource を作成する

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyVirtualMachinePools/{standbyVirtualMachinePoolName}?api-version=2025-03-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 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 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-03-01

{
  "properties": {
    "elasticityProfile": {
      "maxReadyCapacity": 304,
      "minReadyCapacity": 300
    },
    "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
    },
    "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
    },
    "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	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ProvisioningState	プロビジョニングの状態
StandbyVirtualMachinePoolElasticityProfile	弾性プロファイルの詳細。
StandbyVirtualMachinePoolResource	StandbyVirtualMachinePoolResource。
systemData	リソースの作成と最後の変更に関連するメタデータ。
VirtualMachineState	スタンバイ仮想マシンの状態

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ProvisioningState

列挙

プロビジョニングの状態

値	説明
Canceled	リソースの作成が取り消されました。
Deleting	リソースが削除されています。
Failed	リソースの作成に失敗しました。
Succeeded	リソースが作成されました。

StandbyVirtualMachinePoolElasticityProfile

Object

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

名前	型	説明
maxReadyCapacity	integer (int64) minimum: 0 maximum: 2000	スタンバイ仮想マシンプール内の仮想マシンの最大数を指定します。
minReadyCapacity	integer (int64) minimum: 0 maximum: 2000	スタンバイ仮想マシンプール内の仮想マシンの最小数を指定します。 MinReadyCapacity は MaxReadyCapacity を超えることはできません。

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	プール内の仮想マシンの望ましい状態を指定します。
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

列挙

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

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

次の方法で共有

Standby Virtual Machine Pools - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

StandbyVirtualMachinePools_CreateOrUpdate

要求のサンプル

応答のサンプル

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningState

StandbyVirtualMachinePoolElasticityProfile

StandbyVirtualMachinePoolResource

systemData

VirtualMachineState

その他のリソース