OperationStatus interface

The current status of an async operation

Extends

Properties

properties

Custom operation properties, populated only for a successful operation. NOTE: This property will not be serialized. It can only be populated by the server.

resourceId

The id of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

endTime

The end time of the operation.

error

If present, details of the operation error.

id

Fully qualified ID for the async operation.

name

Name of the async operation.

operations

The operations list.

percentComplete

Percent of the operation that is complete.

startTime

The start time of the operation.

status

Operation status.

Property Details

properties

Custom operation properties, populated only for a successful operation. NOTE: This property will not be serialized. It can only be populated by the server.

properties?: Record<string, unknown>

Property Value

Record<string, unknown>

resourceId

The id of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceId?: string

Property Value

string

Inherited Property Details

endTime

The end time of the operation.

endTime?: Date

Property Value

Date

Inherited From OperationStatusResult.endTime

error

If present, details of the operation error.

error?: ErrorDetail

Property Value

Inherited From OperationStatusResult.error

id

Fully qualified ID for the async operation.

id?: string

Property Value

string

Inherited From OperationStatusResult.id

name

Name of the async operation.

name?: string

Property Value

string

Inherited From OperationStatusResult.name

operations

The operations list.

operations?: OperationStatusResult[]

Property Value

Inherited From OperationStatusResult.operations

percentComplete

Percent of the operation that is complete.

percentComplete?: number

Property Value

number

Inherited From OperationStatusResult.percentComplete

startTime

The start time of the operation.

startTime?: Date

Property Value

Date

Inherited From OperationStatusResult.startTime

status

Operation status.

status: string

Property Value

string

Inherited From OperationStatusResult.status