Gets the status of the latest virtual machine scale set rolling upgrade.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest?api-version=2024-07-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
resourceGroupName
|
path |
True
|
string
|
The name of the resource group.
|
|
subscriptionId
|
path |
True
|
string
|
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
|
|
vmScaleSetName
|
path |
True
|
string
|
The name of the VM scale set.
|
|
api-version
|
query |
True
|
string
|
Client Api Version.
|
Responses
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen
Sample request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaa/rollingUpgrades/latest?api-version=2024-07-01
/**
* Samples for VirtualMachineScaleSetRollingUpgrades GetLatest.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
* virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json
*/
/**
* Sample code: VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void virtualMachineScaleSetRollingUpgradeGetLatestMaximumSetGen(
com.azure.resourcemanager.AzureResourceManager azure) {
azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetRollingUpgrades()
.getLatestWithResponse("rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaa", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.compute import ComputeManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-compute
# USAGE
python virtual_machine_scale_set_rolling_upgrade_get_latest_maximum_set_gen.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ComputeManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
response = client.virtual_machine_scale_set_rolling_upgrades.get_latest(
resource_group_name="rgcompute",
vm_scale_set_name="aaaaaaaaaaaaaaaaaaaaaaaaa",
)
print(response)
# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armcompute_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetRollingUpgradesClient_GetLatest_virtualMachineScaleSetRollingUpgradeGetLatestMaximumSetGen() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewVirtualMachineScaleSetRollingUpgradesClient().GetLatest(ctx, "rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaa", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.RollingUpgradeStatusInfo = armcompute.RollingUpgradeStatusInfo{
// Name: to.Ptr("aaaaaaaaaaaaaaaaaaa"),
// Type: to.Ptr("aaaaaaaaaaaaaaaaaaaaa"),
// ID: to.Ptr("aaaaaaaaaa"),
// Location: to.Ptr("aaaaaa"),
// Tags: map[string]*string{
// "key8533": to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaa"),
// },
// Properties: &armcompute.RollingUpgradeStatusInfoProperties{
// Error: &armcompute.APIError{
// Code: to.Ptr("aaaaaaa"),
// Innererror: &armcompute.InnerError{
// Errordetail: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaa"),
// Exceptiontype: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaaaaaaa"),
// },
// Message: to.Ptr("aaaaaaaaa"),
// Target: to.Ptr("aaaaaaa"),
// Details: []*armcompute.APIErrorBase{
// {
// Code: to.Ptr("aaaaaaaaaaaaaaaaaaaaaaaa"),
// Message: to.Ptr("aa"),
// Target: to.Ptr("aaaa"),
// }},
// },
// Policy: &armcompute.RollingUpgradePolicy{
// EnableCrossZoneUpgrade: to.Ptr(true),
// MaxBatchInstancePercent: to.Ptr[int32](49),
// MaxSurge: to.Ptr(true),
// MaxUnhealthyInstancePercent: to.Ptr[int32](81),
// MaxUnhealthyUpgradedInstancePercent: to.Ptr[int32](98),
// PauseTimeBetweenBatches: to.Ptr("aaaaaaaaaaaaaaa"),
// PrioritizeUnhealthyInstances: to.Ptr(true),
// RollbackFailedInstancesOnPolicyBreach: to.Ptr(true),
// },
// Progress: &armcompute.RollingUpgradeProgressInfo{
// FailedInstanceCount: to.Ptr[int32](25),
// InProgressInstanceCount: to.Ptr[int32](20),
// PendingInstanceCount: to.Ptr[int32](27),
// SuccessfulInstanceCount: to.Ptr[int32](6),
// },
// RunningStatus: &armcompute.RollingUpgradeRunningStatus{
// Code: to.Ptr(armcompute.RollingUpgradeStatusCodeRollingForward),
// LastAction: to.Ptr(armcompute.RollingUpgradeActionTypeStart),
// LastActionTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T13:06:23.362Z"); return t}()),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T13:06:23.362Z"); return t}()),
// },
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the status of the latest virtual machine scale set rolling upgrade.
*
* @summary Gets the status of the latest virtual machine scale set rolling upgrade.
* x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json
*/
async function virtualMachineScaleSetRollingUpgradeGetLatestMaximumSetGen() {
const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaa";
const credential = new DefaultAzureCredential();
const client = new ComputeManagementClient(credential, subscriptionId);
const result = await client.virtualMachineScaleSetRollingUpgrades.getLatest(
resourceGroupName,
vmScaleSetName,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute;
// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSetRollingUpgrades_GetLatest" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this VirtualMachineScaleSetRollingUpgradeResource created on azure
// for more information of creating VirtualMachineScaleSetRollingUpgradeResource, please refer to the document of VirtualMachineScaleSetRollingUpgradeResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineScaleSetRollingUpgradeResourceId = VirtualMachineScaleSetRollingUpgradeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetRollingUpgradeResource virtualMachineScaleSetRollingUpgrade = client.GetVirtualMachineScaleSetRollingUpgradeResource(virtualMachineScaleSetRollingUpgradeResourceId);
// invoke the operation
VirtualMachineScaleSetRollingUpgradeResource result = await virtualMachineScaleSetRollingUpgrade.GetAsync();
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VirtualMachineScaleSetRollingUpgradeData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"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
Sample request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaa/rollingUpgrades/latest?api-version=2024-07-01
/**
* Samples for VirtualMachineScaleSetRollingUpgrades GetLatest.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
* virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json
*/
/**
* Sample code: VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void virtualMachineScaleSetRollingUpgradeGetLatestMinimumSetGen(
com.azure.resourcemanager.AzureResourceManager azure) {
azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSetRollingUpgrades()
.getLatestWithResponse("rgcompute", "aaaaaaaaaaaaaaaaa", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.compute import ComputeManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-compute
# USAGE
python virtual_machine_scale_set_rolling_upgrade_get_latest_minimum_set_gen.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ComputeManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
response = client.virtual_machine_scale_set_rolling_upgrades.get_latest(
resource_group_name="rgcompute",
vm_scale_set_name="aaaaaaaaaaaaaaaaa",
)
print(response)
# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armcompute_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v6"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetRollingUpgradesClient_GetLatest_virtualMachineScaleSetRollingUpgradeGetLatestMinimumSetGen() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armcompute.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewVirtualMachineScaleSetRollingUpgradesClient().GetLatest(ctx, "rgcompute", "aaaaaaaaaaaaaaaaa", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.RollingUpgradeStatusInfo = armcompute.RollingUpgradeStatusInfo{
// ID: to.Ptr("aaaaaaaaaa"),
// Location: to.Ptr("aaaaaa"),
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ComputeManagementClient } = require("@azure/arm-compute");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the status of the latest virtual machine scale set rolling upgrade.
*
* @summary Gets the status of the latest virtual machine scale set rolling upgrade.
* x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json
*/
async function virtualMachineScaleSetRollingUpgradeGetLatestMinimumSetGen() {
const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
const vmScaleSetName = "aaaaaaaaaaaaaaaaa";
const credential = new DefaultAzureCredential();
const client = new ComputeManagementClient(credential, subscriptionId);
const result = await client.virtualMachineScaleSetRollingUpgrades.getLatest(
resourceGroupName,
vmScaleSetName,
);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute;
// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSetRollingUpgrade_GetLatest_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSetRollingUpgrades_GetLatest" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this VirtualMachineScaleSetRollingUpgradeResource created on azure
// for more information of creating VirtualMachineScaleSetRollingUpgradeResource, please refer to the document of VirtualMachineScaleSetRollingUpgradeResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineScaleSetRollingUpgradeResourceId = VirtualMachineScaleSetRollingUpgradeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetRollingUpgradeResource virtualMachineScaleSetRollingUpgrade = client.GetVirtualMachineScaleSetRollingUpgradeResource(virtualMachineScaleSetRollingUpgradeResourceId);
// invoke the operation
VirtualMachineScaleSetRollingUpgradeResource result = await virtualMachineScaleSetRollingUpgrade.GetAsync();
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VirtualMachineScaleSetRollingUpgradeData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"location": "aaaaaa",
"id": "aaaaaaaaaa"
}
Definitions
ApiError
Api error.
| Name |
Type |
Description |
|
code
|
string
|
The error code.
|
|
details
|
ApiErrorBase[]
|
The Api error details
|
|
innererror
|
InnerError
|
The Api inner error
|
|
message
|
string
|
The error message.
|
|
target
|
string
|
The target of the particular error.
|
ApiErrorBase
Api error base.
| Name |
Type |
Description |
|
code
|
string
|
The error code.
|
|
message
|
string
|
The error message.
|
|
target
|
string
|
The target of the particular error.
|
CloudError
An error response from the Compute service.
| Name |
Type |
Description |
|
error
|
ApiError
|
Api error.
|
InnerError
Inner error details.
| Name |
Type |
Description |
|
errordetail
|
string
|
The internal error message or exception dump.
|
|
exceptiontype
|
string
|
The exception type.
|
RollingUpgradeActionType
The last action performed on the rolling upgrade.
| Name |
Type |
Description |
|
Cancel
|
string
|
|
|
Start
|
string
|
|
RollingUpgradePolicy
The configuration parameters used while performing a rolling upgrade.
| Name |
Type |
Description |
|
enableCrossZoneUpgrade
|
boolean
|
Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.
|
|
maxBatchInstancePercent
|
integer
|
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
|
|
maxSurge
|
boolean
|
Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch.
|
|
maxUnhealthyInstancePercent
|
integer
|
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.
|
|
maxUnhealthyUpgradedInstancePercent
|
integer
|
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.
|
|
pauseTimeBetweenBatches
|
string
|
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).
|
|
prioritizeUnhealthyInstances
|
boolean
|
Upgrade all unhealthy instances in a scale set before any healthy instances.
|
|
rollbackFailedInstancesOnPolicyBreach
|
boolean
|
Rollback failed instances to previous model if the Rolling Upgrade policy is violated.
|
RollingUpgradeProgressInfo
Information about the number of virtual machine instances in each upgrade state.
| Name |
Type |
Description |
|
failedInstanceCount
|
integer
|
The number of instances that have failed to be upgraded successfully.
|
|
inProgressInstanceCount
|
integer
|
The number of instances that are currently being upgraded.
|
|
pendingInstanceCount
|
integer
|
The number of instances that have not yet begun to be upgraded.
|
|
successfulInstanceCount
|
integer
|
The number of instances that have been successfully upgraded.
|
RollingUpgradeRunningStatus
Information about the current running state of the overall upgrade.
| Name |
Type |
Description |
|
code
|
RollingUpgradeStatusCode
|
Code indicating the current status of the upgrade.
|
|
lastAction
|
RollingUpgradeActionType
|
The last action performed on the rolling upgrade.
|
|
lastActionTime
|
string
|
Last action time of the upgrade.
|
|
startTime
|
string
|
Start time of the upgrade.
|
RollingUpgradeStatusCode
Code indicating the current status of the upgrade.
| Name |
Type |
Description |
|
Cancelled
|
string
|
|
|
Completed
|
string
|
|
|
Faulted
|
string
|
|
|
RollingForward
|
string
|
|
RollingUpgradeStatusInfo
The status of the latest virtual machine scale set rolling upgrade.
| Name |
Type |
Description |
|
id
|
string
|
Resource Id
|
|
location
|
string
|
Resource location
|
|
name
|
string
|
Resource name
|
|
properties.error
|
ApiError
|
Error details for this upgrade, if there are any.
|
|
properties.policy
|
RollingUpgradePolicy
|
The rolling upgrade policies applied for this upgrade.
|
|
properties.progress
|
RollingUpgradeProgressInfo
|
Information about the number of virtual machine instances in each upgrade state.
|
|
properties.runningStatus
|
RollingUpgradeRunningStatus
|
Information about the current running state of the overall upgrade.
|
|
tags
|
object
|
Resource tags
|
|
type
|
string
|
Resource type
|