Virtual Machine Scale Set Rolling Upgrades - Get Latest
最新の仮想マシン スケール セットのローリング アップグレードの状態を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest?api-version=2025-04-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前は大文字と小文字が区別されます。 |
|
subscription
|
path | True |
string minLength: 1 |
ターゲット サブスクリプションの ID。 |
|
vm
|
path | True |
string |
VM スケール セットの名前。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azure 操作は正常に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
|
Virtual |
|
Virtual |
VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen
要求のサンプル
応答のサンプル
{
"properties": {
"policy": {
"maxBatchInstancePercent": 49,
"maxUnhealthyInstancePercent": 81,
"maxUnhealthyUpgradedInstancePercent": 98,
"pauseTimeBetweenBatches": "aaaaaaaaaaaaaaa",
"enableCrossZoneUpgrade": true,
"prioritizeUnhealthyInstances": true,
"rollbackFailedInstancesOnPolicyBreach": true,
"maxSurge": true
},
"runningStatus": {
"code": "RollingForward",
"startTime": "2021-11-30T13:06:23.362Z",
"lastAction": "Start",
"lastActionTime": "2021-11-30T13:06:23.362Z"
},
"progress": {
"successfulInstanceCount": 6,
"failedInstanceCount": 25,
"inProgressInstanceCount": 20,
"pendingInstanceCount": 27
},
"error": {
"details": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaaa",
"target": "aaaa",
"message": "aa"
}
],
"innererror": {
"exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa"
},
"code": "aaaaaaa",
"target": "aaaaaaa",
"message": "aaaaaaaaa"
}
},
"id": "aaaaaaaaaa",
"name": "aaaaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaa",
"___location": "aaaaaa",
"tags": {
"key8533": "aaaaaaaaaaaaaaaaaaaaaaaa"
}
}
VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen
要求のサンプル
応答のサンプル
{
"___location": "aaaaaa",
"id": "aaaaaaaaaa"
}
定義
| 名前 | 説明 |
|---|---|
|
Api |
API エラー。 |
|
Api |
API エラー ベース。 |
|
Cloud |
コンピュート・サービスからのエラー・レスポンス。 |
|
created |
リソースを作成した ID の種類。 |
|
Inner |
内部エラーの詳細。 |
|
Rolling |
ローリング アップグレードで最後に実行されたアクション。 |
|
Rolling |
ローリング アップグレードの実行中に使用される構成パラメーター。 |
|
Rolling |
各アップグレード状態の仮想マシン インスタンスの数に関する情報。 |
|
Rolling |
アップグレード全体の現在の実行状態に関する情報。 |
|
Rolling |
アップグレードの現在のステータスを示すコード。 |
|
Rolling |
最新の仮想マシン スケール セットのローリング アップグレードの状態。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
ApiError
API エラー。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラー コード。 |
| details |
Api エラーの詳細 |
|
| innererror |
Api 内部エラー |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
特定のエラーのターゲット。 |
ApiErrorBase
API エラー ベース。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラー コード。 |
| message |
string |
エラー メッセージ。 |
| target |
string |
特定のエラーのターゲット。 |
CloudError
コンピュート・サービスからのエラー・レスポンス。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
API エラー。 |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
InnerError
内部エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errordetail |
string |
内部エラー・メッセージまたは例外ダンプ。 |
| exceptiontype |
string |
例外タイプ。 |
RollingUpgradeActionType
ローリング アップグレードで最後に実行されたアクション。
| 値 | 説明 |
|---|---|
| Start | |
| Cancel |
RollingUpgradePolicy
ローリング アップグレードの実行中に使用される構成パラメーター。
| 名前 | 型 | 説明 |
|---|---|---|
| enableCrossZoneUpgrade |
boolean |
アップグレード バッチを構築するときに、VMSS が AZ 境界を無視できるようにします。 バッチ サイズを決定するには、更新ドメインと maxBatchInstancePercent を考慮してください。 |
| maxBatchInstancePercent |
integer (int32) minimum: 5maximum: 100 |
1 回のバッチでのローリング アップグレードによって同時にアップグレードされる仮想マシン インスタンスの合計数に対する最大割合。 これは最大であるため、以前または将来のバッチの異常なインスタンスでは、信頼性を高めるためにバッチ内のインスタンスの割合が減少する可能性があります。 このパラメーターの既定値は 20%です。 |
| maxSurge |
boolean |
既存の仮想マシンを更新するのではなく、スケール セットをアップグレードする新しい仮想マシンを作成します。 既存の仮想マシンは、バッチごとに新しい仮想マシンが作成されると削除されます。 |
| maxUnhealthyInstancePercent |
integer (int32) minimum: 5maximum: 100 |
アップグレードの結果として、またはローリング アップグレードが中止される前に仮想マシンの正常性チェックによって異常な状態で検出された場合に、同時に異常になる可能性があるスケール セット内の仮想マシン インスタンスの合計数に対する最大割合。 この制約は、バッチを開始する前にチェックされます。 このパラメーターの既定値は 20%です。 |
| maxUnhealthyUpgradedInstancePercent |
integer (int32) maximum: 100 |
異常な状態にあると検出できるアップグレードされた仮想マシン インスタンスの最大割合。 このチェックは、各バッチがアップグレードされた後に行われます。 この割合を超えた場合、ローリング アップデートは中止されます。 このパラメーターの既定値は 20%です。 |
| pauseTimeBetweenBatches |
string |
すべての仮想マシンの更新を 1 つのバッチで完了してから次のバッチを開始するまでの待機時間。 期間は ISO 8601 形式で指定する必要があります。 既定値は 0 秒 (PT0S) です。 |
| prioritizeUnhealthyInstances |
boolean |
正常なインスタンスの前に、スケール セット内のすべての異常なインスタンスをアップグレードします。 |
| rollbackFailedInstancesOnPolicyBreach |
boolean |
ローリング アップグレード ポリシーに違反した場合、失敗したインスタンスを以前のモデルにロールバックします。 |
RollingUpgradeProgressInfo
各アップグレード状態の仮想マシン インスタンスの数に関する情報。
| 名前 | 型 | 説明 |
|---|---|---|
| failedInstanceCount |
integer (int32) |
正常にアップグレードできなかったインスタンスの数。 |
| inProgressInstanceCount |
integer (int32) |
現在アップグレード中のインスタンスの数。 |
| pendingInstanceCount |
integer (int32) |
アップグレードをまだ開始していないインスタンスの数。 |
| successfulInstanceCount |
integer (int32) |
正常にアップグレードされたインスタンスの数。 |
RollingUpgradeRunningStatus
アップグレード全体の現在の実行状態に関する情報。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
アップグレードの現在のステータスを示すコード。 |
|
| lastAction |
ローリング アップグレードで最後に実行されたアクション。 |
|
| lastActionTime |
string (date-time) |
アップグレードの最後のアクション時刻。 |
| startTime |
string (date-time) |
アップグレードの開始時刻。 |
RollingUpgradeStatusCode
アップグレードの現在のステータスを示すコード。
| 値 | 説明 |
|---|---|
| RollingForward | |
| Cancelled | |
| Completed | |
| Faulted |
RollingUpgradeStatusInfo
最新の仮想マシン スケール セットのローリング アップグレードの状態。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| ___location |
string |
リソースが存在する地理的な場所 |
| name |
string |
リソースの名前 |
| properties.error |
このアップグレードのエラーの詳細 (ある場合)。 |
|
| properties.policy |
このアップグレードに適用されたローリング アップグレード ポリシー。 |
|
| properties.progress |
各アップグレード状態の仮想マシン インスタンスの数に関する情報。 |
|
| properties.runningStatus |
アップグレード全体の現在の実行状態に関する情報。 |
|
| systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
| tags |
object |
リソース タグ。 |
| type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |