你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Backup Crr Jobs - List
Gets the list of CRR jobs from the target region.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrJobs?api-version=2023-01-15
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrJobs?api-version=2023-01-15&$filter={$filter}&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
azure
|
path | True |
string |
Azure region to hit Api |
subscription
|
path | True |
string |
The subscription Id. |
api-version
|
query | True |
string |
Client Api Version. |
$filter
|
query |
string |
OData filter options. |
|
$skip
|
query |
string |
skipToken Filter. |
Request Body
Name | Type | Description |
---|---|---|
jobName |
string |
Job Name of the job to be fetched |
resourceId |
string |
Entire ARM resource id of the resource |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account. |
Examples
List Cross Region Restore Jobs in the secondary region
Sample Request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.RecoveryServices/locations/southeastasia/backupCrrJobs?api-version=2023-01-15
{
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm",
"jobName": "02585cc9-d7f4-4b46-860c-14c048cce178"
}
Sample Response
{
"value": [
{
"id": "/subscriptions/f2edfd5d-5496-4683-b94f-b3588c579009/providers/microsoft.recoveryservices/locations/eastus2euap/backupJobs/02585cc9-d7f4-4b46-860c-14c048cce178",
"name": "02585cc9-d7f4-4b46-860c-14c048cce178",
"type": "Microsoft.RecoveryServices/vaults/backupJobs",
"properties": {
"jobType": "AzureIaaSVMJob",
"virtualMachineVersion": "Compute",
"entityFriendlyName": "sriniccylinux",
"backupManagementType": "AzureIaasVM",
"operation": "CrossRegionRestore",
"status": "InProgress",
"startTime": "2019-10-12T10:22:43.9139656Z",
"activityId": "6e503ee3-1093-4a83-a62a-3b666cc8c028-2019-10-12T10:22:43Z-Ibz"
}
}
]
}
Definitions
Name | Description |
---|---|
Azure |
Azure IaaS VM workload-specific error information. |
Azure |
Azure IaaS VM workload-specific job object. |
Azure |
Azure IaaS VM workload-specific additional information for job. |
Azure |
Azure IaaS VM workload-specific job task details. |
Azure |
Azure storage specific error information |
Azure |
Azure storage specific job. |
Azure |
Azure Storage workload-specific additional information for job. |
Azure |
Azure storage workload specific job task details. |
Azure |
Azure storage specific error information |
Azure |
Azure storage specific job. |
Azure |
Azure VM workload-specific additional information for job. |
Azure |
Azure VM workload specific job task details. |
Backup |
Type of backup management for the backed up item. |
Crr |
Request object for fetching CRR jobs. |
Dpm |
DPM workload-specific error information. |
Dpm |
DPM workload-specific job object. |
Dpm |
Additional information on the DPM workload-specific job. |
Dpm |
DPM workload-specific job task details. |
Error |
The error object. |
Error |
The resource management error additional info. |
Job |
Defines workload agnostic properties for a job. |
Job |
List of Job resources |
Job |
Gets or sets the state/actions applicable on this job like cancel/retry. |
Mab |
MAB workload-specific error information. |
Mab |
MAB workload-specific job. |
Mab |
Additional information for the MAB workload-specific job. |
Mab |
MAB workload-specific job task details. |
Mab |
Server type of MAB container. |
New |
The resource management error response. |
Workload |
Workload type of backup item. |
AzureIaaSVMErrorInfo
Azure IaaS VM workload-specific error information.
Name | Type | Description |
---|---|---|
errorCode |
integer |
Error code. |
errorString |
string |
Localized error string. |
errorTitle |
string |
Title: Typically, the entity that the error pertains to. |
recommendations |
string[] |
List of localized recommendations for above error code. |
AzureIaaSVMJob
Azure IaaS VM workload-specific job object.
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string |
Time elapsed during the execution of this job. |
endTime |
string |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information for this job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string |
The start time. |
status |
string |
Job status. |
virtualMachineVersion |
string |
Specifies whether the backup item is a Classic or an Azure Resource Manager VM. |
AzureIaaSVMJobExtendedInfo
Azure IaaS VM workload-specific additional information for job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
estimatedRemainingDuration |
string |
Time remaining for execution of this job. |
internalPropertyBag |
object |
Job internal properties. |
progressPercentage |
number |
Indicates progress of the job. Null if it has not started or completed. |
propertyBag |
object |
Job properties. |
tasksList |
List of tasks associated with this job. |
AzureIaaSVMJobTaskDetails
Azure IaaS VM workload-specific job task details.
Name | Type | Description |
---|---|---|
duration |
string |
Time elapsed for task. |
endTime |
string |
The end time. |
instanceId |
string |
The instanceId. |
progressPercentage |
number |
Progress of the task. |
startTime |
string |
The start time. |
status |
string |
The status. |
taskExecutionDetails |
string |
Details about execution of the task. eg: number of bytes transferred etc |
taskId |
string |
The task display name. |
AzureStorageErrorInfo
Azure storage specific error information
Name | Type | Description |
---|---|---|
errorCode |
integer |
Error code. |
errorString |
string |
Localized error string. |
recommendations |
string[] |
List of localized recommendations for above error code. |
AzureStorageJob
Azure storage specific job.
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string |
Time elapsed during the execution of this job. |
endTime |
string |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information about the job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string |
The start time. |
status |
string |
Job status. |
storageAccountName |
string |
Specifies friendly name of the storage account. |
storageAccountVersion |
string |
Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage account. |
AzureStorageJobExtendedInfo
Azure Storage workload-specific additional information for job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
propertyBag |
object |
Job properties. |
tasksList |
List of tasks for this job |
AzureStorageJobTaskDetails
Azure storage workload specific job task details.
Name | Type | Description |
---|---|---|
status |
string |
The status. |
taskId |
string |
The task display name. |
AzureWorkloadErrorInfo
Azure storage specific error information
Name | Type | Description |
---|---|---|
additionalDetails |
string |
Additional details for above error code. |
errorCode |
integer |
Error code. |
errorString |
string |
Localized error string. |
errorTitle |
string |
Title: Typically, the entity that the error pertains to. |
recommendations |
string[] |
List of localized recommendations for above error code. |
AzureWorkloadJob
Azure storage specific job.
Name | Type | Description |
---|---|---|
actionsInfo |
Gets or sets the state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string |
Time elapsed during the execution of this job. |
endTime |
string |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
Error details on execution of this job. |
|
extendedInfo |
Additional information about the job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string |
The start time. |
status |
string |
Job status. |
workloadType |
string |
Workload type of the job |
AzureWorkloadJobExtendedInfo
Azure VM workload-specific additional information for job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
propertyBag |
object |
Job properties. |
tasksList |
List of tasks for this job |
AzureWorkloadJobTaskDetails
Azure VM workload specific job task details.
Name | Type | Description |
---|---|---|
status |
string |
The status. |
taskId |
string |
The task display name. |
BackupManagementType
Type of backup management for the backed up item.
Name | Type | Description |
---|---|---|
AzureBackupServer |
string |
|
AzureIaasVM |
string |
|
AzureSql |
string |
|
AzureStorage |
string |
|
AzureWorkload |
string |
|
DPM |
string |
|
DefaultBackup |
string |
|
Invalid |
string |
|
MAB |
string |
CrrJobRequest
Request object for fetching CRR jobs.
Name | Type | Description |
---|---|---|
jobName |
string |
Job Name of the job to be fetched |
resourceId |
string |
Entire ARM resource id of the resource |
DpmErrorInfo
DPM workload-specific error information.
Name | Type | Description |
---|---|---|
errorString |
string |
Localized error string. |
recommendations |
string[] |
List of localized recommendations for above error code. |
DpmJob
DPM workload-specific job object.
Name | Type | Description |
---|---|---|
actionsInfo |
The state/actions applicable on this job like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
containerName |
string |
Name of cluster/server protecting current backup item, if any. |
containerType |
string |
Type of container. |
dpmServerName |
string |
DPM server name managing the backup item or backup job. |
duration |
string |
Time elapsed for job. |
endTime |
string |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
The errors. |
|
extendedInfo |
Additional information for this job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
operation |
string |
The operation name. |
startTime |
string |
The start time. |
status |
string |
Job status. |
workloadType |
string |
Type of backup item. |
DpmJobExtendedInfo
Additional information on the DPM workload-specific job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message on job execution. |
propertyBag |
object |
The job properties. |
tasksList |
List of tasks associated with this job. |
DpmJobTaskDetails
DPM workload-specific job task details.
Name | Type | Description |
---|---|---|
duration |
string |
Time elapsed for task. |
endTime |
string |
The end time. |
startTime |
string |
The start time. |
status |
string |
The status. |
taskId |
string |
The task display name. |
Error
The error object.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
JobResource
Defines workload agnostic properties for a job.
Name | Type | Description |
---|---|---|
eTag |
string |
Optional ETag. |
id |
string |
Resource Id represents the complete path to the resource. |
location |
string |
Resource location. |
name |
string |
Resource name associated with the resource. |
properties | Job: |
JobResource properties |
tags |
object |
Resource tags. |
type |
string |
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... |
JobResourceList
List of Job resources
Name | Type | Description |
---|---|---|
nextLink |
string |
The uri to fetch the next page of resources. Call ListNext() fetches next page of resources. |
value |
List of resources. |
JobSupportedAction
Gets or sets the state/actions applicable on this job like cancel/retry.
Name | Type | Description |
---|---|---|
Cancellable |
string |
|
Invalid |
string |
|
Retriable |
string |
MabErrorInfo
MAB workload-specific error information.
Name | Type | Description |
---|---|---|
errorString |
string |
Localized error string. |
recommendations |
string[] |
List of localized recommendations. |
MabJob
MAB workload-specific job.
Name | Type | Description |
---|---|---|
actionsInfo |
The state/actions applicable on jobs like cancel/retry. |
|
activityId |
string |
ActivityId of job. |
backupManagementType |
Backup management type to execute the current job. |
|
duration |
string |
Time taken by job to run. |
endTime |
string |
The end time. |
entityFriendlyName |
string |
Friendly name of the entity on which the current job is executing. |
errorDetails |
The errors. |
|
extendedInfo |
Additional information on the job. |
|
jobType | string: |
This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. |
mabServerName |
string |
Name of server protecting the DS. |
mabServerType |
Server type of MAB container. |
|
operation |
string |
The operation name. |
startTime |
string |
The start time. |
status |
string |
Job status. |
workloadType |
Workload type of backup item. |
MabJobExtendedInfo
Additional information for the MAB workload-specific job.
Name | Type | Description |
---|---|---|
dynamicErrorMessage |
string |
Non localized error message specific to this job. |
propertyBag |
object |
The job properties. |
tasksList |
List of tasks for this job. |
MabJobTaskDetails
MAB workload-specific job task details.
Name | Type | Description |
---|---|---|
duration |
string |
Time elapsed for task. |
endTime |
string |
The end time. |
startTime |
string |
The start time. |
status |
string |
The status. |
taskId |
string |
The task display name. |
MabServerType
Server type of MAB container.
Name | Type | Description |
---|---|---|
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 |
NewErrorResponse
The resource management error response.
Name | Type | Description |
---|---|---|
error |
The error object. |
WorkloadType
Workload type of backup item.
Name | Type | Description |
---|---|---|
AzureFileShare |
string |
|
AzureSqlDb |
string |
|
Client |
string |
|
Exchange |
string |
|
FileFolder |
string |
|
GenericDataSource |
string |
|
Invalid |
string |
|
SAPAseDatabase |
string |
|
SAPHanaDatabase |
string |
|
SQLDB |
string |
|
SQLDataBase |
string |
|
Sharepoint |
string |
|
SystemState |
string |
|
VM |
string |
|
VMwareVM |
string |