OperationStatusResult interface

The current status of an async operation.

Properties

endTime

The end time of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

error

If present, details of the operation error. NOTE: This property will not be serialized. It can only be populated by the server.

exitCode

For actions that run commands or scripts, the exit code of the script execution. NOTE: This property will not be serialized. It can only be populated by the server.

id

Fully qualified ID for the async operation. NOTE: This property will not be serialized. It can only be populated by the server.

name

Name of the async operation. NOTE: This property will not be serialized. It can only be populated by the server.

operations

The operations list. NOTE: This property will not be serialized. It can only be populated by the server.

outputHead

For actions that run commands or scripts, the leading bytes of the output of the script execution. NOTE: This property will not be serialized. It can only be populated by the server.

percentComplete

Percent of the operation that is complete. NOTE: This property will not be serialized. It can only be populated by the server.

resourceId

Fully qualified ID of the resource against which the original async operation was started. NOTE: This property will not be serialized. It can only be populated by the server.

resultRef

For actions that run commands or scripts, a reference to the location of the result. NOTE: This property will not be serialized. It can only be populated by the server.

resultUrl

For actions that run commands or scripts, the URL where the full output of the script output can be retrieved. NOTE: This property will not be serialized. It can only be populated by the server.

startTime

The start time of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

status

Operation status.

Property Details

endTime

The end time of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

endTime?: Date

Property Value

Date

error

If present, details of the operation error. NOTE: This property will not be serialized. It can only be populated by the server.

error?: ErrorDetail

Property Value

exitCode

For actions that run commands or scripts, the exit code of the script execution. NOTE: This property will not be serialized. It can only be populated by the server.

exitCode?: string

Property Value

string

id

Fully qualified ID for the async operation. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

name

Name of the async operation. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

operations

The operations list. NOTE: This property will not be serialized. It can only be populated by the server.

operations?: OperationStatusResult[]

Property Value

outputHead

For actions that run commands or scripts, the leading bytes of the output of the script execution. NOTE: This property will not be serialized. It can only be populated by the server.

outputHead?: string

Property Value

string

percentComplete

Percent of the operation that is complete. NOTE: This property will not be serialized. It can only be populated by the server.

percentComplete?: number

Property Value

number

resourceId

Fully qualified ID of the resource against which the original async operation was started. NOTE: This property will not be serialized. It can only be populated by the server.

resourceId?: string

Property Value

string

resultRef

For actions that run commands or scripts, a reference to the location of the result. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

resultUrl?: string

Property Value

string

startTime

The start time of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: Date

Property Value

Date

status

Operation status.

status: string

Property Value

string