你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Virtual Machine Scale Sets - Get OS Upgrade History

参考

Service:: Compute

API Version:: 2024-03-01

获取 VM 规模集实例上的 OS 升级列表。

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 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
vmScaleSetName	path	True	string	VM 规模集的名称。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	VirtualMachineScaleSetListOSUpgradeHistory	确定
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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	指定有关要使用的映像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但未在其他创建操作中使用，则此元素是必需的。注意：只能在创建规模集时设置映像引用发布者和产品/服务。
InnerError	内部错误详细信息。
RollbackStatusInfo	有关在 OS 升级操作后对失败的 VM 实例进行回滚的信息。
RollingUpgradeProgressInfo	有关处于每个升级状态的虚拟机实例数的信息。
UpgradeOperationHistoricalStatusInfo	虚拟机规模集 OS 升级历史记录操作响应。
UpgradeOperationHistoricalStatusInfoProperties	描述虚拟机规模集上的每次 OS 升级。
UpgradeOperationHistoryStatus	有关整体升级的当前运行状态的信息。
UpgradeOperationInvoker	升级操作的调用程序
UpgradeState	指示升级的当前状态的代码。
VirtualMachineScaleSetListOSUpgradeHistory	虚拟机规模集 OS 升级历史记录操作响应的列表。

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

指定有关要使用的映像的信息。可以指定有关平台映像、市场映像或虚拟机映像的信息。若要使用平台映像、市场映像或虚拟机映像，但未在其他创建操作中使用，则此元素是必需的。注意：只能在创建规模集时设置映像引用发布者和产品/服务。

名称	类型	说明
communityGalleryImageId	string	为 vm 部署指定了社区库映像的唯一 ID。这可以从社区库映像 GET 调用中提取。
exactVersion	string	以十进制数字指定用于创建虚拟机的平台映像或市场映像的版本。仅当“version”字段中指定的值为“latest”时，此只读字段与“version”不同。
id	string	资源 ID
offer	string	指定用于创建虚拟机的平台映像或市场映像的套餐。
publisher	string	映像发布者。
sharedGalleryImageId	string	指定 VM 部署的共享库映像唯一 ID。这可以从共享库映像 GET 调用中提取。
sku	string	映像 SKU。
version	string	指定用于创建虚拟机的平台映像或市场映像的版本。允许的格式为 Major.Minor.Build 或“latest”。 “主要”、“次要”和“生成”是十进制数。指定“latest”以使用部署时可用的最新版本的映像。即使使用“latest”，VM 映像也不会在部署后自动更新，即使新版本可用。请不要对库映像部署使用字段“版本”，库映像应始终使用“id”字段进行部署，若要使用库映像的“最新”版本，只需在“id”字段中设置“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}”，无需版本输入。

InnerError

内部错误详细信息。

名称	类型	说明
errordetail	string	内部错误消息或异常转储。
exceptiontype	string	异常类型。

RollbackStatusInfo

有关在 OS 升级操作后对失败的 VM 实例进行回滚的信息。

名称	类型	说明
failedRolledbackInstanceCount	integer	无法回滚的实例数。
rollbackError	ApiError	如果 OS 回滚失败，则返回错误详细信息。
successfullyRolledbackInstanceCount	integer	已成功回滚的实例数。

RollingUpgradeProgressInfo

有关处于每个升级状态的虚拟机实例数的信息。

名称	类型	说明
failedInstanceCount	integer	未能成功升级的实例数。
inProgressInstanceCount	integer	当前正在升级的实例数。
pendingInstanceCount	integer	尚未开始升级的实例数。
successfulInstanceCount	integer	已成功升级的实例数。

UpgradeOperationHistoricalStatusInfo

虚拟机规模集 OS 升级历史记录操作响应。

名称	类型	说明
location	string	资源位置
properties	UpgradeOperationHistoricalStatusInfoProperties	有关升级操作的属性的信息。
type	string	资源类型

UpgradeOperationHistoricalStatusInfoProperties

描述虚拟机规模集上的每次 OS 升级。

名称	类型	说明
error	ApiError	错误此升级的详细信息（如果有）。
progress	RollingUpgradeProgressInfo	处于每种状态的 VM 计数。
rollbackInfo	RollbackStatusInfo	有关执行 OS 回滚的信息
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

虚拟机规模集 OS 升级历史记录操作响应的列表。

名称	类型	说明
nextLink	string	用于获取 OS 升级历史记录的下一页的 URI。调用 ListNext () ，以获取升级历史记录的下一页。
value	UpgradeOperationHistoricalStatusInfo[]	在虚拟机规模集上执行的 OS 升级列表。

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

其他资源