Poll on an Async Operation on BizTalk Service

 

Updated: January 4, 2016

This topic provides information on how to poll on an asynchronous operation performed on a BizTalk Services deployment to get the status of the operation.

System_CAPS_importantImportant

Polling for async operations is not supported on BizTalk Services Free edition.

This section provides information about the request operation to poll for the status of an asynchronous operation performed on BizTalk Services.

Method

Request URI

HTTP Version

GET

https://management.core.windows.net/{subscription-id}/cloudservices/{cloud-service-name}/resources/biztalkservices/~/biztalk/{resource-name}?OperationStatus/{request-id}

where,

  • subscription-id is your Azure subscription ID

  • cloud-service-name is the unique name for the cloud service that hosts your BizTalk Service. The name can be up to 64 characters in length.

  • resource-name is the unique name for the BizTalk Services subscription.

  • OperationStatus/{request-id} retrieves the status of the operation specified by the request-id. The value of the request ID must be the value contained in the response header (x-ms-request-id) of the response message that is returned when the operation is successfully invoked.

System_CAPS_importantImportant

All parameters are required.

HTTP/1.1

Header

Description

Content-Type

Required. If specified, this must be set to application/xml.

x-ms-version

Required. Specifies the version of the operation to use for this request. The value of this header must be set to 2012-08-01 or later.

x-ms-client-request-id

Optional. Specifies an ID to identify the request. This can be useful in troubleshooting client issues end-to-end and is passed to the BizTalk Services resource provider.

GET https://management.core.windows.net/<subscription-id>/cloudservices/mycloudservice1/resources/biztalkservices/biztalk/mybiztalkservice?OperationStatus/124 HTTP/1.1
Content-Type: application/xml; charset=utf-8 
x-ms-version: 2013-04-26

The response includes an HTTP status code, a set of response headers, and a response body.

A successful operation returns status code 202 (ACCEPTED).

For information about status codes, see Service Management Status and Error Codes.

Header

Description

Content-Type

Specifies the content type.

x-ms-request-id

A value that uniquely identifies a request made against the application service.


<OperationStatus>
  <Result>Succeeded</Result>
  <Error>
    <HttpCode>http-code-4xx-range</HttpCode>
    <Message>error-message-string</Message>
    <ExtendedCode>extended-error-code</ExtendedCode>
  </Error>
</OperationStatus>

If there is an error response, the format of the response body is the same as shown at Service Management Status and Error Codes.

The following table describes the key elements in the response body.

Element Name

Description

Result

Specifies the result of the operation. The possible values can be InProgress, Succeeded, or Failed.

Error/HttpCode

In the event of an error, specifies the HTTP error code.

Error/Message

In the event of an error, specifies the error message.

Error/ExtendedCode

In the event of an error, specifies the extended error code.

Show: