Delen via

IDurableOrchestrationClient.CreateCheckStatusResponse Method

  • Reference

Definition

Namespace:
Microsoft.Azure.WebJobs.Extensions.DurableTask
Assembly:
Microsoft.Azure.WebJobs.Extensions.DurableTask.dll
Package:
Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Overloads

CreateCheckStatusResponse(HttpRequest, String, Boolean)

Creates an HTTP response that is useful for checking the status of the specified instance.
CreateCheckStatusResponse(HttpRequestMessage, String, Boolean)

Creates an HTTP response that is useful for checking the status of the specified instance.

CreateCheckStatusResponse(HttpRequest, String, Boolean)

Source:
IDurableOrchestrationClient.cs

Creates an HTTP response that is useful for checking the status of the specified instance.

public Microsoft.AspNetCore.Mvc.IActionResult CreateCheckStatusResponse (Microsoft.AspNetCore.Http.HttpRequest request, string instanceId, bool returnInternalServerErrorOnFailure = false);
abstract member CreateCheckStatusResponse : Microsoft.AspNetCore.Http.HttpRequest * string * bool -> Microsoft.AspNetCore.Mvc.IActionResult
Public Function CreateCheckStatusResponse (request As HttpRequest, instanceId As String, Optional returnInternalServerErrorOnFailure As Boolean = false) As IActionResult

Parameters

request
HttpRequest

The HTTP request that triggered the current orchestration instance.

instanceId
String

The ID of the orchestration instance to check.

returnInternalServerErrorOnFailure
Boolean

Optional parameter that configures the http response code returned. Defaults to false. If true, the returned http response code will be a 500 when the orchestrator is in a failed state, when false it will return 200.

Returns

IActionResult

An HTTP 202 response with a Location header and a payload containing instance control URLs.

Remarks

The payload of the returned IActionResult contains HTTP API URLs that can be used to query the status of the orchestration, raise events to the orchestration, or terminate the orchestration.

Applies to

CreateCheckStatusResponse(HttpRequestMessage, String, Boolean)

Source:
IDurableOrchestrationClient.cs

Creates an HTTP response that is useful for checking the status of the specified instance.

public System.Net.Http.HttpResponseMessage CreateCheckStatusResponse (System.Net.Http.HttpRequestMessage request, string instanceId, bool returnInternalServerErrorOnFailure = false);
abstract member CreateCheckStatusResponse : System.Net.Http.HttpRequestMessage * string * bool -> System.Net.Http.HttpResponseMessage
Public Function CreateCheckStatusResponse (request As HttpRequestMessage, instanceId As String, Optional returnInternalServerErrorOnFailure As Boolean = false) As HttpResponseMessage

Parameters

request
HttpRequestMessage

The HTTP request that triggered the current orchestration instance.

instanceId
String

The ID of the orchestration instance to check.

returnInternalServerErrorOnFailure
Boolean

Optional parameter that configures the http response code returned. Defaults to false. If true, the returned http response code will be a 500 when the orchestrator is in a failed state, when false it will return 200.

Returns

HttpResponseMessage

An HTTP 202 response with a Location header and a payload containing instance control URLs.

Remarks

The payload of the returned HttpResponseMessage contains HTTP API URLs that can be used to query the status of the orchestration, raise events to the orchestration, or terminate the orchestration.

Applies to