Virtual Machine Scale Sets - Get OS Upgrade History

Dienst:: Compute

API-Version:: 2025-11-01

Ruft eine Liste der Betriebssystemupgrades auf einer VM-Skalierungssatzinstanz ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory?api-version=2025-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
vmScaleSetName	path	True	string	Der Name des VM-Skalierungssatzes.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineScaleSetListOSUpgradeHistory	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen

VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen

VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaa/osUpgradeHistory?api-version=2025-11-01

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/Compute/stable/2025-11-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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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": "a://example.com/aaaaaaaaa"
}

VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen

Beispielanforderung

HTTP
dotnet

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaa/osUpgradeHistory?api-version=2025-11-01

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/Compute/stable/2025-11-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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {}
  ]
}

Definitionen

Name	Beschreibung
ApiError	API-Fehler.
ApiErrorBase	API-Fehlerbasis.
CloudError	Eine Fehlerantwort vom Compute-Dienst.
ImageReference	Gibt Informationen zum zu verwendenden Bild an. Sie können Informationen zu Plattformimages, Marketplace-Images oder virtuellen Computerimages angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein virtuelles Computerimage verwenden möchten, aber nicht in anderen Erstellungsvorgängen verwendet wird. HINWEIS: Der Herausgeber und das Angebot für Bildreferenzen können nur festgelegt werden, wenn Sie den Skalierungssatz erstellen.
InnerError	Innere Fehlerdetails.
RollbackStatusInfo	Informationen zum Rollback bei fehlgeschlagenen VM-Instanzen nach einem Betriebssystemupgradevorgang.
RollingUpgradeProgressInfo	Informationen zur Anzahl der Instanzen des virtuellen Computers in jedem Upgradestatus.
UpgradeOperationHistoricalStatusInfo	Antwort auf den Vm Scale Set OS Upgrade History-Vorgang.
UpgradeOperationHistoricalStatusInfoProperties	Beschreibt jedes Betriebssystemupgrade im Skalierungssatz für virtuelle Computer.
UpgradeOperationHistoryStatus	Informationen zum aktuellen Ausgeführten Status des gesamtupgrades.
UpgradeOperationInvoker	Aufrufer des Upgrade-Vorgangs
UpgradeState	Code, der den aktuellen Status des Upgrades angibt.
VirtualMachineScaleSetListOSUpgradeHistory	Liste der Antwort auf den Vm Scale Set OS Upgrade History-Vorgang.

ApiError

Objekt

API-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ApiErrorBase[]	Die Details zum API-Fehler
innererror	InnerError	Der innere API-Fehler
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

ApiErrorBase

Objekt

API-Fehlerbasis.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
message	string	Die Fehlermeldung.
target	string	Das Ziel des bestimmten Fehlers.

CloudError

Objekt

Eine Fehlerantwort vom Compute-Dienst.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

ImageReference

Objekt

Gibt Informationen zum zu verwendenden Bild an. Sie können Informationen zu Plattformimages, Marketplace-Images oder virtuellen Computerimages angeben. Dieses Element ist erforderlich, wenn Sie ein Plattformimage, ein Marketplace-Image oder ein virtuelles Computerimage verwenden möchten, aber nicht in anderen Erstellungsvorgängen verwendet wird. HINWEIS: Der Herausgeber und das Angebot für Bildreferenzen können nur festgelegt werden, wenn Sie den Skalierungssatz erstellen.

Name	Typ	Beschreibung
communityGalleryImageId	string	Gibt die eindeutige ID des Communitykatalogimages für die Vm-Bereitstellung an. Dies kann aus dem Community gallery Image GET-Anruf abgerufen werden.
exactVersion	string	Gibt in Dezimalzahlen die Version des Plattformimages oder des Marketplace-Images an, das zum Erstellen des virtuellen Computers verwendet wird. Dieses Readonly-Feld unterscheidet sich von "version", nur wenn der im Feld "Version" angegebene Wert "latest" lautet.
id	string	Ressourcen-ID
offer	string	Gibt das Angebot des Plattformimages oder des Marketplace-Images an, das zum Erstellen des virtuellen Computers verwendet wird.
publisher	string	Der Image publisher.
sharedGalleryImageId	string	Gibt die eindeutige ID des freigegebenen Katalogimages für die Vm-Bereitstellung an. Dies kann aus dem GET-Aufruf des freigegebenen Katalogbilds abgerufen werden.
sku	string	Die Bild-SKU.
version	string	Gibt die Version des Plattformimages oder Marketplace-Images an, mit dem der virtuelle Computer erstellt wird. Die zulässigen Formate sind Major.Minor.Build oder "latest". Haupt-, Neben- und Buildwerte sind Dezimalzahlen. Geben Sie "neueste" an, um die neueste Version eines Images zu verwenden, das zur Bereitstellungszeit verfügbar ist. Auch wenn Sie "latest" verwenden, wird das VM-Image nach der Bereitstellung nicht automatisch aktualisiert, auch wenn eine neue Version verfügbar ist. Bitte verwenden Sie das Feld 'version' nicht für die Bereitstellung von Galeriebildern, das Galeriebild sollte für die Bereitstellung immer das Feld 'id' verwenden; um die 'neueste' Version des Galerie-Images zu verwenden, setzen Sie einfach '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. Compute/galleries/{galleryName}/images/{imageName}' im Feld 'id' ohne Versionseingabe.

InnerError

Objekt

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder der Ausnahmedump.
exceptiontype	string	Der Ausnahmetyp.

RollbackStatusInfo

Objekt

Informationen zum Rollback bei fehlgeschlagenen VM-Instanzen nach einem Betriebssystemupgradevorgang.

Name	Typ	Beschreibung
failedRolledbackInstanceCount	integer (int32)	Die Anzahl der Instanzen, für die kein Rollback durchgeführt werden konnte.
rollbackError	ApiError	Fehlerdetails, wenn das Zurücksetzen des Betriebssystems fehlgeschlagen ist.
successfullyRolledbackInstanceCount	integer (int32)	Die Anzahl der Instanzen, für die ein Rollback ausgeführt wurde.

RollingUpgradeProgressInfo

Objekt

Informationen zur Anzahl der Instanzen des virtuellen Computers in jedem Upgradestatus.

Name	Typ	Beschreibung
failedInstanceCount	integer (int32)	Die Anzahl der Instanzen, die nicht erfolgreich aktualisiert werden konnten.
inProgressInstanceCount	integer (int32)	Die Anzahl der Instances, die derzeit aktualisiert werden.
pendingInstanceCount	integer (int32)	Die Anzahl der Instances, für die noch nicht mit dem Upgrade begonnen wurde.
successfulInstanceCount	integer (int32)	Die Anzahl der Instanzen, die erfolgreich aktualisiert wurden.

UpgradeOperationHistoricalStatusInfo

Objekt

Antwort auf den Vm Scale Set OS Upgrade History-Vorgang.

Name	Typ	Beschreibung
location	string	Ressourcenspeicherort
properties	UpgradeOperationHistoricalStatusInfoProperties	Informationen zu den Eigenschaften des Upgradevorgangs.
type	string	Ressourcentyp

UpgradeOperationHistoricalStatusInfoProperties

Objekt

Beschreibt jedes Betriebssystemupgrade im Skalierungssatz für virtuelle Computer.

Name	Typ	Beschreibung
error	ApiError	Fehlerdetails für dieses Upgrade, falls vorhanden.
progress	RollingUpgradeProgressInfo	Anzahl der VMs in jedem Status.
rollbackInfo	RollbackStatusInfo	Informationen zum Rollback des Betriebssystems, falls durchgeführt
runningStatus	UpgradeOperationHistoryStatus	Informationen über den Gesamtstatus des Upgradevorgangs.
startedBy	UpgradeOperationInvoker	Aufrufer des Upgrade-Vorgangs
targetImageReference	ImageReference	Details zur Bildreferenz

UpgradeOperationHistoryStatus

Objekt

Informationen zum aktuellen Ausgeführten Status des gesamtupgrades.

Name	Typ	Beschreibung
code	UpgradeState	Code, der den aktuellen Status des Upgrades angibt.
endTime	string (date-time)	Endzeit des Upgrades.
startTime	string (date-time)	Startzeit des Upgrades.

UpgradeOperationInvoker

Enumeration

Aufrufer des Upgrade-Vorgangs

Wert	Beschreibung
Unknown
User
Platform

UpgradeState

Enumeration

Code, der den aktuellen Status des Upgrades angibt.

Wert	Beschreibung
RollingForward
Cancelled
Completed
Faulted

VirtualMachineScaleSetListOSUpgradeHistory

Objekt

Liste der Antwort auf den Vm Scale Set OS Upgrade History-Vorgang.

Name	Typ	Beschreibung
nextLink	string (uri)	Der URI zum Abrufen der nächsten Seite des Betriebssystemupgradeverlaufs. Rufen Sie ListNext() mit diesem auf, um die nächste Seite der Versionsgeschichte abzurufen.
value	UpgradeOperationHistoricalStatusInfo[]	Die Liste der Betriebssystemupgrades, die für die VM-Skalierungsgruppe ausgeführt wurden.