Regenerate connection strings for a hybrid connection

 

Updated: January 4, 2016

Regenerates the connection strings for a specific hybrid connection for the specified BizTalk Services.

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

Method

Request URI

HTTP Version

POST

https://management.core.windows.net/{subscription-id}/cloudservices/{cloud-service-name}/resources/biztalkservices/~/biztalk/{biztalk-service-name}/hybridconnection/{hybrid-connection-name}?comp=regeneratekey&ruleName={RuleName}&keyType={KeyType} 

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.

  • RuleName. Set this to defaultSender to regenerate the cloud application key. Set this to defaultListener to regenerate the on-premise gateway manager key

  • KeyType. Set this to PrimaryKey to regenerate the primary key. Set this to SecondaryKey to regenerate the secondary key.

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 
POST https://managment.core.windows.net/<subscription-id>/cloudservices/<cloud-service-name>/resources/biztalkservices/~/biztalk/<biztalk-service-name>/hybridconnection/<hybrid-connection-name>/?comp=regeneratekey&ruleName=defaultSender&keyType=PrimaryKey HTTP/1.1
Content-Type: application/xml; charset=utf-8 
x-ms-version: 2013-04-26

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

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: