drill_runs

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

Overview

Name	drill_runs
Type	Resource
Id	azure.resilience_management.drill_runs

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.
attestation	string	Attestation of this Drill Run. Known values are: "Success" and "Failed". (Success, Failed)
currentActiveOperationId	string	The currently active operationID on this Drill Run. There can be only one active.
drillId	string	Parent Drill resource.
drillMode	string	Drill mode. "Failover" (Failover)
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.
executionConfigurations	object	Execution configurations for the job.
jobExtendedInfo	object	Additional information about the job.
jobType	string	Discriminator for the Job object hierarchy. Required. Drill Oober job which represents a given instance of Drill.
notes	array	Notes for this Drill.
operation	string	The operation that this job is intended to perform.
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)
supportedVerbsForStage	array	Matrix of Actions supported on Operations.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
triggeredBy	string	Indicates whether the job was triggered by the system or a user. Known values are: "System" and "User". (System, User)
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.
attestation	string	Attestation of this Drill Run. Known values are: "Success" and "Failed". (Success, Failed)
currentActiveOperationId	string	The currently active operationID on this Drill Run. There can be only one active.
drillId	string	Parent Drill resource.
drillMode	string	Drill mode. "Failover" (Failover)
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.
executionConfigurations	object	Execution configurations for the job.
jobExtendedInfo	object	Additional information about the job.
jobType	string	Discriminator for the Job object hierarchy. Required. Drill Oober job which represents a given instance of Drill.
notes	array	Notes for this Drill.
operation	string	The operation that this job is intended to perform.
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)
supportedVerbsForStage	array	Matrix of Actions supported on Operations.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
triggeredBy	string	Indicates whether the job was triggered by the system or a user. Known values are: "System" and "User". (System, User)
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, drill_name, drill_run_name		Get a DrillRun.
list	select	service_group_name, drill_name		List DrillRun resources by Drill.
fail_over	exec	service_group_name, drill_name, drill_run_name, operation-id, autoFailover, failoverProperties		This initiates a new Failover operation on this Drill Run.
reprotect	exec	service_group_name, drill_name, drill_run_name, operation-id		This initiates a new Reprotect operation on this Drill Run.
add_notes	exec	service_group_name, drill_name, drill_run_name, operation-id		This enables the user to add notes on this Drill Run.
resume	exec	service_group_name, drill_name, drill_run_name, operation-id		This unblocks a Failover workflow that is paused after the Fault stage, to proceed to the Failover stage.
mark_as_complete	exec	service_group_name, drill_name, drill_run_name, operation-id, drillRunStage		This enables the user to mark this stage as complete, disabling further retries on it.

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_run_name	string	The name of the DrillRun (GUID). Required.
operation-id	string	A GUID that represents the Long Running OperationId. Required.
service_group_name	string	The name of the service group. Required.

SELECT examples

get

Get a DrillRun.

SELECT
id,
name,
attestation,
currentActiveOperationId,
drillId,
drillMode,
duration,
endTime,
errorDetails,
executionConfigurations,
jobExtendedInfo,
jobType,
notes,
operation,
resourceId,
retryDetails,
startTime,
status,
supportedVerbsForStage,
systemData,
triggeredBy,
type,
userComments
FROM azure.resilience_management.drill_runs
WHERE service_group_name = '{{ service_group_name }}' -- required
AND drill_name = '{{ drill_name }}' -- required
AND drill_run_name = '{{ drill_run_name }}' -- required
;

list

List DrillRun resources by Drill.

SELECT
id,
name,
attestation,
currentActiveOperationId,
drillId,
drillMode,
duration,
endTime,
errorDetails,
executionConfigurations,
jobExtendedInfo,
jobType,
notes,
operation,
resourceId,
retryDetails,
startTime,
status,
supportedVerbsForStage,
systemData,
triggeredBy,
type,
userComments
FROM azure.resilience_management.drill_runs
WHERE service_group_name = '{{ service_group_name }}' -- required
AND drill_name = '{{ drill_name }}' -- required
;

Lifecycle Methods

fail_over

This initiates a new Failover operation on this Drill Run.

EXEC azure.resilience_management.drill_runs.fail_over 
@service_group_name='{{ service_group_name }}' --required, 
@drill_name='{{ drill_name }}' --required, 
@drill_run_name='{{ drill_run_name }}' --required, 
@operation-id='{{ operation-id }}' --required 
@@json=
'{
"autoFailover": "{{ autoFailover }}", 
"failoverProperties": "{{ failoverProperties }}"
}'
;

reprotect

This initiates a new Reprotect operation on this Drill Run.

EXEC azure.resilience_management.drill_runs.reprotect 
@service_group_name='{{ service_group_name }}' --required, 
@drill_name='{{ drill_name }}' --required, 
@drill_run_name='{{ drill_run_name }}' --required, 
@operation-id='{{ operation-id }}' --required
;

add_notes

This enables the user to add notes on this Drill Run.

EXEC azure.resilience_management.drill_runs.add_notes 
@service_group_name='{{ service_group_name }}' --required, 
@drill_name='{{ drill_name }}' --required, 
@drill_run_name='{{ drill_run_name }}' --required, 
@operation-id='{{ operation-id }}' --required 
@@json=
'{
"notes": "{{ notes }}"
}'
;

resume

This unblocks a Failover workflow that is paused after the Fault stage, to proceed to the Failover stage.

EXEC azure.resilience_management.drill_runs.resume 
@service_group_name='{{ service_group_name }}' --required, 
@drill_name='{{ drill_name }}' --required, 
@drill_run_name='{{ drill_run_name }}' --required, 
@operation-id='{{ operation-id }}' --required
;

mark_as_complete

This enables the user to mark this stage as complete, disabling further retries on it.

EXEC azure.resilience_management.drill_runs.mark_as_complete 
@service_group_name='{{ service_group_name }}' --required, 
@drill_name='{{ drill_name }}' --required, 
@drill_run_name='{{ drill_run_name }}' --required, 
@operation-id='{{ operation-id }}' --required 
@@json=
'{
"drillRunStage": "{{ drillRunStage }}"
}'
;