Skip to content

[I] LroMetadata

Information about long-running operations For standard Lro Patterns, only the ā€˜logicalResult’ and ā€˜finalStateVia’ will be used.

PropertyTypeDescription
envelopeResultModelThe TypeSpec type of the object that contains the final result
finalEnvelopeResult?Model | "void"The TypeSpec type of the object that contains the ā€˜finalResult’.
finalResult?Model | "void"The model representing important data returned on a success - clients will want to return this model. If undefined, then clients would want to return nothing.
finalResultPath?stringThe path to the field in the ā€˜finalEnvelopeResult’ that contains the ā€˜finalResult’.
finalStateViaFinalStateValueAn enumeration summarizing how a poller should reach a terminal state
finalStep?FinalOperationStepIf another operation call is required after polling ends to get the results of the operation, a link to that ā€˜final’ operation
logicalPath?stringThe path to the field in the status monitor that contains results. If undefined, then there is no results field in the status monitor
logicalResultModelThe model representing important data returned on a success - clients will want to return this model
operationOperationThe operation that was processed
pollingInfoPollingOperationStepSpecific information about how to process the status monitor, including the location of status, success, and error fields, and the terminal states for polling
statusMonitorStep?| NextOperationLink | NextOperationReferenceSpecific information on how to reach the StatusMonitor, this is either instructions for constructing a call to the status monitor operation {NextOperationReference} , or the response property containing the url that points to the Statue Monitor {NextOperationLink}