OperationStatusResult interface

The current status of an async operation.

Properties

endTime

The end time of the operation.

error

If present, details of the operation error.

exitCode

For actions that run commands or scripts, the exit code of the script execution.

id

Fully qualified ID for the async operation.

name

Name of the async operation.

operations

The operations list.

outputHead

For actions that run commands or scripts, the leading bytes of the output of the script execution.

percentComplete

Percent of the operation that is complete.

resourceId

Fully qualified ID of the resource against which the original async operation was started.

resultRef

For actions that run commands or scripts, a reference to the location of the result.

resultUrl

For actions that run commands or scripts, the URL where the full output of the script output can be retrieved.

startTime

The start time of the operation.

status

Operation status.

Property Details

endTime

The end time of the operation.

endTime?: Date

Property Value

Date

error

If present, details of the operation error.

error?: ErrorDetail

Property Value

exitCode

For actions that run commands or scripts, the exit code of the script execution.

exitCode?: string

Property Value

string

id

Fully qualified ID for the async operation.

id?: string

Property Value

string

name

Name of the async operation.

name?: string

Property Value

string

operations

The operations list.

operations?: OperationStatusResult[]

Property Value

outputHead

For actions that run commands or scripts, the leading bytes of the output of the script execution.

outputHead?: string

Property Value

string

percentComplete

Percent of the operation that is complete.

percentComplete?: number

Property Value

number

resourceId

Fully qualified ID of the resource against which the original async operation was started.

resourceId?: string

Property Value

string

resultRef

For actions that run commands or scripts, a reference to the location of the result.

resultRef?: string

Property Value

string

resultUrl

For actions that run commands or scripts, the URL where the full output of the script output can be retrieved.

resultUrl?: string

Property Value

string

startTime

The start time of the operation.

startTime?: Date

Property Value

Date

status

Operation status.

status: string

Property Value

string