Get usage metrics for BizTalk Services

 

Updated: January 4, 2016

Returns the usage metrics, such as number of hybrid connections and data used by them, 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

GET

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

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.

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 
GET https://managment.core.windows.net/<subscription-id>/cloudservices/<cloud-service-name>/resources/biztalkservices/~/biztalk/<biztalk-service-name>/usage 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.

Copy 
<UsageMetricCollection>
  <UsageMetric>
    <Name>Hybrid Connections</Name>
    <CurrentValue>1</CurretValue>
    <Limit>5</Limit>
    <Unit>Count</Unit>
  </UsageMetric>
  <UsageMetric>
    <Name>Hybrid Connections Data Usage</Name>
    <CurrentValue>1.2</CurretValue>
    <Limit>-1</Limit>
    <NextResetTime>2013-02-22 23:09:90.89</NextResetTime>
    <Unit>GB</Unit>
  </UsageMetric>
</UsageMetricCollection>

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

Name

Specifies the name of the usage parameter being returned.

CurrentValue

Specifies the current value of the usage parameter

Limit

Specifies the maximum limit for a usage parameter.

NexResetTime

Specifies the time when the usage parameter is reset

Unit

Specifies the unit in which the usage parameter is measured.

Show: