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

Devices - Get Update Summary

根据设备的上次扫描获取有关更新可用性的信息。 它还获取有关设备上任何正在进行的下载或安装作业的信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default?api-version=2021-02-01

URI 参数

名称 必需 类型 说明
deviceName
path True

string

设备名称。

resourceGroupName
path True

string

资源组名称。

subscriptionId
path True

string

订阅的 ID。

api-version
query True

string

API 版本。

响应

名称 类型 说明
200 OK

UpdateSummary

更新摘要。

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

UpdateSummaryGet

示例请求

GET https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default?api-version=2021-02-01

示例响应

{
  "properties": {
    "deviceVersionNumber": "2.1.1377.2170",
    "friendlyDeviceVersionName": "Azure Stack Edge 2010",
    "deviceLastScannedDateTime": "2021-03-17T19:51:51.7864634Z",
    "lastCompletedScanJobDateTime": "2021-03-17T19:47:46.1595547Z",
    "lastDownloadJobStatus": "Invalid",
    "lastInstallJobStatus": "Invalid",
    "totalNumberOfUpdatesAvailable": 1,
    "totalNumberOfUpdatesPendingDownload": 1,
    "totalNumberOfUpdatesPendingInstall": 1,
    "rebootBehavior": "NeverReboots",
    "ongoingUpdateOperation": "Install",
    "updateTitles": [
      "Azure Stack Edge Update 2101 Package 1 of 2 for Pro-GPU, Pro R, Mini R"
    ],
    "totalUpdateSizeInBytes": 4260898192
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default",
  "name": "default",
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary"
}

定义

名称 说明
CloudError

来自服务的错误响应。

CloudErrorBody

来自服务的错误响应。

createdByType

创建资源的标识类型。

InstallationImpact

安装 updateType 的影响

InstallRebootBehavior

指示更新是否可用,并且至少一个更新需要重新启动。

JobStatus

作业的当前状态。

SystemData

与资源的创建和上次修改相关的元数据。

UpdateDetails

更新特定属性

UpdateOperation

当前更新操作。

UpdateStatus

更新的状态。

UpdateSummary

有关设备上正在进行的更新和更新可用性的详细信息。

UpdateType

更新的类型

CloudError

来自服务的错误响应。

名称 类型 说明
error

CloudErrorBody

错误详细信息。

CloudErrorBody

来自服务的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,该消息适用于在用户界面中显示。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

InstallationImpact

安装 updateType 的影响

名称 类型 说明
DeviceRebooted

string

KubernetesWorkloadsDown

string

None

string

InstallRebootBehavior

指示更新是否可用,并且至少一个更新需要重新启动。

名称 类型 说明
NeverReboots

string

RequestReboot

string

RequiresReboot

string

JobStatus

作业的当前状态。

名称 类型 说明
Canceled

string

Failed

string

Invalid

string

Paused

string

Running

string

Scheduled

string

Succeeded

string

SystemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

上次修改资源的标识类型。

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

UpdateDetails

更新特定属性

名称 类型 说明
estimatedInstallTimeInMins

integer

更新的估计安装时间

friendlyVersionNumber

string

友好版本号

installationImpact

InstallationImpact

安装 updateType 的影响

rebootBehavior

InstallRebootBehavior

指示更新是否可用,并且至少一个更新需要重新启动。

status

UpdateStatus

更新的状态。

targetVersion

string

目标版本号

updateSize

number

更新 (的大小(以字节为单位))

updateTitle

string

更新的标题

updateType

UpdateType

更新的类型

UpdateOperation

当前更新操作。

名称 类型 说明
Download

string

Install

string

None

string

Scan

string

UpdateStatus

更新的状态。

名称 类型 说明
DownloadCompleted

string

DownloadPending

string

DownloadStarted

string

InstallCompleted

string

InstallStarted

string

UpdateSummary

有关设备上正在进行的更新和更新可用性的详细信息。

名称 类型 说明
id

string

唯一标识对象的路径 ID。

name

string

对象名称。

properties.deviceLastScannedDateTime

string

上次在设备上执行扫描的时间。

properties.deviceVersionNumber

string

设备的当前版本,格式为:1.2.17312.13。”

properties.friendlyDeviceVersionName

string

当前版本的设备,采用文本格式。

properties.inProgressDownloadJobId

string

正在进行的下载作业的作业 ID。

properties.inProgressDownloadJobStartedDateTime

string

如果有任何) 启动,当前正在运行的下载 (的时间。

properties.inProgressInstallJobId

string

正在进行的安装作业的作业 ID。

properties.inProgressInstallJobStartedDateTime

string

当前运行的 安装的时间 ((如果有任何) 启动)。

properties.lastCompletedDownloadJobDateTime

string

上次下载作业完成的时间 (设备上成功/取消/失败) 的时间。

properties.lastCompletedDownloadJobId

string

上次运行的下载 job. (的 JobId 可以是成功/取消/失败)

properties.lastCompletedInstallJobDateTime

string

上次安装作业完成的时间 (设备上成功/取消/失败) 的时间。

properties.lastCompletedInstallJobId

string

上次运行的安装 job. (的 JobId 可以是成功/取消/失败)

properties.lastCompletedScanJobDateTime

string

上次扫描作业完成的时间 (设备上成功/取消/失败) 的时间。

properties.lastDownloadJobStatus

JobStatus

上次运行的下载作业的 JobStatus。

properties.lastInstallJobStatus

JobStatus

上次运行的安装作业的 JobStatus。

properties.lastSuccessfulInstallJobDateTime

string

设备上成功完成“上次安装”作业的时间

properties.lastSuccessfulScanJobTime

string

上次扫描作业成功完成的时间。

properties.ongoingUpdateOperation

UpdateOperation

当前更新操作。

properties.rebootBehavior

InstallRebootBehavior

指示更新是否可用,并且至少一个更新需要重新启动。

properties.totalNumberOfUpdatesAvailable

integer

根据上次设备扫描,当前设备版本的可用更新数。

properties.totalNumberOfUpdatesPendingDownload

integer

等待下载的项目总数。

properties.totalNumberOfUpdatesPendingInstall

integer

等待安装的项总数。

properties.totalTimeInMinutes

integer

总时间(以分钟为单位)

properties.totalUpdateSizeInBytes

number

可供下载的更新的总大小(以字节为单位)。

properties.updateTitles

string[]

可供安装的更新列表。

properties.updates

UpdateDetails[]

可供安装的更新列表。

systemData

SystemData

UpdateSummary 结果

type

string

对象的分层类型。

UpdateType

更新的类型

名称 类型 说明
Firmware

string

Kubernetes

string

Software

string