Suspend BizTalk Service

 

Updated: January 4, 2016

This topic provides information on how suspend the specified BizTalk Services. When a BizTalk Services deployment is suspended, runtime messages are not processed. However, management operations can still be performed. Because this is an asynchronous call, you must use the Poll on an Async Operation on BizTalk Service API to get the status of the operation.

System_CAPS_noteNote

The suspend operation is not available on the BizTalk Services Free edition. Also, suspending an already suspended BizTalk Services will have no effect.  That is, the operation will not return an error, and the service will continue to be in suspended state.

This section provides information about the request operation to suspend the specified BizTalk Services.

Method

Request URI

HTTP Version

POST

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

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.

  • comp=suspend specifies the suspend operation to be performed on the BizTalk Services.

System_CAPS_importantImportant

All parameters are required.

HTTP/1.1

Header

Description

Content-Type

Optional. 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.

Copy 
POST https://management.core.windows.net/<subscription-id>/cloudservices/mycloudservice1/resources/biztalkservices/biztalk/mybiztalkservice?comp=suspend 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.

None.

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

Show: