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

Edge Device Jobs - Get

参考

服务:: Azure Stack HCI

API 版本:: 2024-09-01-preview

获取 EdgeDeviceJob

GET https://management.azure.com/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}?api-version=2024-09-01-preview

URI 参数

名称	在	必需	类型	说明
edgeDeviceName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	EdgeDevice 的名称
jobsName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	EdgeDevice 作业的名称
resourceUri	path	True	string	资源的完全限定的 Azure 资源管理器标识符。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	EdgeDeviceJob: HciEdgeDeviceJob	Azure 操作已成功完成。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

EdgeDeviceJobs_Get_RemoteSupport

示例请求

HTTP

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/-5M1G7G10OZ-o5b-HS3-c72/jobs/-oUxs?api-version=2024-09-01-preview

示例响应

状态代码:: 200

{
  "properties": {
    "jobType": "RemoteSupport",
    "accessLevel": "Diagnostics",
    "type": "Enable",
    "expirationTimestamp": "2024-01-29T10:43:27.9471574Z"
  },
  "kind": "HCI",
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/RemoteSupport",
  "name": "collectLog",
  "type": "Microsoft.AzureStackHCI/edgeDevices/jobs",
  "systemData": {
    "createdBy": "zsnvvvbj",
    "createdByType": "User",
    "createdAt": "2024-07-01T17:02:21.168Z",
    "lastModifiedBy": "qxlrx",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-07-01T17:02:21.168Z"
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
DeploymentMode	用于触发作业的部署模式。
DeploymentStep	AzureStackHCI 群集的步骤。
DeviceLogCollectionStatus	表示日志收集操作的状态。
EceActionStatus	AzureStackHCI 群集的 ECE 行动计划部署状态。
EdgeDeviceKind	Edge 设备类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
HciCollectLogJobProperties	表示 HCI 收集日志作业的属性。
HciEdgeDeviceJob	Azure Stack HCI 解决方案的 Edge 设备作业。
HciEdgeDeviceJobType	支持作业类型。
HciRemoteSupportJobProperties	表示 HCI 远程支持作业的属性。
JobStatus	表示作业在其整个生命周期内可以具有的各种状态。
LogCollectionJobSession	表示用于从边缘设备收集日志的会话。
LogCollectionReportedProperties	表示日志收集作业的报告属性。
ProvisioningState	资源的预配状态。
RemoteSupportAccessLevel	定义授予的远程支持访问权限级别。
RemoteSupportJobNodeSettings	表示远程支持节点的设置。
RemoteSupportJobReportedProperties	表示远程支持作业的报告属性。
RemoteSupportSession	表示远程支持会话。
RemoteSupportType	定义要在边缘设备上执行的远程支持操作的类型。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DeploymentMode

枚举

用于触发作业的部署模式。

值	说明
Deploy	为群集部署 ECE 操作部署。
Validate	验证群集的 ECE 操作部署。

DeploymentStep

Object

AzureStackHCI 群集的步骤。

名称	类型	说明
description	string	步骤说明。
endTimeUtc	string	步骤结束时间。
exception	string[]	AzureStackHCI 群集部署中的异常列表。
fullStepIndex	string	步骤的 FullStepIndex。
name	string	步骤的名称。
startTimeUtc	string	步骤开始时间。
status	string	步骤的状态。允许的值为“Error”、“Success”、“InProgress”
steps	DeploymentStep[]	AzureStackHCI 群集部署的嵌套步骤列表。

DeviceLogCollectionStatus

枚举

表示日志收集操作的状态。

值	说明
Canceled	指示日志收集操作已成功完成。
Failed	指示日志收集操作失败。
NotStarted	日志收集操作尚未启动。
Running	指示日志收集操作当前正在运行。
Succeeded	指示日志收集操作已成功完成。

EceActionStatus

Object

AzureStackHCI 群集的 ECE 行动计划部署状态。

名称	类型	说明
status	string	ECE 操作 AzureStackHCI 群集部署的状态。
steps	DeploymentStep[]	AzureStackHCI 群集部署的步骤列表。

EdgeDeviceKind

枚举

Edge 设备类型。

值	说明
HCI	已启用 Arc 的边缘设备与 HCI OS。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

HciCollectLogJobProperties

Object

表示 HCI 收集日志作业的属性。

名称	类型	说明
deploymentMode	DeploymentMode	用于触发作业的部署模式。
endTimeUtc	string (date-time)	作业完成的 UTC 日期和时间。
fromDate	string (date-time)	日志收集的日期。
jobId	string	唯一的不可变作业 ID。
jobType	string: CollectLog	支持多态资源的作业类型。
lastLogGenerated	string (date-time)	日志收集的日期。
provisioningState	ProvisioningState	作业预配状态
reportedProperties	LogCollectionReportedProperties	日志收集作业报告属性。
startTimeUtc	string (date-time)	作业启动的 UTC 日期和时间。
status	JobStatus	Edge 设备作业的状态。
toDate	string (date-time)	日志收集的日期。

HciEdgeDeviceJob

Object

Azure Stack HCI 解决方案的 Edge 设备作业。

名称	类型	默认值	说明
id	string (arm-id)		资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
kind	string: HCI	HCI	支持多态资源的边缘解决方案类型。
name	string		资源的名称
properties	HciEdgeDeviceJobProperties: HciCollectLogJobProperties HciRemoteSupportJobProperties		HCI Edge 设备作业属性
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string		资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

HciEdgeDeviceJobType

枚举

支持作业类型。

值	说明
CollectLog	从设备收集日志的作业。
RemoteSupport	为设备提供远程支持的作业。

HciRemoteSupportJobProperties

Object

表示 HCI 远程支持作业的属性。

名称	类型	说明
accessLevel	RemoteSupportAccessLevel	远程支持访问级别。
deploymentMode	DeploymentMode	用于触发作业的部署模式。
endTimeUtc	string (date-time)	作业完成的 UTC 日期和时间。
expirationTimestamp	string (date-time)	远程支持过期时间戳。
jobId	string	唯一的不可变作业 ID。
jobType	string: RemoteSupport	支持多态资源的作业类型。
provisioningState	ProvisioningState	作业预配状态
reportedProperties	RemoteSupportJobReportedProperties	日志收集作业报告属性。
startTimeUtc	string (date-time)	作业启动的 UTC 日期和时间。
status	JobStatus	Edge 设备作业的状态。
type	RemoteSupportType	远程支持类型。

JobStatus

枚举

表示作业在其整个生命周期内可以具有的各种状态。

值	说明
Canceled	作业已取消。
DeploymentFailed	作业的部署失败。
DeploymentInProgress	作业的部署当前正在进行中。
DeploymentSuccess	作业已成功部署。
Failed	作业失败。
NotSpecified	尚未指定作业状态。
Paused	作业已暂停。
Scheduled	作业计划运行。
Succeeded	作业已成功。
ValidationFailed	作业验证失败。
ValidationInProgress	作业当前正在进行验证。
ValidationSuccess	作业已成功通过验证。

LogCollectionJobSession

Object

表示用于从边缘设备收集日志的会话。

名称	类型	说明
correlationId	string	用于将此日志收集会话与其他操作或会话相关联的唯一标识符。
endTime	string	日志收集结束时的时间戳，格式为 ISO 8601。
logSize	integer (int32)	收集的日志的大小（以字节为单位）。
startTime	string	日志收集启动时的时间戳，采用 ISO 8601 格式。
status	DeviceLogCollectionStatus	日志收集会话的状态。
timeCollected	string	收集了 ISO 8601 持续时间格式的总时间日志。

LogCollectionReportedProperties

Object

表示日志收集作业的报告属性。

名称	类型	说明
deploymentStatus	EceActionStatus	作业的部署状态。
logCollectionSessionDetails	LogCollectionJobSession[]	日志收集会话的详细信息。
percentComplete	integer (int32)	已完成的作业的百分比。
validationStatus	EceActionStatus	作业的验证状态。

ProvisioningState

枚举

资源的预配状态。

值	说明
Accepted	已接受资源创建请求
Canceled	资源创建已取消。
Deleting	正在删除资源
Failed	资源创建失败。
NotSpecified	未指定资源预配状态
Provisioning	正在预配资源
Succeeded	已创建资源。
Updating	资源正在更新

RemoteSupportAccessLevel

枚举

定义授予的远程支持访问权限级别。

值	说明
Diagnostics	访问权限仅限于诊断信息。
DiagnosticsAndRepair	Access 包括诊断信息和执行修复的能力。
None	未授予远程支持访问权限。

RemoteSupportJobNodeSettings

Object

表示远程支持节点的设置。

名称	类型	说明
connectionErrorMessage	string	来自上次连接尝试的错误消息（如果有）。
connectionStatus	string	远程支持会话的当前连接状态。
createdAt	string (date-time)	以 UTC 格式创建节点设置时的时间戳。
state	string	远程支持节点的状态。
updatedAt	string (date-time)	上次更新节点设置时的时间戳，采用 UTC 格式。

RemoteSupportJobReportedProperties

Object

表示远程支持作业的报告属性。

名称	类型	说明
deploymentStatus	EceActionStatus	作业的部署状态。
nodeSettings	RemoteSupportJobNodeSettings	用于为远程支持配置节点的可选设置。
percentComplete	integer (int32)	已完成的作业的百分比。
sessionDetails	RemoteSupportSession[]	远程支持会话的详细信息。
validationStatus	EceActionStatus	作业的验证状态。

RemoteSupportSession

Object

表示远程支持会话。

名称	类型	说明
accessLevel	RemoteSupportAccessLevel	在远程支持会话期间授予的访问权限级别。
sessionEndTime	string (date-time)	远程支持会话的结束时间（UTC）。
sessionId	string	唯一会话 ID。
sessionStartTime	string (date-time)	远程支持会话的开始时间（UTC）。
transcriptLocation	string	存储会话脚本的位置。

RemoteSupportType

枚举

定义要在边缘设备上执行的远程支持操作的类型。

值	说明
Enable	启用边缘设备的远程支持。
Revoke	撤销以前授予边缘设备的远程支持访问权限。

systemData

Object

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Edge Device Jobs - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

EdgeDeviceJobs_Get_RemoteSupport

示例请求

示例响应

定义

createdByType

DeploymentMode

DeploymentStep

DeviceLogCollectionStatus

EceActionStatus

EdgeDeviceKind

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HciCollectLogJobProperties

HciEdgeDeviceJob

HciEdgeDeviceJobType

HciRemoteSupportJobProperties

JobStatus

LogCollectionJobSession

LogCollectionReportedProperties

ProvisioningState

RemoteSupportAccessLevel

RemoteSupportJobNodeSettings

RemoteSupportJobReportedProperties

RemoteSupportSession

RemoteSupportType

systemData