KeyVaultAdminPollOperationState interface

Package:

@azure/keyvault-admin

An interface representing the state of a Key Vault Admin Poller's operation.

Extends

@azure/core-lro.PollOperationState<TResult>

Properties

endTime	The end time of the restore operation in UTC
jobId	Identifier for the full restore operation.
startTime	The start time of the restore operation in UTC
status	Status of the restore operation.
statusDetails	The status details of restore operation.

Inherited Properties

error	Will exist if the operation encountered any error.
isCancelled	True if the operation has been cancelled.
isCompleted	True if the operation has been completed.
isStarted	True if the operation has started.
result	Will exist if the operation concluded in a result of an expected type.

Property Details

endTime

The end time of the restore operation in UTC

endTime?: Date

Property Value

Date

jobId

Identifier for the full restore operation.

jobId?: string

Property Value

string

startTime

The start time of the restore operation in UTC

startTime?: Date

Property Value

Date

status

Status of the restore operation.

status?: string

Property Value

string

statusDetails

The status details of restore operation.

statusDetails?: string

Property Value

string

Inherited Property Details

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From PollOperationState.error

isCancelled

True if the operation has been cancelled.

isCancelled?: boolean

Property Value

boolean

Inherited From PollOperationState.isCancelled

isCompleted

True if the operation has been completed.

isCompleted?: boolean

Property Value

boolean

Inherited From PollOperationState.isCompleted

isStarted

True if the operation has started.

isStarted?: boolean

Property Value

boolean

Inherited From PollOperationState.isStarted

result

Will exist if the operation concluded in a result of an expected type.

result?: TResult

Property Value

TResult

Inherited From PollOperationState.result