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

Job Details - Get

服务:

Recovery Services - Backup

API 版本:

2024-10-01

获取与作业关联的扩展信息。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}?api-version=2024-10-01

URI 参数

名称	在	必需	类型	说明
jobName	path	True	string	要提取其详细信息的作业的名称。
resourceGroupName	path	True	string	恢复服务保管库所在的资源组的名称。
subscriptionId	path	True	string	订阅 ID。
vaultName	path	True	string	恢复服务保管库的名称。
api-version	query	True	string	客户端 API 版本。

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户。

示例

Get Job Details

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000?api-version=2024-10-01

示例响应

状态代码:

200

{
  "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.RecoveryServices/vaults/backupJobs",
  "properties": {
    "jobType": "AzureIaaSVMJob",
    "duration": "PT9.8782791S",
    "virtualMachineVersion": "Compute",
    "extendedInfo": {
      "tasksList": [
        {
          "taskId": "Take Snapshot",
          "duration": "PT0S",
          "status": "InProgress"
        },
        {
          "taskId": "Transfer data to vault",
          "duration": "PT0S",
          "status": "NotStarted"
        }
      ],
      "propertyBag": {
        "VM Name": "testvm"
      }
    },
    "entityFriendlyName": "testvm",
    "backupManagementType": "AzureIaasVM",
    "operation": "Backup",
    "status": "InProgress",
    "startTime": "2017-08-03T05:31:07.014604Z",
    "activityId": "00000000-0000-0000-0000-000000000000"
  }
}

定义

名称	说明
AzureIaaSVMErrorInfo	特定于 Azure IaaS VM 工作负荷的错误信息。
AzureIaaSVMJob	特定于 Azure IaaS VM 工作负荷的作业对象。
AzureIaaSVMJobExtendedInfo	特定于 Azure IaaS VM 工作负荷的作业附加信息。
AzureIaaSVMJobTaskDetails	特定于 Azure IaaS VM 工作负荷的作业任务详细信息。
AzureIaaSVMJobV2	特定于 Azure IaaS VM 工作负荷的作业对象。
AzureStorageErrorInfo	Azure 存储特定的错误信息
AzureStorageJob	特定于 Azure 存储的作业。
AzureStorageJobExtendedInfo	特定于 Azure 存储工作负荷的作业附加信息。
AzureStorageJobTaskDetails	特定于 Azure 存储工作负荷的作业任务详细信息。
AzureWorkloadErrorInfo	Azure 存储特定的错误信息
AzureWorkloadJob	特定于 Azure 存储的作业。
AzureWorkloadJobExtendedInfo	特定于 Azure VM 工作负荷的作业的其他信息。
AzureWorkloadJobTaskDetails	特定于 Azure VM 工作负荷的作业任务详细信息。
BackupManagementType	备份项的备份管理类型。
CloudError	容器实例服务的错误响应。
CloudErrorBody	容器实例服务的错误响应。
DpmErrorInfo	DPM 特定于工作负荷的错误信息。
DpmJob	DPM 特定于工作负荷的作业对象。
DpmJobExtendedInfo	有关 DPM 工作负荷特定作业的其他信息。
DpmJobTaskDetails	DPM 特定于工作负荷的作业任务详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
JobResource	定义作业的工作负荷不可知属性。
JobSupportedAction	获取或设置适用于此作业的状态/操作，例如取消/重试。
MabErrorInfo	特定于 MAB 工作负荷的错误信息。
MabJob	特定于 MAB 工作负荷的作业。
MabJobExtendedInfo	特定于 MAB 工作负荷的作业的其他信息。
MabJobTaskDetails	特定于 MAB 工作负荷的作业任务详细信息。
MabServerType	MAB 容器的服务器类型。
VaultJob	保管库级别作业
VaultJobErrorInfo	保管库作业特定的错误信息
VaultJobExtendedInfo	CMK 的保管库作业 - 具有 CMK 特定信息。
WorkloadType	备份管理的工作负荷类型

AzureIaaSVMErrorInfo

特定于 Azure IaaS VM 工作负荷的错误信息。

名称	类型	说明
errorCode	integer	错误代码。
errorString	string	本地化的错误字符串。
errorTitle	string	标题：通常，错误所涉及的实体。
recommendations	string[]	上述错误代码的本地化建议列表。

AzureIaaSVMJob

特定于 Azure IaaS VM 工作负荷的作业对象。

名称	类型	说明
actionsInfo	JobSupportedAction[]	获取或设置适用于此作业的状态/操作，例如取消/重试。
activityId	string	作业的 ActivityId。
backupManagementType	BackupManagementType	用于执行当前作业的备份管理类型。
containerName	string	正在执行当前作业的实体的容器名称。
duration	string	执行此作业期间经过的时间。
endTime	string	结束时间。
entityFriendlyName	string	当前作业正在执行的实体的友好名称。
errorDetails	AzureIaaSVMErrorInfo[]	有关执行此作业的错误详细信息。
extendedInfo	AzureIaaSVMJobExtendedInfo	此作业的其他信息。
isUserTriggered	boolean	指示作业是临时作业（true）还是 scheduled（false）
jobType	string: AzureIaaSVMJob	此属性将用作用于确定类型多态链中特定类型的鉴别器。
operation	string	操作名称。
startTime	string	开始时间。
status	string	作业状态。
virtualMachineVersion	string	指定备份项是经典 VM 还是 Azure 资源管理器 VM。

AzureIaaSVMJobExtendedInfo

特定于 Azure IaaS VM 工作负荷的作业附加信息。

名称	类型	说明
dynamicErrorMessage	string	作业执行时出现非本地化错误消息。
estimatedRemainingDuration	string	此作业的执行剩余时间。
internalPropertyBag	object	作业内部属性。
progressPercentage	number	指示作业的进度。 如果尚未启动或完成，则为 Null。
propertyBag	object	作业属性。
tasksList	AzureIaaSVMJobTaskDetails[]	与此作业关联的任务列表。

AzureIaaSVMJobTaskDetails

特定于 Azure IaaS VM 工作负荷的作业任务详细信息。

名称	类型	说明
duration	string	任务用时。
endTime	string	结束时间。
instanceId	string	instanceId。
progressPercentage	number	任务的进度。
startTime	string	开始时间。
status	string	状态。
taskExecutionDetails	string	有关任务执行的详细信息。 例如：传输的字节数等
taskId	string	任务显示名称。

AzureIaaSVMJobV2

特定于 Azure IaaS VM 工作负荷的作业对象。

名称	类型	说明
actionsInfo	JobSupportedAction[]	获取或设置适用于此作业的状态/操作，例如取消/重试。
activityId	string	作业的 ActivityId。
backupManagementType	BackupManagementType	用于执行当前作业的备份管理类型。
containerName	string	正在执行当前作业的实体的容器名称。
duration	string	执行此作业期间经过的时间。
endTime	string	结束时间。
entityFriendlyName	string	当前作业正在执行的实体的友好名称。
errorDetails	AzureIaaSVMErrorInfo[]	有关执行此作业的错误详细信息。
extendedInfo	AzureIaaSVMJobExtendedInfo	此作业的其他信息。
jobType	string: AzureIaaSVMJobV2	此属性将用作用于确定类型多态链中特定类型的鉴别器。
operation	string	操作名称。
startTime	string	开始时间。
status	string	作业状态。
virtualMachineVersion	string	指定备份项是经典 VM 还是 Azure 资源管理器 VM。

AzureStorageErrorInfo

Azure 存储特定的错误信息

名称	类型	说明
errorCode	integer	错误代码。
errorString	string	本地化的错误字符串。
recommendations	string[]	上述错误代码的本地化建议列表。

AzureStorageJob

特定于 Azure 存储的作业。

名称	类型	说明
actionsInfo	JobSupportedAction[]	获取或设置适用于此作业的状态/操作，例如取消/重试。
activityId	string	作业的 ActivityId。
backupManagementType	BackupManagementType	用于执行当前作业的备份管理类型。
duration	string	执行此作业期间经过的时间。
endTime	string	结束时间。
entityFriendlyName	string	当前作业正在执行的实体的友好名称。
errorDetails	AzureStorageErrorInfo[]	有关执行此作业的错误详细信息。
extendedInfo	AzureStorageJobExtendedInfo	有关作业的其他信息。
isUserTriggered	boolean	指示作业是临时作业（true）还是 scheduled（false）
jobType	string: AzureStorageJob	此属性将用作用于确定类型多态链中特定类型的鉴别器。
operation	string	操作名称。
startTime	string	开始时间。
status	string	作业状态。
storageAccountName	string	指定存储帐户的友好名称。
storageAccountVersion	string	指定存储帐户是经典存储帐户还是 Azure 资源管理器存储帐户。

AzureStorageJobExtendedInfo

特定于 Azure 存储工作负荷的作业附加信息。

名称	类型	说明
dynamicErrorMessage	string	作业执行时出现非本地化错误消息。
propertyBag	object	作业属性。
tasksList	AzureStorageJobTaskDetails[]	此作业的任务列表

AzureStorageJobTaskDetails

特定于 Azure 存储工作负荷的作业任务详细信息。

名称	类型	说明
status	string	状态。
taskId	string	任务显示名称。

AzureWorkloadErrorInfo

Azure 存储特定的错误信息

名称	类型	说明
additionalDetails	string	上述错误代码的其他详细信息。
errorCode	integer	错误代码。
errorString	string	本地化的错误字符串。
errorTitle	string	标题：通常，错误所涉及的实体。
recommendations	string[]	上述错误代码的本地化建议列表。

AzureWorkloadJob

特定于 Azure 存储的作业。

名称	类型	说明
actionsInfo	JobSupportedAction[]	获取或设置适用于此作业的状态/操作，例如取消/重试。
activityId	string	作业的 ActivityId。
backupManagementType	BackupManagementType	用于执行当前作业的备份管理类型。
duration	string	执行此作业期间经过的时间。
endTime	string	结束时间。
entityFriendlyName	string	当前作业正在执行的实体的友好名称。
errorDetails	AzureWorkloadErrorInfo[]	有关执行此作业的错误详细信息。
extendedInfo	AzureWorkloadJobExtendedInfo	有关作业的其他信息。
jobType	string: AzureWorkloadJob	此属性将用作用于确定类型多态链中特定类型的鉴别器。
operation	string	操作名称。
startTime	string	开始时间。
status	string	作业状态。
workloadType	string	作业的工作负荷类型

AzureWorkloadJobExtendedInfo

特定于 Azure VM 工作负荷的作业的其他信息。

名称	类型	说明
dynamicErrorMessage	string	作业执行时出现非本地化错误消息。
propertyBag	object	作业属性。
tasksList	AzureWorkloadJobTaskDetails[]	此作业的任务列表

AzureWorkloadJobTaskDetails

特定于 Azure VM 工作负荷的作业任务详细信息。

名称	类型	说明
status	string	状态。
taskId	string	任务显示名称。

BackupManagementType

备份项的备份管理类型。

名称	类型	说明
AzureBackupServer	string
AzureIaasVM	string
AzureSql	string
AzureStorage	string
AzureWorkload	string
DPM	string
DefaultBackup	string
Invalid	string
MAB	string

CloudError

容器实例服务的错误响应。

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

CloudErrorBody

容器实例服务的错误响应。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。 例如，错误属性的名称。

DpmErrorInfo

DPM 特定于工作负荷的错误信息。

名称	类型	说明
errorString	string	本地化的错误字符串。
recommendations	string[]	上述错误代码的本地化建议列表。

DpmJob

DPM 特定于工作负荷的作业对象。

名称	类型	说明
actionsInfo	JobSupportedAction[]	适用于此作业的状态/操作，例如取消/重试。
activityId	string	作业的 ActivityId。
backupManagementType	BackupManagementType	用于执行当前作业的备份管理类型。
containerName	string	保护当前备份项的群集/服务器的名称（如果有）。
containerType	string	容器的类型。
dpmServerName	string	管理备份项或备份作业的 DPM 服务器名称。
duration	string	作业的时间。
endTime	string	结束时间。
entityFriendlyName	string	当前作业正在执行的实体的友好名称。
errorDetails	DpmErrorInfo[]	错误。
extendedInfo	DpmJobExtendedInfo	此作业的其他信息。
jobType	string: DpmJob	此属性将用作用于确定类型多态链中特定类型的鉴别器。
operation	string	操作名称。
startTime	string	开始时间。
status	string	作业状态。
workloadType	string	备份项的类型。

DpmJobExtendedInfo

有关 DPM 工作负荷特定作业的其他信息。

名称	类型	说明
dynamicErrorMessage	string	作业执行时出现非本地化错误消息。
propertyBag	object	作业属性。
tasksList	DpmJobTaskDetails[]	与此作业关联的任务列表。

DpmJobTaskDetails

DPM 特定于工作负荷的作业任务详细信息。

名称	类型	说明
duration	string	任务用时。
endTime	string	结束时间。
startTime	string	开始时间。
status	string	状态。
taskId	string	任务显示名称。

ErrorAdditionalInfo

资源管理错误附加信息。

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

JobResource

定义作业的工作负荷不可知属性。

名称	类型	说明
eTag	string	可选 ETag。
id	string	资源 ID 表示资源的完整路径。
location	string	资源位置。
name	string	与资源关联的资源名称。
properties	Job: AzureIaaSVMJob AzureIaaSVMJobV2 AzureStorageJob AzureWorkloadJob DpmJob MabJob VaultJob	JobResource 属性
tags	object	资源标记。
type	string	资源类型表示命名空间/ResourceType/ResourceType/...

JobSupportedAction

获取或设置适用于此作业的状态/操作，例如取消/重试。

名称	类型	说明
Cancellable	string
Invalid	string
Retriable	string

MabErrorInfo

特定于 MAB 工作负荷的错误信息。

名称	类型	说明
errorString	string	本地化的错误字符串。
recommendations	string[]	本地化建议的列表。

MabJob

特定于 MAB 工作负荷的作业。

名称	类型	说明
actionsInfo	JobSupportedAction[]	适用于作业的状态/操作，例如取消/重试。
activityId	string	作业的 ActivityId。
backupManagementType	BackupManagementType	用于执行当前作业的备份管理类型。
duration	string	作业运行所花费的时间。
endTime	string	结束时间。
entityFriendlyName	string	当前作业正在执行的实体的友好名称。
errorDetails	MabErrorInfo[]	错误。
extendedInfo	MabJobExtendedInfo	有关作业的其他信息。
jobType	string: MabJob	此属性将用作用于确定类型多态链中特定类型的鉴别器。
mabServerName	string	保护 DS 的服务器的名称。
mabServerType	MabServerType	MAB 容器的服务器类型。
operation	string	操作名称。
startTime	string	开始时间。
status	string	作业状态。
workloadType	WorkloadType	备份项的工作负荷类型。

MabJobExtendedInfo

特定于 MAB 工作负荷的作业的其他信息。

名称	类型	说明
dynamicErrorMessage	string	特定于此作业的非本地化错误消息。
propertyBag	object	作业属性。
tasksList	MabJobTaskDetails[]	此作业的任务列表。

MabJobTaskDetails

特定于 MAB 工作负荷的作业任务详细信息。

名称	类型	说明
duration	string	任务用时。
endTime	string	结束时间。
startTime	string	开始时间。
status	string	状态。
taskId	string	任务显示名称。

MabServerType

MAB 容器的服务器类型。

名称	类型	说明
AzureBackupServerContainer	string
AzureSqlContainer	string
Cluster	string
DPMContainer	string
GenericContainer	string
IaasVMContainer	string
IaasVMServiceContainer	string
Invalid	string
MABContainer	string
SQLAGWorkLoadContainer	string
StorageContainer	string
Unknown	string
VCenter	string
VMAppContainer	string
Windows	string

VaultJob

保管库级别作业

名称	类型	说明
actionsInfo	JobSupportedAction[]	获取或设置适用于此作业的状态/操作，例如取消/重试。
activityId	string	作业的 ActivityId。
backupManagementType	BackupManagementType	用于执行当前作业的备份管理类型。
duration	string	执行此作业期间经过的时间。
endTime	string	结束时间。
entityFriendlyName	string	当前作业正在执行的实体的友好名称。
errorDetails	VaultJobErrorInfo[]	有关执行此作业的错误详细信息。
extendedInfo	VaultJobExtendedInfo	有关作业的其他信息。
jobType	string: VaultJob	此属性将用作用于确定类型多态链中特定类型的鉴别器。
operation	string	操作名称。
startTime	string	开始时间。
status	string	作业状态。

VaultJobErrorInfo

保管库作业特定的错误信息

名称	类型	说明
errorCode	integer	错误代码。
errorString	string	本地化的错误字符串。
recommendations	string[]	上述错误代码的本地化建议列表。

VaultJobExtendedInfo

CMK 的保管库作业 - 具有 CMK 特定信息。

名称	类型	说明
propertyBag	object	作业属性。

WorkloadType

备份管理的工作负荷类型

名称	类型	说明
AzureFileShare	string
AzureSqlDb	string
Client	string
Exchange	string
FileFolder	string
GenericDataSource	string
Invalid	string
SAPAseDatabase	string
SAPHanaDBInstance	string
SAPHanaDatabase	string
SQLDB	string
SQLDataBase	string
Sharepoint	string
SystemState	string
VM	string
VMwareVM	string