DrillsOperations interface

Interface representing a Drills operations.

Properties

addOrUpdateResources

This enables the user to include, exclude or update resources from their Drill.

beginAddOrUpdateResources
beginAddOrUpdateResourcesAndWait
beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginEnd
beginEndAndWait
beginResyncReadinessCheck
beginResyncReadinessCheckAndWait
beginStart
beginStartAndWait
beginUpdate
beginUpdateAndWait
beginValidateForExecution
beginValidateForExecutionAndWait
create

Create a Drill

delete

Delete a Drill

end

This ends the currently running instance of the Drill.

get

Get a Drill

list

List Drill resources by tenant

resyncReadinessCheck

This triggers detection of any drifts from the desired state of Resources and RBAC.

start

This starts a new running instance of the Drill.

update

Update a Drill

validateForExecution

This returns eligible resource to be faulted or failed over.

Property Details

addOrUpdateResources

This enables the user to include, exclude or update resources from their Drill.

addOrUpdateResources: (serviceGroupName: string, operationId: string, drillName: string, body: AddOrUpdateResourcesRequest, options?: DrillsAddOrUpdateResourcesOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: AddOrUpdateResourcesRequest, options?: DrillsAddOrUpdateResourcesOptionalParams) => PollerLike<OperationState<void>, void>

beginAddOrUpdateResources

Warning

This API is now deprecated.

use addOrUpdateResources instead

beginAddOrUpdateResources: (serviceGroupName: string, operationId: string, drillName: string, body: AddOrUpdateResourcesRequest, options?: DrillsAddOrUpdateResourcesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: AddOrUpdateResourcesRequest, options?: DrillsAddOrUpdateResourcesOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginAddOrUpdateResourcesAndWait

Warning

This API is now deprecated.

use addOrUpdateResources instead

beginAddOrUpdateResourcesAndWait: (serviceGroupName: string, operationId: string, drillName: string, body: AddOrUpdateResourcesRequest, options?: DrillsAddOrUpdateResourcesOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: AddOrUpdateResourcesRequest, options?: DrillsAddOrUpdateResourcesOptionalParams) => Promise<void>

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (serviceGroupName: string, drillName: string, resource: Drill, options?: DrillsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Drill>, Drill>>

Property Value

(serviceGroupName: string, drillName: string, resource: Drill, options?: DrillsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Drill>, Drill>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (serviceGroupName: string, drillName: string, resource: Drill, options?: DrillsCreateOptionalParams) => Promise<Drill>

Property Value

(serviceGroupName: string, drillName: string, resource: Drill, options?: DrillsCreateOptionalParams) => Promise<Drill>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (serviceGroupName: string, drillName: string, options?: DrillsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (serviceGroupName: string, drillName: string, options?: DrillsDeleteOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, drillName: string, options?: DrillsDeleteOptionalParams) => Promise<void>

beginEnd

Warning

This API is now deprecated.

use end instead

beginEnd: (serviceGroupName: string, operationId: string, drillName: string, body: DrillEndRequest, options?: DrillsEndOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: DrillEndRequest, options?: DrillsEndOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginEndAndWait

Warning

This API is now deprecated.

use end instead

beginEndAndWait: (serviceGroupName: string, operationId: string, drillName: string, body: DrillEndRequest, options?: DrillsEndOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: DrillEndRequest, options?: DrillsEndOptionalParams) => Promise<void>

beginResyncReadinessCheck

Warning

This API is now deprecated.

use resyncReadinessCheck instead

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

Property Value

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

beginResyncReadinessCheckAndWait

Warning

This API is now deprecated.

use resyncReadinessCheck instead

beginResyncReadinessCheckAndWait: (serviceGroupName: string, operationId: string, drillName: string, options?: DrillsResyncReadinessCheckOptionalParams) => Promise<void>

Property Value

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

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (serviceGroupName: string, operationId: string, drillName: string, body: DrillStartRequest, options?: DrillsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: DrillStartRequest, options?: DrillsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (serviceGroupName: string, operationId: string, drillName: string, body: DrillStartRequest, options?: DrillsStartOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: DrillStartRequest, options?: DrillsStartOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (serviceGroupName: string, drillName: string, properties: DrillUpdate, options?: DrillsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, drillName: string, properties: DrillUpdate, options?: DrillsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (serviceGroupName: string, drillName: string, properties: DrillUpdate, options?: DrillsUpdateOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, drillName: string, properties: DrillUpdate, options?: DrillsUpdateOptionalParams) => Promise<void>

beginValidateForExecution

Warning

This API is now deprecated.

use validateForExecution instead

beginValidateForExecution: (serviceGroupName: string, operationId: string, drillName: string, body: ValidateForExecutionRequest, options?: DrillsValidateForExecutionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: ValidateForExecutionRequest, options?: DrillsValidateForExecutionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginValidateForExecutionAndWait

Warning

This API is now deprecated.

use validateForExecution instead

beginValidateForExecutionAndWait: (serviceGroupName: string, operationId: string, drillName: string, body: ValidateForExecutionRequest, options?: DrillsValidateForExecutionOptionalParams) => Promise<void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: ValidateForExecutionRequest, options?: DrillsValidateForExecutionOptionalParams) => Promise<void>

create

Create a Drill

create: (serviceGroupName: string, drillName: string, resource: Drill, options?: DrillsCreateOptionalParams) => PollerLike<OperationState<Drill>, Drill>

Property Value

(serviceGroupName: string, drillName: string, resource: Drill, options?: DrillsCreateOptionalParams) => PollerLike<OperationState<Drill>, Drill>

delete

Delete a Drill

delete: (serviceGroupName: string, drillName: string, options?: DrillsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, drillName: string, options?: DrillsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

end

This ends the currently running instance of the Drill.

end: (serviceGroupName: string, operationId: string, drillName: string, body: DrillEndRequest, options?: DrillsEndOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: DrillEndRequest, options?: DrillsEndOptionalParams) => PollerLike<OperationState<void>, void>

get

Get a Drill

get: (serviceGroupName: string, drillName: string, options?: DrillsGetOptionalParams) => Promise<Drill>

Property Value

(serviceGroupName: string, drillName: string, options?: DrillsGetOptionalParams) => Promise<Drill>

list

List Drill resources by tenant

list: (serviceGroupName: string, options?: DrillsListOptionalParams) => PagedAsyncIterableIterator<Drill, Drill[], PageSettings>

Property Value

(serviceGroupName: string, options?: DrillsListOptionalParams) => PagedAsyncIterableIterator<Drill, Drill[], PageSettings>

resyncReadinessCheck

This triggers detection of any drifts from the desired state of Resources and RBAC.

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

Property Value

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

start

This starts a new running instance of the Drill.

start: (serviceGroupName: string, operationId: string, drillName: string, body: DrillStartRequest, options?: DrillsStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: DrillStartRequest, options?: DrillsStartOptionalParams) => PollerLike<OperationState<void>, void>

update

Update a Drill

update: (serviceGroupName: string, drillName: string, properties: DrillUpdate, options?: DrillsUpdateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, drillName: string, properties: DrillUpdate, options?: DrillsUpdateOptionalParams) => PollerLike<OperationState<void>, void>

validateForExecution

This returns eligible resource to be faulted or failed over.

validateForExecution: (serviceGroupName: string, operationId: string, drillName: string, body: ValidateForExecutionRequest, options?: DrillsValidateForExecutionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(serviceGroupName: string, operationId: string, drillName: string, body: ValidateForExecutionRequest, options?: DrillsValidateForExecutionOptionalParams) => PollerLike<OperationState<void>, void>