recovery_resources

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

Overview

Name	recovery_resources
Type	Resource
Id	azure.resilience_management.recovery_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.
associatedIdentity	object	Identity details associated to the resource, which will be used for performing any operations on it.
attentionReasons	array	Reason for the resource to be in need of attention.
errorDetails	object	Error details associated with the resource.
inclusionState	string	A state that indicates the resource status with respect to the recovery orchestration plan. Known values are: "Included" and "Excluded". (Included, Excluded)
needsAttention	boolean	Indicating if resource needs user attention and action, details will be found in attentionReasons.
protectionStatus	string	A status that indicates the protection status of a resource with an Azure solution for regional or zonal recovery. Known values are: "Unknown", "Protected", "NotProtected", and "HighlyAvailable". (Unknown, Protected, NotProtected, HighlyAvailable)
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
recoveryGroupId	string	The recovery orchestration group id associated with the recovery resources.
recoveryResourceUniqueId	string	A unique id for the recovery resource, which is a GUID. Required.
resourceId	string	Resource ID of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.
resourceLocation	string	Original location of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.
resourcePhysicalZones	array	Physical zones of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.
resourceProtectionSolutions	array	A list of ResourceProtectionSolutions with which the recovery orchestration resource is protected.
selectedProtectionSolutionSetting	object	Resource protection solution settings of the protection solutions recovery orchestration resource is protected with.
selectedProtectionSolutionType	string	A setting that indicates the protection solution selected. Known values are: "None", "AzureNative", "AzureSiteRecovery", "CrossZoneVMRecovery", and "CustomRunbook". (None, AzureNative, AzureSiteRecovery, CrossZoneVMRecovery, CustomRunbook)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
associatedIdentity	object	Identity details associated to the resource, which will be used for performing any operations on it.
attentionReasons	array	Reason for the resource to be in need of attention.
errorDetails	object	Error details associated with the resource.
inclusionState	string	A state that indicates the resource status with respect to the recovery orchestration plan. Known values are: "Included" and "Excluded". (Included, Excluded)
needsAttention	boolean	Indicating if resource needs user attention and action, details will be found in attentionReasons.
protectionStatus	string	A status that indicates the protection status of a resource with an Azure solution for regional or zonal recovery. Known values are: "Unknown", "Protected", "NotProtected", and "HighlyAvailable". (Unknown, Protected, NotProtected, HighlyAvailable)
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
recoveryGroupId	string	The recovery orchestration group id associated with the recovery resources.
recoveryResourceUniqueId	string	A unique id for the recovery resource, which is a GUID. Required.
resourceId	string	Resource ID of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.
resourceLocation	string	Original location of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.
resourcePhysicalZones	array	Physical zones of the Azure resource associated with the recovery orchestration plan and linked to the recovery resource.
resourceProtectionSolutions	array	A list of ResourceProtectionSolutions with which the recovery orchestration resource is protected.
selectedProtectionSolutionSetting	object	Resource protection solution settings of the protection solutions recovery orchestration resource is protected with.
selectedProtectionSolutionType	string	A setting that indicates the protection solution selected. Known values are: "None", "AzureNative", "AzureSiteRecovery", "CrossZoneVMRecovery", and "CustomRunbook". (None, AzureNative, AzureSiteRecovery, CrossZoneVMRecovery, CustomRunbook)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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_resource_name		Get a RecoveryResource.
list	select	service_group_name, recovery_plan_name		List RecoveryResource resources by RecoveryPlan.

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_plan_name	string	The name of the recovery orchestration plan. Required.
recovery_resource_name	string	The unique name (Guid) of the recovery resource. Required.
service_group_name	string	The name of the service group. Required.

SELECT examples

get

Get a RecoveryResource.

SELECT
id,
name,
associatedIdentity,
attentionReasons,
errorDetails,
inclusionState,
needsAttention,
protectionStatus,
provisioningState,
recoveryGroupId,
recoveryResourceUniqueId,
resourceId,
resourceLocation,
resourcePhysicalZones,
resourceProtectionSolutions,
selectedProtectionSolutionSetting,
selectedProtectionSolutionType,
systemData,
type
FROM azure.resilience_management.recovery_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND recovery_plan_name = '{{ recovery_plan_name }}' -- required
AND recovery_resource_name = '{{ recovery_resource_name }}' -- required
;

list

List RecoveryResource resources by RecoveryPlan.

SELECT
id,
name,
associatedIdentity,
attentionReasons,
errorDetails,
inclusionState,
needsAttention,
protectionStatus,
provisioningState,
recoveryGroupId,
recoveryResourceUniqueId,
resourceId,
resourceLocation,
resourcePhysicalZones,
resourceProtectionSolutions,
selectedProtectionSolutionSetting,
selectedProtectionSolutionType,
systemData,
type
FROM azure.resilience_management.recovery_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND recovery_plan_name = '{{ recovery_plan_name }}' -- required
;