Gets list of OS upgrades on a VM scale set instance.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory?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
VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen
Sample request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaa/osUpgradeHistory?api-version=2024-07-01
/**
* Samples for VirtualMachineScaleSets GetOSUpgradeHistory.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
* virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json
*/
/**
* Sample code: VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void
virtualMachineScaleSetGetOSUpgradeHistoryMaximumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().getOSUpgradeHistory("rgcompute",
"aaaaaa", 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_get_os_upgrade_history_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_sets.get_os_upgrade_history(
resource_group_name="rgcompute",
vm_scale_set_name="aaaaaa",
)
for item in response:
print(item)
# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_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/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_NewGetOSUpgradeHistoryPager_virtualMachineScaleSetGetOsUpgradeHistoryMaximumSetGen() {
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)
}
pager := clientFactory.NewVirtualMachineScaleSetsClient().NewGetOSUpgradeHistoryPager("rgcompute", "aaaaaa", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.VirtualMachineScaleSetListOSUpgradeHistory = armcompute.VirtualMachineScaleSetListOSUpgradeHistory{
// Value: []*armcompute.UpgradeOperationHistoricalStatusInfo{
// {
// Type: to.Ptr("aaaaaaaaaaaaaaaaaaa"),
// Location: to.Ptr("aaaaaaaaaaaaa"),
// Properties: &armcompute.UpgradeOperationHistoricalStatusInfoProperties{
// 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"),
// }},
// },
// Progress: &armcompute.RollingUpgradeProgressInfo{
// FailedInstanceCount: to.Ptr[int32](25),
// InProgressInstanceCount: to.Ptr[int32](20),
// PendingInstanceCount: to.Ptr[int32](27),
// SuccessfulInstanceCount: to.Ptr[int32](6),
// },
// RollbackInfo: &armcompute.RollbackStatusInfo{
// FailedRolledbackInstanceCount: to.Ptr[int32](2),
// RollbackError: &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"),
// }},
// },
// SuccessfullyRolledbackInstanceCount: to.Ptr[int32](12),
// },
// RunningStatus: &armcompute.UpgradeOperationHistoryStatus{
// Code: to.Ptr(armcompute.UpgradeStateRollingForward),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T13:05:40.443Z"); return t}()),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-11-30T13:05:40.442Z"); return t}()),
// },
// StartedBy: to.Ptr(armcompute.UpgradeOperationInvokerUnknown),
// TargetImageReference: &armcompute.ImageReference{
// ID: to.Ptr("aaaaaaaaaaaaaaaaaaa"),
// ExactVersion: to.Ptr("aaaaaaa"),
// Offer: to.Ptr("WindowsServer"),
// Publisher: to.Ptr("MicrosoftWindowsServer"),
// SharedGalleryImageID: to.Ptr("aaaaaa"),
// SKU: to.Ptr("2016-Datacenter"),
// Version: to.Ptr("latest"),
// },
// },
// }},
// }
}
}
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 list of OS upgrades on a VM scale set instance.
*
* @summary Gets list of OS upgrades on a VM scale set instance.
* x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json
*/
async function virtualMachineScaleSetGetOSUpgradeHistoryMaximumSetGen() {
const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
const vmScaleSetName = "aaaaaa";
const credential = new DefaultAzureCredential();
const client = new ComputeManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.virtualMachineScaleSets.listOSUpgradeHistory(
resourceGroupName,
vmScaleSetName,
)) {
resArray.push(item);
}
console.log(resArray);
}
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.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;
// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSets_GetOSUpgradeHistory" 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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaa";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);
// invoke the operation and iterate over the result
await foreach (UpgradeOperationHistoricalStatusInfo item in virtualMachineScaleSet.GetOSUpgradeHistoryAsync())
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine("Succeeded");
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
{
"value": [
{
"properties": {
"runningStatus": {
"code": "RollingForward",
"startTime": "2021-11-30T13:05:40.442Z",
"endTime": "2021-11-30T13:05:40.443Z"
},
"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"
},
"startedBy": "Unknown",
"targetImageReference": {
"sku": "2016-Datacenter",
"publisher": "MicrosoftWindowsServer",
"version": "latest",
"offer": "WindowsServer",
"exactVersion": "aaaaaaa",
"sharedGalleryImageId": "aaaaaa",
"id": "aaaaaaaaaaaaaaaaaaa"
},
"rollbackInfo": {
"successfullyRolledbackInstanceCount": 12,
"failedRolledbackInstanceCount": 2,
"rollbackError": {
"details": [
{
"code": "aaaaaaaaaaaaaaaaaaaaaaaa",
"target": "aaaa",
"message": "aa"
}
],
"innererror": {
"exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"errordetail": "aaaaaaaaaaaaaaaaaaaaaaaa"
},
"code": "aaaaaaa",
"target": "aaaaaaa",
"message": "aaaaaaaaa"
}
}
},
"type": "aaaaaaaaaaaaaaaaaaa",
"location": "aaaaaaaaaaaaa"
}
],
"nextLink": "aaaaaaaaa"
}
VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen
Sample request
GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaa/osUpgradeHistory?api-version=2024-07-01
/**
* Samples for VirtualMachineScaleSets GetOSUpgradeHistory.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/
* virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json
*/
/**
* Sample code: VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void
virtualMachineScaleSetGetOSUpgradeHistoryMinimumSetGen(com.azure.resourcemanager.AzureResourceManager azure) {
azure.virtualMachines().manager().serviceClient().getVirtualMachineScaleSets().getOSUpgradeHistory("rgcompute",
"aaaaaaaaaaaaaaaaaaaaaaaaaa", 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_get_os_upgrade_history_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_sets.get_os_upgrade_history(
resource_group_name="rgcompute",
vm_scale_set_name="aaaaaaaaaaaaaaaaaaaaaaaaaa",
)
for item in response:
print(item)
# x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_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/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json
func ExampleVirtualMachineScaleSetsClient_NewGetOSUpgradeHistoryPager_virtualMachineScaleSetGetOsUpgradeHistoryMinimumSetGen() {
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)
}
pager := clientFactory.NewVirtualMachineScaleSetsClient().NewGetOSUpgradeHistoryPager("rgcompute", "aaaaaaaaaaaaaaaaaaaaaaaaaa", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.VirtualMachineScaleSetListOSUpgradeHistory = armcompute.VirtualMachineScaleSetListOSUpgradeHistory{
// Value: []*armcompute.UpgradeOperationHistoricalStatusInfo{
// {
// }},
// }
}
}
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 list of OS upgrades on a VM scale set instance.
*
* @summary Gets list of OS upgrades on a VM scale set instance.
* x-ms-original-file: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json
*/
async function virtualMachineScaleSetGetOSUpgradeHistoryMinimumSetGen() {
const subscriptionId = process.env["COMPUTE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["COMPUTE_RESOURCE_GROUP"] || "rgcompute";
const vmScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaa";
const credential = new DefaultAzureCredential();
const client = new ComputeManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.virtualMachineScaleSets.listOSUpgradeHistory(
resourceGroupName,
vmScaleSetName,
)) {
resArray.push(item);
}
console.log(resArray);
}
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.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;
// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-07-01/examples/virtualMachineScaleSetExamples/VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen.json
// this example is just showing the usage of "VirtualMachineScaleSets_GetOSUpgradeHistory" 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 VirtualMachineScaleSetResource created on azure
// for more information of creating VirtualMachineScaleSetResource, please refer to the document of VirtualMachineScaleSetResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "rgcompute";
string virtualMachineScaleSetName = "aaaaaaaaaaaaaaaaaaaaaaaaaa";
ResourceIdentifier virtualMachineScaleSetResourceId = VirtualMachineScaleSetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineScaleSetName);
VirtualMachineScaleSetResource virtualMachineScaleSet = client.GetVirtualMachineScaleSetResource(virtualMachineScaleSetResourceId);
// invoke the operation and iterate over the result
await foreach (UpgradeOperationHistoricalStatusInfo item in virtualMachineScaleSet.GetOSUpgradeHistoryAsync())
{
Console.WriteLine($"Succeeded: {item}");
}
Console.WriteLine("Succeeded");
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
{
"value": [
{}
]
}
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.
|
ImageReference
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.
| Name |
Type |
Description |
|
communityGalleryImageId
|
string
|
Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.
|
|
exactVersion
|
string
|
Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'.
|
|
id
|
string
|
Resource Id
|
|
offer
|
string
|
Specifies the offer of the platform image or marketplace image used to create the virtual machine.
|
|
publisher
|
string
|
The image publisher.
|
|
sharedGalleryImageId
|
string
|
Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.
|
|
sku
|
string
|
The image SKU.
|
|
version
|
string
|
Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input.
|
InnerError
Inner error details.
| Name |
Type |
Description |
|
errordetail
|
string
|
The internal error message or exception dump.
|
|
exceptiontype
|
string
|
The exception type.
|
RollbackStatusInfo
Information about rollback on failed VM instances after a OS Upgrade operation.
| Name |
Type |
Description |
|
failedRolledbackInstanceCount
|
integer
|
The number of instances which failed to rollback.
|
|
rollbackError
|
ApiError
|
Error details if OS rollback failed.
|
|
successfullyRolledbackInstanceCount
|
integer
|
The number of instances which have been successfully rolled back.
|
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.
|
UpgradeOperationHistoricalStatusInfo
Virtual Machine Scale Set OS Upgrade History operation response.
UpgradeOperationHistoricalStatusInfoProperties
Describes each OS upgrade on the Virtual Machine Scale Set.
UpgradeOperationHistoryStatus
Information about the current running state of the overall upgrade.
| Name |
Type |
Description |
|
code
|
UpgradeState
|
Code indicating the current status of the upgrade.
|
|
endTime
|
string
|
End time of the upgrade.
|
|
startTime
|
string
|
Start time of the upgrade.
|
UpgradeOperationInvoker
Invoker of the Upgrade Operation
| Name |
Type |
Description |
|
Platform
|
string
|
|
|
Unknown
|
string
|
|
|
User
|
string
|
|
UpgradeState
Code indicating the current status of the upgrade.
| Name |
Type |
Description |
|
Cancelled
|
string
|
|
|
Completed
|
string
|
|
|
Faulted
|
string
|
|
|
RollingForward
|
string
|
|
VirtualMachineScaleSetListOSUpgradeHistory
List of Virtual Machine Scale Set OS Upgrade History operation response.
| Name |
Type |
Description |
|
nextLink
|
string
|
The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.
|
|
value
|
UpgradeOperationHistoricalStatusInfo[]
|
The list of OS upgrades performed on the virtual machine scale set.
|