Create or update a hybrid connection

 

Updated: January 4, 2016

This topic provides information on how to create/update a hybrid connection in a specified BizTalk Services subscription.

This section provides information about the request operation including the request URI, request header, request message, and request elements.

Method

Request URI

HTTP Version

PUT

https://management.core.windows.net/{subscription-id}/cloudservices/{cloud-service-name}/resources/biztalkservices/~/biztalk/{biztalk-service-name}/hybridconnection/{hybrid-connection-name}

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.

  • biztalk-service-name is the name of BizTalk Services subscription under which a hybrid connection is created.

  • hybrid-connection-name is the name of a hybrid connection. This name must be unique within the specified BizTalk Services is created and must be a string between 6 and 50 characters. hybrid connection name must start with a letter and end with a letter or number. The name can contain only letters, numbers, and hyphens.

HTTP/1.1

Header

Description

Content-Type

Required. Set this 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 
PUT https://managment.core.windows.net/<subscription-id>/cloudservices/<cloud-service-name>/resources/biztalkservices/~/biztalk/<biztalk-service-name>/hybridconnection/<hybrid-connection-name> HTTP/1.1
Content-Type: application/xml; charset=utf-8 
x-ms-version: 2013-04-26

<HybridConnectionInput xmlns="http://schemas.microsoft.com/windowsazure">
  <HostName>myhost</HostName>
  <Port>1000</Port>
</HybridConnectionInput>

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

Element Name

Description

HostName

The on-premise host name that has the resource (e.g. SQL Server database instance) to which the BizTalk Services hybrid connection must connect to.

Port

The port number on which the resource is available.

The response includes an HTTP status code and a response header.

A successful operation returns status code 200 (OK).

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: