Virtual Machine Scale Sets - Get OS Upgrade History

Ссылка

Service:: Compute

API Version:: 2024-03-01

Возвращает список обновлений ОС в экземпляре масштабируемого набора виртуальных машин.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
vmScaleSetName	path	True	string	Имя масштабируемого набора виртуальных машин.
api-version	query	True	string	Версия API клиента.

Ответы

Имя	Тип	Описание
200 OK	VirtualMachineScaleSetListOSUpgradeHistory	ОК
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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": [
    {}
  ]
}

Определения

Имя	Описание
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
CloudError	Ответ об ошибке от службы вычислений.
ImageReference	Указывает сведения об используемом образе. Вы можете указать сведения об образах платформы, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на образы и предложение можно задать только при создании масштабируемого набора.
InnerError	Сведения о внутренней ошибке.
RollbackStatusInfo	Сведения об откате для экземпляров виртуальных машин, завершилось сбоем после операции обновления ОС.
RollingUpgradeProgressInfo	Сведения о количестве экземпляров виртуальных машин в каждом состоянии обновления.
UpgradeOperationHistoricalStatusInfo	Ответ операции обновления ос в масштабируемом наборе виртуальных машин.
UpgradeOperationHistoricalStatusInfoProperties	Описывает каждое обновление ОС в масштабируемом наборе виртуальных машин.
UpgradeOperationHistoryStatus	Сведения о текущем состоянии выполнения общего обновления.
UpgradeOperationInvoker	Вызов операции обновления
UpgradeState	Код, указывающий текущее состояние обновления.
VirtualMachineScaleSetListOSUpgradeHistory	Список ответов на операцию обновления ос в масштабируемом наборе виртуальных машин.

ApiError

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке API
innererror	InnerError	Внутренняя ошибка API
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

База ошибок API.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

CloudError

Ответ об ошибке от службы вычислений.

Имя	Тип	Описание
error	ApiError	Ошибка API.

ImageReference

Указывает сведения об используемом образе. Вы можете указать сведения об образах платформы, образах Marketplace или виртуальных машинах. Этот элемент является обязательным, если вы хотите использовать образ платформы, образ Marketplace или образ виртуальной машины, но не используется в других операциях создания. ПРИМЕЧАНИЕ. Издатель ссылок на образы и предложение можно задать только при создании масштабируемого набора.

Имя	Тип	Описание
communityGalleryImageId	string	Указан уникальный идентификатор образа коллекции сообщества для развертывания виртуальной машины. Его можно получить из коллекции сообщества образ GET call.
exactVersion	string	Указывает в десятичных числах версию образа платформы или образа Marketplace, используемую для создания виртуальной машины. Это поле только для чтения отличается от "version" только в том случае, если значение, указанное в поле "версия", равно "latest".
id	string	Идентификатор ресурса
offer	string	Указывает предложение образа платформы или образа Marketplace, используемого для создания виртуальной машины.
publisher	string	Издатель образа.
sharedGalleryImageId	string	Указан уникальный идентификатор образа общей коллекции для развертывания виртуальной машины. Его можно получить из вызова GET образа общей коллекции.
sku	string	Номер SKU образа.
version	string	Указывает версию образа платформы или образа Marketplace, используемого для создания виртуальной машины. Допустимые форматы: Major.Minor.Build или latest. Основной, Дополнительный и Сборка являются десятичными числами. Укажите "latest", чтобы использовать последнюю версию образа, доступную во время развертывания. Даже если вы используете последнюю версию, образ виртуальной машины не будет автоматически обновляться после развертывания, даже если станет доступна новая версия. Не используйте поле "версия" для развертывания образа коллекции. Образ коллекции всегда должен использовать поле id для развертывания, чтобы использовать "последнюю" версию образа коллекции, просто задайте "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageName}" в поле id без ввода версии.

InnerError

Сведения о внутренней ошибке.

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.

RollbackStatusInfo

Сведения об откате для экземпляров виртуальных машин, завершилось сбоем после операции обновления ОС.

Имя	Тип	Описание
failedRolledbackInstanceCount	integer	Число экземпляров, для которых не удалось выполнить откат.
rollbackError	ApiError	Сведения об ошибке, если произошел сбой отката ОС.
successfullyRolledbackInstanceCount	integer	Количество экземпляров, для которых был успешно выполнен откат.

RollingUpgradeProgressInfo

Сведения о количестве экземпляров виртуальных машин в каждом состоянии обновления.

Имя	Тип	Описание
failedInstanceCount	integer	Число экземпляров, которые не удалось обновить.
inProgressInstanceCount	integer	Количество экземпляров, которые в настоящее время обновляются.
pendingInstanceCount	integer	Количество экземпляров, которые еще не начали обновляться.
successfulInstanceCount	integer	Количество экземпляров, которые были успешно обновлены.

UpgradeOperationHistoricalStatusInfo

Ответ операции обновления ос в масштабируемом наборе виртуальных машин.

Имя	Тип	Описание
location	string	Расположение ресурса
properties	UpgradeOperationHistoricalStatusInfoProperties	Сведения о свойствах операции обновления.
type	string	Тип ресурса

UpgradeOperationHistoricalStatusInfoProperties

Описывает каждое обновление ОС в масштабируемом наборе виртуальных машин.

Имя	Тип	Описание
error	ApiError	Сведения об ошибке для этого обновления, если таковые имеются.
progress	RollingUpgradeProgressInfo	Количество виртуальных машин в каждом состоянии.
rollbackInfo	RollbackStatusInfo	Сведения о откате ОС при выполнении
runningStatus	UpgradeOperationHistoryStatus	Сведения об общем состоянии операции обновления.
startedBy	UpgradeOperationInvoker	Вызов операции обновления
targetImageReference	ImageReference	Справочные сведения об изображении

UpgradeOperationHistoryStatus

Сведения о текущем состоянии выполнения общего обновления.

Имя	Тип	Описание
code	UpgradeState	Код, указывающий текущее состояние обновления.
endTime	string	Время окончания обновления.
startTime	string	Время начала обновления.

UpgradeOperationInvoker

Вызов операции обновления

Имя	Тип	Описание
Platform	string
Unknown	string
User	string

UpgradeState

Код, указывающий текущее состояние обновления.

Имя	Тип	Описание
Cancelled	string
Completed	string
Faulted	string
RollingForward	string

VirtualMachineScaleSetListOSUpgradeHistory

Список ответов на операцию обновления ос в масштабируемом наборе виртуальных машин.

Имя	Тип	Описание
nextLink	string	Универсальный код ресурса (URI) для получения следующей страницы журнала обновления ОС. Вызовите ListNext() с этим параметром, чтобы получить следующую страницу журнала обновлений.
value	UpgradeOperationHistoricalStatusInfo[]	Список обновлений ОС, выполненных в масштабируемом наборе виртуальных машин.

Virtual Machine Scale Sets - Get OS Upgrade History

Параметры URI

Ответы

Безопасность

azure_auth

Scopes

Примеры

VirtualMachineScaleSet_GetOSUpgradeHistory_MaximumSet_Gen

Sample Request

Sample Response

VirtualMachineScaleSet_GetOSUpgradeHistory_MinimumSet_Gen

Sample Request

Sample Response

Определения

ApiError

ApiErrorBase

CloudError

ImageReference

InnerError

RollbackStatusInfo

RollingUpgradeProgressInfo

UpgradeOperationHistoricalStatusInfo

UpgradeOperationHistoricalStatusInfoProperties

UpgradeOperationHistoryStatus

UpgradeOperationInvoker

UpgradeState

VirtualMachineScaleSetListOSUpgradeHistory

Дополнительные ресурсы