Virtual Machine Scale Sets - Get OS Upgrade History

Odwołanie

Service:: Compute

API Version:: 2024-03-01

Pobiera listę uaktualnień systemu operacyjnego w wystąpieniu zestawu skalowania maszyn wirtualnych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
vmScaleSetName	path	True	string	Nazwa zestawu skalowania maszyn wirtualnych.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	VirtualMachineScaleSetListOSUpgradeHistory	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

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

Sample Response

Status code:: 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

Sample Request

HTTP
Go

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

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

Sample Response

Status code:: 200

{
  "value": [
    {}
  ]
}

Definicje

Nazwa	Opis
ApiError	Błąd interfejsu API.
ApiErrorBase	Baza błędów interfejsu API.
CloudError	Odpowiedź na błąd z usługi Compute.
ImageReference	Określa informacje o obrazie do użycia. Można określić informacje o obrazach platformy, obrazach witryny Marketplace lub obrazach maszyn wirtualnych. Ten element jest wymagany, gdy chcesz użyć obrazu platformy, obrazu z witryny Marketplace lub obrazu maszyny wirtualnej, ale nie jest używany w innych operacjach tworzenia. UWAGA: Wydawca i oferta odwołania do obrazów można ustawić tylko podczas tworzenia zestawu skalowania.
InnerError	Szczegóły błędu wewnętrznego.
RollbackStatusInfo	Informacje o wycofywaniu wystąpień maszyn wirtualnych, które zakończyły się niepowodzeniem po operacji uaktualniania systemu operacyjnego.
RollingUpgradeProgressInfo	Informacje o liczbie wystąpień maszyn wirtualnych w każdym stanie uaktualniania.
UpgradeOperationHistoricalStatusInfo	Odpowiedź na operację Historia uaktualniania systemu operacyjnego zestawu skalowania maszyn wirtualnych.
UpgradeOperationHistoricalStatusInfoProperties	Opisuje każde uaktualnienie systemu operacyjnego w zestawie skalowania maszyn wirtualnych.
UpgradeOperationHistoryStatus	Informacje o bieżącym stanie działania ogólnego uaktualnienia.
UpgradeOperationInvoker	Wywołanie operacji uaktualniania
UpgradeState	Kod wskazujący bieżący stan uaktualnienia.
VirtualMachineScaleSetListOSUpgradeHistory	Lista odpowiedzi operacji historia uaktualniania systemu operacyjnego zestawu skalowania maszyn wirtualnych.

ApiError

Błąd interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	ApiErrorBase[]	Szczegóły błędu interfejsu API
innererror	InnerError	Wewnętrzny błąd interfejsu API
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

ApiErrorBase

Baza błędów interfejsu API.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy określonego błędu.

CloudError

Odpowiedź na błąd z usługi Compute.

Nazwa	Typ	Opis
error	ApiError	Błąd interfejsu API.

ImageReference

Określa informacje o obrazie do użycia. Można określić informacje o obrazach platformy, obrazach witryny Marketplace lub obrazach maszyn wirtualnych. Ten element jest wymagany, gdy chcesz użyć obrazu platformy, obrazu z witryny Marketplace lub obrazu maszyny wirtualnej, ale nie jest używany w innych operacjach tworzenia. UWAGA: Wydawca i oferta odwołania do obrazów można ustawić tylko podczas tworzenia zestawu skalowania.

Nazwa	Typ	Opis
communityGalleryImageId	string	Określono unikatowy identyfikator obrazu galerii społeczności dla wdrożenia maszyny wirtualnej. Można to pobrać z galerii społeczności— wywołanie GET obrazu.
exactVersion	string	Określa liczbę dziesiętną, wersję obrazu platformy lub obraz platformy handlowej użyty do utworzenia maszyny wirtualnej. To pole tylko do odczytu różni się od "wersji", tylko jeśli wartość określona w polu "version" to "latest".
id	string	Identyfikator zasobu
offer	string	Określa ofertę obrazu platformy lub obrazu platformy handlowej użytego do utworzenia maszyny wirtualnej.
publisher	string	Wydawca obrazów.
sharedGalleryImageId	string	Określono unikatowy identyfikator obrazu galerii udostępnionej dla wdrożenia maszyny wirtualnej. Można to pobrać z udostępnionego obrazu galerii WYWOŁAnie GET.
sku	string	Jednostka SKU obrazu.
version	string	Określa wersję obrazu platformy lub obrazu platformy handlowej użytego do utworzenia maszyny wirtualnej. Dozwolone formaty to Major.Minor.Build lub 'latest'. Główne, pomocnicze i kompilacja to liczby dziesiętne. Określ wartość "latest", aby użyć najnowszej wersji obrazu dostępnej w czasie wdrażania. Nawet jeśli używasz wartości "latest", obraz maszyny wirtualnej nie zostanie automatycznie zaktualizowany po czasie wdrażania, nawet jeśli nowa wersja stanie się dostępna. Nie używaj pola "version" do wdrożenia obrazu galerii. Obraz galerii powinien zawsze używać pola "id" do wdrożenia, aby użyć najnowszej wersji obrazu galerii, wystarczy ustawić wartość "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}" w polu "id" bez danych wejściowych wersji.

InnerError

Szczegóły błędu wewnętrznego.

Nazwa	Typ	Opis
errordetail	string	Wewnętrzny komunikat o błędzie lub zrzut wyjątku.
exceptiontype	string	Typ wyjątku.

RollbackStatusInfo

Informacje o wycofywaniu wystąpień maszyn wirtualnych, które zakończyły się niepowodzeniem po operacji uaktualniania systemu operacyjnego.

Nazwa	Typ	Opis
failedRolledbackInstanceCount	integer	Liczba wystąpień, których wycofanie nie powiodło się.
rollbackError	ApiError	Szczegóły błędu, jeśli wycofanie systemu operacyjnego nie powiodło się.
successfullyRolledbackInstanceCount	integer	Liczba wystąpień, które zostały pomyślnie wycofane.

RollingUpgradeProgressInfo

Informacje o liczbie wystąpień maszyn wirtualnych w każdym stanie uaktualniania.

Nazwa	Typ	Opis
failedInstanceCount	integer	Liczba wystąpień, których nie można pomyślnie uaktualnić.
inProgressInstanceCount	integer	Liczba wystąpień, które są obecnie uaktualniane.
pendingInstanceCount	integer	Liczba wystąpień, które nie zostały jeszcze uaktualnione.
successfulInstanceCount	integer	Liczba wystąpień, które zostały pomyślnie uaktualnione.

UpgradeOperationHistoricalStatusInfo

Odpowiedź na operację Historia uaktualniania systemu operacyjnego zestawu skalowania maszyn wirtualnych.

Nazwa	Typ	Opis
location	string	Lokalizacja zasobu
properties	UpgradeOperationHistoricalStatusInfoProperties	Informacje o właściwościach operacji uaktualniania.
type	string	Typ zasobu

UpgradeOperationHistoricalStatusInfoProperties

Opisuje każde uaktualnienie systemu operacyjnego w zestawie skalowania maszyn wirtualnych.

Nazwa	Typ	Opis
error	ApiError	Szczegóły błędu dotyczące tego uaktualnienia, jeśli istnieją.
progress	RollingUpgradeProgressInfo	Liczba maszyn wirtualnych w każdym stanie.
rollbackInfo	RollbackStatusInfo	Informacje o wycofywaniu systemu operacyjnego w przypadku wykonania
runningStatus	UpgradeOperationHistoryStatus	Informacje o ogólnym stanie operacji uaktualniania.
startedBy	UpgradeOperationInvoker	Wywołanie operacji uaktualniania
targetImageReference	ImageReference	Szczegóły odwołania do obrazu

UpgradeOperationHistoryStatus

Informacje o bieżącym stanie działania ogólnego uaktualnienia.

Nazwa	Typ	Opis
code	UpgradeState	Kod wskazujący bieżący stan uaktualnienia.
endTime	string	Godzina zakończenia uaktualniania.
startTime	string	Godzina rozpoczęcia uaktualniania.

UpgradeOperationInvoker

Wywołanie operacji uaktualniania

Nazwa	Typ	Opis
Platform	string
Unknown	string
User	string

UpgradeState

Kod wskazujący bieżący stan uaktualnienia.

Nazwa	Typ	Opis
Cancelled	string
Completed	string
Faulted	string
RollingForward	string

VirtualMachineScaleSetListOSUpgradeHistory

Lista odpowiedzi operacji historia uaktualniania systemu operacyjnego zestawu skalowania maszyn wirtualnych.

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI umożliwiający pobranie następnej strony historii uaktualniania systemu operacyjnego. Wywołaj metodę ListNext(), aby pobrać następną stronę historii uaktualnień.
value	UpgradeOperationHistoricalStatusInfo[]	Lista uaktualnień systemu operacyjnego wykonanych w zestawie skalowania maszyn wirtualnych.

Virtual Machine Scale Sets - Get OS Upgrade History

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen

Sample Request

Sample Response

VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen

Sample Request

Sample Response

Definicje

ApiError

ApiErrorBase

CloudError

ImageReference

InnerError

RollbackStatusInfo

RollingUpgradeProgressInfo

UpgradeOperationHistoricalStatusInfo

UpgradeOperationHistoricalStatusInfoProperties

UpgradeOperationHistoryStatus

UpgradeOperationInvoker

UpgradeState

VirtualMachineScaleSetListOSUpgradeHistory

Dodatkowe zasoby