KeyVaultRestoreOperationState interface

Package:

@azure/keyvault-admin

An interface representing the publicly available properties of the state of a restore Key Vault's poll operation.

Extends

KeyVaultAdminPollOperationState<KeyVaultRestoreResult>

Inherited Properties

endTime	The end time of the restore operation in UTC
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.
jobId	Identifier for the full restore operation.
result	Will exist if the operation concluded in a result of an expected type.
startTime	The start time of the restore operation in UTC
status	Status of the restore operation.
statusDetails	The status details of restore operation.

Inherited Property Details

endTime

The end time of the restore operation in UTC

endTime?: Date

Property Value

Date

Inherited From KeyVaultAdminPollOperationState.endTime

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From KeyVaultAdminPollOperationState.error

isCancelled

True if the operation has been cancelled.

isCancelled?: boolean

Property Value

boolean

Inherited From KeyVaultAdminPollOperationState.isCancelled

isCompleted

True if the operation has been completed.

isCompleted?: boolean

Property Value

boolean

Inherited From KeyVaultAdminPollOperationState.isCompleted

isStarted

True if the operation has started.

isStarted?: boolean

Property Value

boolean

Inherited From KeyVaultAdminPollOperationState.isStarted

jobId

Identifier for the full restore operation.

jobId?: string

Property Value

string

Inherited From KeyVaultAdminPollOperationState.jobId

result

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

result?: KeyVaultRestoreResult

Property Value

KeyVaultRestoreResult

Inherited From KeyVaultAdminPollOperationState.result

startTime

The start time of the restore operation in UTC

startTime?: Date

Property Value

Date

Inherited From KeyVaultAdminPollOperationState.startTime

status

Status of the restore operation.

status?: string

Property Value

string

Inherited From KeyVaultAdminPollOperationState.status

statusDetails

The status details of restore operation.

statusDetails?: string

Property Value

string

Inherited From KeyVaultAdminPollOperationState.statusDetails