Virtual Machine Scale Sets - Get OS Upgrade History

Dienst:

Compute

API-Version:

2024-03-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=2024-03-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
vmScaleSetName	path	True	string	Der Name des VM-Skalierungssatzes.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	VirtualMachineScaleSetListOSUpgradeHistory	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Beispielanforderung

HTTP

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

Python

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-03-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

Go

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

JavaScript

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-03-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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": "aaaaaaaaa"
}

VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen

Beispielanforderung

HTTP

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

Python

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-03-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

Go

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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

JavaScript

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-03-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Compute.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Compute;

// Generated from example definition: specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2024-03-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 des Computediensts.
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 Upgradevorgangs
UpgradeState	Code, der den aktuellen Status des Upgrades angibt.
VirtualMachineScaleSetListOSUpgradeHistory	Liste der Antwort auf den Vm Scale Set OS Upgrade History-Vorgang.

ApiError

API-Fehler.

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

ApiErrorBase

API-Fehlerbasis.

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

CloudError

Eine Fehlerantwort des Computediensts.

Name	Typ	Beschreibung
error	ApiError	API-Fehler.

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.

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 Bildherausgeber.
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. Verwenden Sie das Feld "Version" nicht für die Katalogimagebereitstellung, Galerieimage sollte immer das Feld "ID" für die Bereitstellung verwenden, um die neueste Version des Katalogimages zu verwenden, legen Sie einfach "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" im Feld "id" ohne Versionseingabe fest.

InnerError

Innere Fehlerdetails.

Name	Typ	Beschreibung
errordetail	string	Die interne Fehlermeldung oder das Ausnahmeabbild.
exceptiontype	string	Der Ausnahmetyp.

RollbackStatusInfo

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

Name	Typ	Beschreibung
failedRolledbackInstanceCount	integer	Die Anzahl der Instanzen, für die ein Rollback fehlgeschlagen ist.
rollbackError	ApiError	Fehlerdetails, wenn ein Betriebssystemrollback fehlgeschlagen ist.
successfullyRolledbackInstanceCount	integer	Die Anzahl der Instanzen, die erfolgreich zurückgesetzt wurden.

RollingUpgradeProgressInfo

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

Name	Typ	Beschreibung
failedInstanceCount	integer	Die Anzahl der Instanzen, die nicht erfolgreich aktualisiert werden konnten.
inProgressInstanceCount	integer	Die Anzahl der Instanzen, die derzeit aktualisiert werden.
pendingInstanceCount	integer	Die Anzahl der Instanzen, die noch nicht mit dem Upgrade begonnen haben.
successfulInstanceCount	integer	Die Anzahl der Instanzen, die erfolgreich aktualisiert wurden.

UpgradeOperationHistoricalStatusInfo

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

Beschreibt jedes Betriebssystemupgrade im Skalierungssatz für virtuelle Computer.

Name	Typ	Beschreibung
error	ApiError	Fehlerdetails für dieses Upgrade, falls vorhanden.
progress	RollingUpgradeProgressInfo	Zählt die VMs in jedem Zustand.
rollbackInfo	RollbackStatusInfo	Informationen zum Betriebssystemrollback bei Ausführung
runningStatus	UpgradeOperationHistoryStatus	Informationen zum Gesamtstatus des Upgradevorgangs.
startedBy	UpgradeOperationInvoker	Aufrufer des Upgradevorgangs
targetImageReference	ImageReference	Bildreferenzdetails

UpgradeOperationHistoryStatus

Informationen zum aktuellen Ausgeführten Status des gesamtupgrades.

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

UpgradeOperationInvoker

Aufrufer des Upgradevorgangs

Name	Typ	Beschreibung
Platform	string
Unknown	string
User	string

UpgradeState

Code, der den aktuellen Status des Upgrades angibt.

Name	Typ	Beschreibung
Cancelled	string
Completed	string
Faulted	string
RollingForward	string

VirtualMachineScaleSetListOSUpgradeHistory

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

Name	Typ	Beschreibung
nextLink	string	Der URI zum Abrufen der nächsten Seite des Betriebssystemupgradeverlaufs. Rufen Sie ListNext() mit dieser Aufzählung auf, um die nächste Seite des Verlaufs von Upgrades abzurufen.
value	UpgradeOperationHistoricalStatusInfo[]	Die Liste der Betriebssystemupgrades, die für den Skalierungssatz des virtuellen Computers ausgeführt wurden.