Get BizTalk Service Properties

 

Updated: January 4, 2016

Describes the REQUEST operation of a Microsoft Azure BizTalk Service.

This section provides information about the request operation to return the properties of a specific Microsoft Azure BizTalk Service.

Method

Request URI

HTTP Version

GET

https://management.core.windows.net/subscription-id/cloudservices/CloudServiceName/resources/biztalkservices/~/biztalk/resource-name/properties

Where:

  • subscription-id is your Microsoft Azure subscription ID

  • CloudServiceName 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.

System_CAPS_importantImportant

All parameters are required.

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

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 
GET https://management.core.windows.net/<subscription-id>/cloudservices/myCloudService/resources/biztalkservices/biztalk/myBizTalkService/properties 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 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.

Copy 
<BizTalkServiceProperties> 
<B2BPortalUrl>https://mybiztalkservice.biztalk.windows.net/</B2BPortalUrl> 
 <CreationDate>2013-02-22</CreationDate >  
 <ServiceDomainUrl>mybiztalkservice.biztalk.windows.net</ServiceDomainUrl>  
       <BridgeEndpointUrl>https://mybiztalkservice.biztalk.windows.net/</BridgeEndpointUrl>    
       <ServiceCertificateExpiryTime>2013-02-22 23:09:90.89</ServiceCertificateExpiryTime> 
 <ServiceCertificateSubjectName>CN = ABCD</ServiceCertificateSubjectName> 
        <ServiceCertificateThumbprint>ABCDE1234ABCDE1234ABCD1234</ServiceCertificateThumbprint> 
 <VirtualIP>192.168.1.1</VirtualIP> 
  <ServiceCertificateFile>as132424343434343434343</ServiceCertificateFile> 
<ACSNamespaceName>TestACS</ACSNamespaceName> 
<ACSDefaultIssuerName>TestIssuerName</ACSDefaultIssuerName> 
<ACSDefaultIssuerKey>TestIssuerKey</ ACSDefaultIssuerKey> 
</BizTalkServiceProperties>

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

B2BPortalUrl

Returns the URL through which BizTalk Services Portal can be accessed

CreationDate

Returns the date on which BizTalk Services was created

ServiceDomainUrl

Returns the URL that represents the DNS name of the BizTalk Service

BridgeEndpointUrl

Returns the URL through which EAI functionality can be accessed.

ServiceCertificateExpiryTime

Returns the expiry date/time of the BizTalk Services certificate.

ServiceCertificateSubjectName

Returns the subject name of the BizTalk Services certificate.

ServiceCertificateThumbprint

Returns the thumbprint of the BizTalk Services certificate.

VirtualIP

Returns the IP address of the BizTalk Services.

ServiceCertificateFile

Returns the public portion of the X.509 service certificate as a base-64 encoded form of the BizTalk Services public certificate file (.cer).

ACSNamespaceName

Represents the ACS namespace with which BizTalk Services is configured as the relying party.

ACSDefaultIssuerName

Represents the Access Control Issuer Name.

ACSDefaultIssuerKey

Represents the Access Control Issuer key.

Show: