recovery_job_resources

Creates, updates, deletes, gets or lists a recovery_job_resources resource.

Overview

Name	recovery_job_resources
Type	Resource
Id	azure.resilience_management.recovery_job_resources

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
duration	string	The time elapsed during the execution of this job.
endTime	string (date-time)	The end time of the job execution.
errorDetails	object	Details of any errors that occurred during the execution of this job.
jobExtendedInfo	object	Additional information about the job.
jobId	string	Id of the Job under which this job-resource exists.
jobResourceType	string	Discriminator for the Job object hierarchy. Required. Recovery Orchestration Plan created job resource.
operation	string	The operation that this job is intended to perform.
protectionSolutionType	string	A setting that indicates the protection solution selected. Known values are: "None", "AzureNative", "AzureSiteRecovery", "CrossZoneVMRecovery", and "CustomRunbook". (None, AzureNative, AzureSiteRecovery, CrossZoneVMRecovery, CustomRunbook)
provisioningState	string	The provisioning state of the recovery job resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
recoveryGroupActionSettings	object	The recovery action settings.
resourceId	string	The resource for which this job was created. This is typically the resource that the job is intended to manage or operate on.
retryDetails	array	Details of any retries that have been attempted for this job.
startTime	string (date-time)	The start time of the job execution.
status	string	The current status of the job execution. Known values are: "NotApplicable", "NotStarted", "Pending", "InProgress", "Completed", "CompletedWithWarnings", "Failed", "Skipped", "Cancelling", "Cancelled", and "Paused". (NotApplicable, NotStarted, Pending, InProgress, Completed, CompletedWithWarnings, Failed, Skipped, Cancelling, Cancelled, Paused)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
taskId	string	Id of the job-task to which this job resource is associated.
taskName	string	Friendly name of the job-task to which this job resource is associated.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userComments	array	User Comments.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
duration	string	The time elapsed during the execution of this job.
endTime	string (date-time)	The end time of the job execution.
errorDetails	object	Details of any errors that occurred during the execution of this job.
jobExtendedInfo	object	Additional information about the job.
jobId	string	Id of the Job under which this job-resource exists.
jobResourceType	string	Discriminator for the Job object hierarchy. Required. Recovery Orchestration Plan created job resource.
operation	string	The operation that this job is intended to perform.
protectionSolutionType	string	A setting that indicates the protection solution selected. Known values are: "None", "AzureNative", "AzureSiteRecovery", "CrossZoneVMRecovery", and "CustomRunbook". (None, AzureNative, AzureSiteRecovery, CrossZoneVMRecovery, CustomRunbook)
provisioningState	string	The provisioning state of the recovery job resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
recoveryGroupActionSettings	object	The recovery action settings.
resourceId	string	The resource for which this job was created. This is typically the resource that the job is intended to manage or operate on.
retryDetails	array	Details of any retries that have been attempted for this job.
startTime	string (date-time)	The start time of the job execution.
status	string	The current status of the job execution. Known values are: "NotApplicable", "NotStarted", "Pending", "InProgress", "Completed", "CompletedWithWarnings", "Failed", "Skipped", "Cancelling", "Cancelled", and "Paused". (NotApplicable, NotStarted, Pending, InProgress, Completed, CompletedWithWarnings, Failed, Skipped, Cancelling, Cancelled, Paused)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
taskId	string	Id of the job-task to which this job resource is associated.
taskName	string	Friendly name of the job-task to which this job resource is associated.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userComments	array	User Comments.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_group_name, recovery_plan_name, recovery_job_name, recovery_job_resource_name		Get a RecoveryJobResource.
list	select	service_group_name, recovery_plan_name, recovery_job_name		List RecoveryJobResource resources by RecoveryJob.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
recovery_job_name	string	The unique name (GUID) of the recovery job. Required.
recovery_job_resource_name	string	The unique name (GUID) of the recovery job resource. Required.
recovery_plan_name	string	The name of the recovery orchestration plan. Required.
service_group_name	string	The name of the service group. Required.

SELECT examples

get

Get a RecoveryJobResource.

SELECT
id,
name,
duration,
endTime,
errorDetails,
jobExtendedInfo,
jobId,
jobResourceType,
operation,
protectionSolutionType,
provisioningState,
recoveryGroupActionSettings,
resourceId,
retryDetails,
startTime,
status,
systemData,
taskId,
taskName,
type,
userComments
FROM azure.resilience_management.recovery_job_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND recovery_plan_name = '{{ recovery_plan_name }}' -- required
AND recovery_job_name = '{{ recovery_job_name }}' -- required
AND recovery_job_resource_name = '{{ recovery_job_resource_name }}' -- required
;

list

List RecoveryJobResource resources by RecoveryJob.

SELECT
id,
name,
duration,
endTime,
errorDetails,
jobExtendedInfo,
jobId,
jobResourceType,
operation,
protectionSolutionType,
provisioningState,
recoveryGroupActionSettings,
resourceId,
retryDetails,
startTime,
status,
systemData,
taskId,
taskName,
type,
userComments
FROM azure.resilience_management.recovery_job_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND recovery_plan_name = '{{ recovery_plan_name }}' -- required
AND recovery_job_name = '{{ recovery_job_name }}' -- required
;