DrillRunsOperations interface

Package:

@azure/arm-resiliencemanagement

Interface representing a DrillRuns operations.

Properties

addNotes	This enables the user to add notes on this Drill Run.
beginAddNotes
beginAddNotesAndWait
beginFailOver
beginFailOverAndWait
beginGenerateReport
beginGenerateReportAndWait
beginListReportDownloadUrl
beginListReportDownloadUrlAndWait
beginMarkAsComplete
beginMarkAsCompleteAndWait
beginReprotect
beginReprotectAndWait
beginResume
beginResumeAndWait
failOver	This initiates a new Failover operation on this Drill Run.
generateReport	This generates, or regenerates, the report for this Drill Run. The action is idempotent and is safe to call at any time: a call that arrives while a generation is already running joins it, and a call made after a failed attempt retries it. A report that has been finalized is never regenerated.
get	Get a DrillRun
list	List DrillRun resources by Drill
listReportDownloadUrl	This returns a short-lived, read-only URL to download the report for this Drill Run. The URL expires at the returned expiryTimestamp and grants access to that single report only.
markAsComplete	This enables the user to mark this stage as complete, disabling further retries on it.
reprotect	This initiates a new Reprotect operation on this Drill Run.
resume	This unblocks a Failover workflow that is paused after the Fault stage, to proceed to the Failover stage.

Property Details

addNotes

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

addNotes: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: DrillRunAddNotesRequest, options?: DrillRunsAddNotesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: DrillRunAddNotesRequest, options?: DrillRunsAddNotesOptionalParams) => PollerLike<OperationState<void>, void>

beginAddNotes

Warning

This API is now deprecated.

use addNotes instead

beginAddNotes: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: DrillRunAddNotesRequest, options?: DrillRunsAddNotesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: DrillRunAddNotesRequest, options?: DrillRunsAddNotesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginAddNotesAndWait

Warning

This API is now deprecated.

use addNotes instead

beginAddNotesAndWait: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: DrillRunAddNotesRequest, options?: DrillRunsAddNotesOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: DrillRunAddNotesRequest, options?: DrillRunsAddNotesOptionalParams) => Promise<void>

beginFailOver

Warning

This API is now deprecated.

use failOver instead

beginFailOver: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsFailOverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsFailOverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginFailOverAndWait

Warning

This API is now deprecated.

use failOver instead

beginFailOverAndWait: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsFailOverOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsFailOverOptionalParams) => Promise<void>

beginGenerateReport

Warning

This API is now deprecated.

use generateReport instead

beginGenerateReport: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsGenerateReportOptionalParams) => Promise<SimplePollerLike<OperationState<DrillReportSummary>, DrillReportSummary>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsGenerateReportOptionalParams) => Promise<SimplePollerLike<OperationState<DrillReportSummary>, DrillReportSummary>>

beginGenerateReportAndWait

Warning

This API is now deprecated.

use generateReport instead

beginGenerateReportAndWait: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsGenerateReportOptionalParams) => Promise<DrillReportSummary>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsGenerateReportOptionalParams) => Promise<DrillReportSummary>

beginListReportDownloadUrl

Warning

This API is now deprecated.

use listReportDownloadUrl instead

beginListReportDownloadUrl: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: ListReportDownloadUrlRequest, options?: DrillRunsListReportDownloadUrlOptionalParams) => Promise<SimplePollerLike<OperationState<ListReportDownloadUrlResponse>, ListReportDownloadUrlResponse>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: ListReportDownloadUrlRequest, options?: DrillRunsListReportDownloadUrlOptionalParams) => Promise<SimplePollerLike<OperationState<ListReportDownloadUrlResponse>, ListReportDownloadUrlResponse>>

beginListReportDownloadUrlAndWait

Warning

This API is now deprecated.

use listReportDownloadUrl instead

beginListReportDownloadUrlAndWait: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: ListReportDownloadUrlRequest, options?: DrillRunsListReportDownloadUrlOptionalParams) => Promise<ListReportDownloadUrlResponse>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: ListReportDownloadUrlRequest, options?: DrillRunsListReportDownloadUrlOptionalParams) => Promise<ListReportDownloadUrlResponse>

beginMarkAsComplete

Warning

This API is now deprecated.

use markAsComplete instead

beginMarkAsComplete: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: MarkAsCompleteRequest, options?: DrillRunsMarkAsCompleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: MarkAsCompleteRequest, options?: DrillRunsMarkAsCompleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginMarkAsCompleteAndWait

Warning

This API is now deprecated.

use markAsComplete instead

beginMarkAsCompleteAndWait: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: MarkAsCompleteRequest, options?: DrillRunsMarkAsCompleteOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: MarkAsCompleteRequest, options?: DrillRunsMarkAsCompleteOptionalParams) => Promise<void>

beginReprotect

Warning

This API is now deprecated.

use reprotect instead

beginReprotect: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsReprotectOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsReprotectOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginReprotectAndWait

Warning

This API is now deprecated.

use reprotect instead

beginReprotectAndWait: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsReprotectOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsReprotectOptionalParams) => Promise<void>

beginResume

Warning

This API is now deprecated.

use resume instead

beginResume: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsResumeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsResumeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginResumeAndWait

Warning

This API is now deprecated.

use resume instead

beginResumeAndWait: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsResumeOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsResumeOptionalParams) => Promise<void>

failOver

This initiates a new Failover operation on this Drill Run.

failOver: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsFailOverOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsFailOverOptionalParams) => PollerLike<OperationState<void>, void>

generateReport

This generates, or regenerates, the report for this Drill Run. The action is idempotent and is safe to call at any time: a call that arrives while a generation is already running joins it, and a call made after a failed attempt retries it. A report that has been finalized is never regenerated.

generateReport: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsGenerateReportOptionalParams) => PollerLike<OperationState<DrillReportSummary>, DrillReportSummary>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsGenerateReportOptionalParams) => PollerLike<OperationState<DrillReportSummary>, DrillReportSummary>

get

Get a DrillRun

get: (serviceGroupName: string, drillName: string, drillRunName: string, options?: DrillRunsGetOptionalParams) => Promise<DrillRun>

Property Value

(serviceGroupName: string, drillName: string, drillRunName: string, options?: DrillRunsGetOptionalParams) => Promise<DrillRun>

list

List DrillRun resources by Drill

list: (serviceGroupName: string, drillName: string, options?: DrillRunsListOptionalParams) => PagedAsyncIterableIterator<DrillRun, DrillRun[], PageSettings>

Property Value

(serviceGroupName: string, drillName: string, options?: DrillRunsListOptionalParams) => PagedAsyncIterableIterator<DrillRun, DrillRun[], PageSettings>

listReportDownloadUrl

This returns a short-lived, read-only URL to download the report for this Drill Run. The URL expires at the returned expiryTimestamp and grants access to that single report only.

listReportDownloadUrl: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: ListReportDownloadUrlRequest, options?: DrillRunsListReportDownloadUrlOptionalParams) => PollerLike<OperationState<ListReportDownloadUrlResponse>, ListReportDownloadUrlResponse>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: ListReportDownloadUrlRequest, options?: DrillRunsListReportDownloadUrlOptionalParams) => PollerLike<OperationState<ListReportDownloadUrlResponse>, ListReportDownloadUrlResponse>

markAsComplete

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

markAsComplete: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: MarkAsCompleteRequest, options?: DrillRunsMarkAsCompleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, body: MarkAsCompleteRequest, options?: DrillRunsMarkAsCompleteOptionalParams) => PollerLike<OperationState<void>, void>

reprotect

This initiates a new Reprotect operation on this Drill Run.

reprotect: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsReprotectOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsReprotectOptionalParams) => PollerLike<OperationState<void>, void>

resume

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

resume: (serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsResumeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, drillRunName: string, options?: DrillRunsResumeOptionalParams) => PollerLike<OperationState<void>, void>