drill_resources

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

Overview

Name	drill_resources
Type	Resource
Id	azure.resilience_management.drill_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.
activeLocations	array	Active location and zones of the Azure resource.
activePhysicalZones	array	Active Resource location and physical zones of Azure Resource.
advisorHaRecommendationId	string	Associated Advisor Recommendation link, if HA is not enabled on this resource.
advisorRecommendationTypeId	string	Recommendation Type Id for the recommendation.
attentionReason	object	Attention reason if the Status is 'NeedsAttention'.
faultProperties	object	Fault Properties.
faultState	string	Fault State of the Drill resource. Known values are: "SystemNative", "CustomScript", and "NotDefined". (SystemNative, CustomScript, NotDefined)
forceInclusionState	string	ForceInclusion status for this resource. Has the customer forceIncluded it?. Known values are: "Enable" and "Disable". (Enable, Disable)
haStatus	string	HA status of the Drill resource. Known values are: "Enabled" and "NotEnabled". (Enabled, NotEnabled)
inclusionState	string	Inclusion State of the Drill resource in Drill. Known values are: "Excluded" and "Included". (Excluded, Included)
monitoringRbacAssignmentError	object	Monitoring RBAC assignment error, if any.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
rbacAssignmentError	object	Last RBAC assignment error, if any.
readinessState	string	Readiness State of the Drill resource. Known values are: "Ready" and "NeedsAttention". (Ready, NeedsAttention)
recoveryLocations	array	List of recovery locations and zones of the Azure resource.
recoveryPhysicalZones	array	Recovery Resource location and physical zones of HA Azure Resource.
recoveryPlanExclusionReason	string	Exclusion reason of the Drill resource in Recovery Plan. Known values are: "ExcludedFromRecoveryPlan" and "ProtectionStatus". (ExcludedFromRecoveryPlan, ProtectionStatus)
recoveryPlanInclusionState	string	Inclusion State of the Drill resource in Recovery Plan. Known values are: "Included" and "Excluded". (Included, Excluded)
resourceId	string	ARM Id of the underlying resource. Required.
resourceProtectionSolutionType	string	Protection Solution Type of the Drill resource. Known values are: "None", "AzureNative", "AzureSiteRecovery", "CrossZoneVMRecovery", and "CustomRunbook". (None, AzureNative, AzureSiteRecovery, CrossZoneVMRecovery, CustomRunbook)
resourceType	string	Type of the Drill resource. Required.
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.
activeLocations	array	Active location and zones of the Azure resource.
activePhysicalZones	array	Active Resource location and physical zones of Azure Resource.
advisorHaRecommendationId	string	Associated Advisor Recommendation link, if HA is not enabled on this resource.
advisorRecommendationTypeId	string	Recommendation Type Id for the recommendation.
attentionReason	object	Attention reason if the Status is 'NeedsAttention'.
faultProperties	object	Fault Properties.
faultState	string	Fault State of the Drill resource. Known values are: "SystemNative", "CustomScript", and "NotDefined". (SystemNative, CustomScript, NotDefined)
forceInclusionState	string	ForceInclusion status for this resource. Has the customer forceIncluded it?. Known values are: "Enable" and "Disable". (Enable, Disable)
haStatus	string	HA status of the Drill resource. Known values are: "Enabled" and "NotEnabled". (Enabled, NotEnabled)
inclusionState	string	Inclusion State of the Drill resource in Drill. Known values are: "Excluded" and "Included". (Excluded, Included)
monitoringRbacAssignmentError	object	Monitoring RBAC assignment error, if any.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
rbacAssignmentError	object	Last RBAC assignment error, if any.
readinessState	string	Readiness State of the Drill resource. Known values are: "Ready" and "NeedsAttention". (Ready, NeedsAttention)
recoveryLocations	array	List of recovery locations and zones of the Azure resource.
recoveryPhysicalZones	array	Recovery Resource location and physical zones of HA Azure Resource.
recoveryPlanExclusionReason	string	Exclusion reason of the Drill resource in Recovery Plan. Known values are: "ExcludedFromRecoveryPlan" and "ProtectionStatus". (ExcludedFromRecoveryPlan, ProtectionStatus)
recoveryPlanInclusionState	string	Inclusion State of the Drill resource in Recovery Plan. Known values are: "Included" and "Excluded". (Included, Excluded)
resourceId	string	ARM Id of the underlying resource. Required.
resourceProtectionSolutionType	string	Protection Solution Type of the Drill resource. Known values are: "None", "AzureNative", "AzureSiteRecovery", "CrossZoneVMRecovery", and "CustomRunbook". (None, AzureNative, AzureSiteRecovery, CrossZoneVMRecovery, CustomRunbook)
resourceType	string	Type of the Drill resource. Required.
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, drill_name, drill_resource_name		Get a DrillResource.
list	select	service_group_name, drill_name	$skipToken, $top	List DrillResource resources by Drill.

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
drill_name	string	The name of the Drill. Required.
drill_resource_name	string	The name of the DrillResource (GUID). Required.
service_group_name	string	The name of the service group. Required.
$skipToken	string	Skip over when retrieving results. Default value is None.
$top	integer	Number of elements to return when retrieving results. Default value is None.

SELECT examples

get

Get a DrillResource.

SELECT
id,
name,
activeLocations,
activePhysicalZones,
advisorHaRecommendationId,
advisorRecommendationTypeId,
attentionReason,
faultProperties,
faultState,
forceInclusionState,
haStatus,
inclusionState,
monitoringRbacAssignmentError,
provisioningState,
rbacAssignmentError,
readinessState,
recoveryLocations,
recoveryPhysicalZones,
recoveryPlanExclusionReason,
recoveryPlanInclusionState,
resourceId,
resourceProtectionSolutionType,
resourceType,
systemData,
type
FROM azure.resilience_management.drill_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND drill_name = '{{ drill_name }}' -- required
AND drill_resource_name = '{{ drill_resource_name }}' -- required
;

list

List DrillResource resources by Drill.

SELECT
id,
name,
activeLocations,
activePhysicalZones,
advisorHaRecommendationId,
advisorRecommendationTypeId,
attentionReason,
faultProperties,
faultState,
forceInclusionState,
haStatus,
inclusionState,
monitoringRbacAssignmentError,
provisioningState,
rbacAssignmentError,
readinessState,
recoveryLocations,
recoveryPhysicalZones,
recoveryPlanExclusionReason,
recoveryPlanInclusionState,
resourceId,
resourceProtectionSolutionType,
resourceType,
systemData,
type
FROM azure.resilience_management.drill_resources
WHERE service_group_name = '{{ service_group_name }}' -- required
AND drill_name = '{{ drill_name }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;