Review the Dashboard, Monitor, Scale, Configure, and Hybrid Connection tabs

Important

Microsoft Azure BizTalk Services (MABS) is being retired and replaced with Azure Logic Apps. If you currently use MABS, review this article for guidance about migrating your integration solutions to Logic Apps: Move from BizTalk Services to Logic Apps

If you're new to Logic Apps, try starting here:

After you create your BizTalk Service and deploy your application, you can change some of the BizTalk Service settings and monitor the application performance.

Important

BizTalk Services is deprecated in the Azure portal. To manage your MABS instances, see REST API for Managing BizTalk Services on Azure.

This opens a new window with the following tabs. This topic describes these tabs.

Quickstart (Quickstart)

Depending on the BizTalk Services Edition, all options listed may not be available.

Get the tools Download the BizTalk Services SDK to install the Visual Studio project templates on your on-premises development computer. These templates create the BizTalk Services (bridge) and the BizTalk Service Artifacts (Transform) Visual Studio projects that are deployed to your BizTalk Service.

How do I Start Using the Azure BizTalk Services SDK and Installing the Azure BizTalk Services SDK lists the steps to get started.
Create partner agreements Opens the Azure BizTalk Services Portal hosted on Azure where you add partners and create X12, AS2, and EDIFACT EDI agreements.

Configuring Components for EDI Messaging on BizTalk Services Portal lists the steps to get started.
Learn more about BizTalk Services Go to the learning center to learn more about Azure BizTalk Services.

In the task bar at the bottom, you can:

Manage your application deployment Opens the Azure BizTalk Services portal. The BizTalk Services Portal is the entrance to EDI configuration, including adding partners and creating X12, AS2, and EDIFACT agreements.

This is the same as Create partner agreements on the Quick Start tab.

Configuring Components for EDI Messaging on BizTalk Services Portal provides more information on the BizTalk Services Portal.
Connection Information of the Access Control Namespace When you select Connection Information, then the Access Control Namespace, Default Issuer, and Default Key are displayed. You can copy these values.

You can also open the Access Control Portal. Create an Access control Namespace provides more information on the Access Control Portal.
Sync Keys in the Storage Account When you create a Storage account, a Primary Key and Secondary Key are automatically created. These encryption Keys control access to your Storage Account. Your BizTalk Service automatically uses the Primary Key. Sync Keys enable users to switch between the Primary Key and the Secondary Key without disrupting the BizTalk Service.

For example, you want the BizTalk Service to use a new Primary Key for the Storage Account. To do this:

  1. Select your BizTalk Service and select Sync Keys. Select the Secondary Key. When you do this, the BizTalk Service starts using the Secondary Key.
  2. Select your Storage account and Regenerate the Primary Key. Remember, your BizTalk Service is using the Secondary Key.
  3. Select your BizTalk Service and select Sync Keys. Now, select the Primary Key. This is the new Primary Key you regenerated.
  4. Select your Storage account and Regenerate the Secondary Key.

This process is called "rollover keys". The purpose is to enable users to switch between the Primary Key and the Secondary Key without disrupting the BizTalk Service.
Delete your application When you select Delete, your BizTalk Service and all items deployed to it are removed.

Dashboard

Depending on the BizTalk Services Edition, all options listed may not be available.

When you select your BizTalk Service name, the Dashboard tab is displayed. In Dashboard, you can:

Usage Overview: Shows the number of used Hybrid Connections

Also displays the data usage in GB.

Metric Graph: Shows a fixed list of performance metrics

These metrics provide real-time values regarding the health of the BizTalk Service. You can also choose the Relative or Absolute values and the time range Interval of the metrics that are displayed in the graph.

For a description of these performance metrics, go to Available Metrics in this topic.

Quick Glance: Lists your BizTalk Service properties
Update Tracking Database credentials Changes the user name and password used to log into the Tracking Database.
Update SSL Certificate Can update the BizTalk Service to use a different SSL certificate. A self-signed SSL certificate is automatically created when you create the BizTalk Service.
Download Certificate You can download the SSL certificate used by your BizTalk Service to a local machine.
Status Displays the current status of your BizTalk Service. See BizTalk Services: Service state chart.
Service URL The URL for your BizTalk Service. This is the same as the Domain URL entered when your BizTalk Service is created.
Public Virtual IP (VIP) Address The IP address assigned to your BizTalk Service. It is used for all input endpoints and is the source address for outbound traffic. This IP address belongs to your BizTalk Service as long as it is created. If you delete the BizTalk Service, the IP address is assigned to another BizTalk Service.
ACS Namespace Authenticates with the BizTalk Service.
Edition Lists the Edition entered when the BizTalk Service is created.
Location Displays the geographic region that hosts your BizTalk Service.
Created Displays the date and time the BizTalk Service was created.
Tracking Database The Azure SQL Database name that stores the tracking tables used by your BizTalk Service.

Requirements Explained provides details on the Tracking Database.
Monitoring/Archiving Storage The Azure Storage account name that stores the monitoring output of your BizTalk Service.

Requirements Explained provides details on the Storage account.
Subscription Name Lists the subscription that hosts your BizTalk Service. The subscription governs access.
Subscription ID When a subscription is created, a subscription ID is automatically generated. When using REST APIs, you may need to enter the Subscription ID.

BizTalk Services: Provisioning lists the steps to create a BizTalk Service.

Manage, Connection Information, Sync Keys, and Delete in the task bar:
Manage your application deployment Opens the Azure BizTalk Services Portal. The BizTalk Services Portal is the entrance to EDI configuration, including adding partners and creating X12, AS2, and EDIFACT agreements.

This is the same as Create partner agreements on the Quick Start tab.

Configuring Components for EDI Messaging on BizTalk Services Portal provides more information on the BizTalk Services Portal.
Connection Information of the Access Control Namespace Displays the Access Control Namespace, Default Issuer, and Default Key values; which can be copied.

You can also open the Access Control Portal. This Access Control Portal is the same as using the Active Directory option in the left navigation pane.

Managing Your ACS Namespace provides more information on the Access Control Portal.
Sync Keys in the Storage Account When you create a Storage account, a Primary Key and Secondary Key are automatically created. These encryption Keys control access to your Storage Account. Your BizTalk Service automatically uses the Primary Key. Sync Keys enable users to switch between the Primary Key and the Secondary Key without disrupting the BizTalk Service.

For example, you want the BizTalk Service to use a new Primary Key for the Storage Account. To do this:

  1. Select your BizTalk Service and select Sync Keys. Select the Secondary Key. When you do this, the BizTalk Service starts using the Secondary Key.
  2. Select your Storage account and Regenerate the Primary Key. Remember, your BizTalk Service is using the Secondary Key.
  3. Select your BizTalk Service and select Sync Keys. Now, select the Primary Key. This is the new Primary Key you regenerated.
  4. Select your Storage account and Regenerate the Secondary Key.

This process is called "rollover keys". The purpose is to enable users to switch between the Primary Key and the Secondary Key without disrupting the BizTalk Service.
Delete your application Your BizTalk Service and all items deployed to it are removed.

Monitor

Does not apply to the Free Edition.

When you select your BizTalk Service name, the Monitor tab is available and displays the following:

Metric Graph: Displays the selected performance metrics

These metrics provide real-time values regarding the health of the BizTalk Service. You choose which performance metrics are displayed. A maximum of six performance metrics can be displayed simultaneously.

You can also choose the Relative or Absolute values and the time range Interval of the metrics that are displayed.

To remove or display metrics in the graph:
  1. Select the Monitor tab.
  2. Select Add Metrics in the task bar:
    Select Add Metrics
  3. Check the performance metrics you want to display.
  4. Select the checkmark to return to the Monitor tab.
  5. Select the circle next to the metric to display that metric's value in the graph.

    For example, the CPU Usage metric is grayed out; its output is not displayed in the graph:
    CPU Usage metric is grayed out

    Select the grayed out circle to enable the CPU Usage metric to display its output in the graph:
    CPU Usage metric is enabled

  6. To remove a metric from the display graph and the list, select Delete Metric in the task bar. To add the metric back to the list, select Add Metrics in the task bar, check the metric, and select the checkmark to return to the Monitor tab. Select the grayed out circle to enable the metric.

Available Metrics

The following performance counters/metrics are available:

RountdTrip Latency Displays the average time taken in milliseconds (ms) to process a message from the time the message is received until the message is fully processed by the BizTalk Service across all bridges. Only messages successfully processed are counted.

When the following events occur, a timestamp is created:
  • Message enters the gateway
  • Message is routed to the destination
  • Destination response is received
  • Destination acknowledgement response sent to the gateway

This metric shows the result of the following calculation:

[Destination acknowledgement response sent to the gateway] - [Message enters the gateway]
Failures At Source Displays the total number of messages that failed by the BizTalk Service when pulling messages from the source endpoints.
CPU Usage Lists the average %Processor Time of all role instances.
Processing Latency Displays the average time taken In milliseconds (ms) to process a message by the BizTalk Service across all bridges, excluding the time spent in destinations. Only messages successfully processed are counted.

When each of the following events occur, a timestamp is created:
  • Message enters the gateway
  • Message is routed to the destination
  • Destination response is received
  • Destination acknowledgement response sent to the gateway

This metric shows the result of the following calculation:

[Destination acknowledgement response sent to the gateway] - [Message enters the gateway] - [Destination response is received] + [Message is routed to the destination]
Failures In Process Displays the total number of messages that failed during processing by the BizTalk Service across all the bridges within a time interval.
Messages Sent Displays the total number of messages sent by the BizTalk Service across all bridges within a time interval. This metric is incremented when a message sent from a pipeline reaches the route destination. This metric does not indicate that a message is successfully processed.

In a Request-Reply scenario, the metric is incremented when the route destination sends a receipt acknowledgement back to the pipeline.
Messages Received Displays the total number of messages received by the BizTalk Service across all bridges within a time interval. This metric is incremented when a new message is received by the pipeline.
Messages In Process Displays the total number of messages currently being processed by the BizTalk Service within a time interval.
Messages Processed Displays the total number of messages successfully processed by the BizTalk Service across all bridges within a time interval. This metric is incremented when a message is successfully received by the pipeline and successfully routed to the destination.

Scale

In the Scale tab, you can add or subtract the number of units used by your BizTalk Service. By default, there is one Unit configured. Additional Units can be added to scale your BizTalk Service. When you increase the scale, you are increasing throughput. The amount of resources also increases, including deployed bridges, agreements, LOB connections, and processing power. For example, you increase the scale from 1 Unit to 2 Units. In this situation, you can deploy double the number of bridges, double the agreements, double the LOB connections, and double the processing power.

Some BizTalk editions do not offer a scale option. In this situation, one Unit is permitted. To determine how many units your edition can be scaled, refer to BizTalk Services: Editions Chart.

Increasing the number of units may impact pricing. If you increase the Units, selecting Save displays a message that tells you if billing is impacted. You then choose to continue. When you increase the number of Units, the BizTalk Service status changes from Active to Updating. In the Updating state, your BizTalk Service continues to run.

BizTalk Services: Editions Chart defines a "Unit".

Configure

Does not apply to Hybrid Connections.

Sets the Backup Status to None or Automatic. When set to None, no backups are automatically created. When set to Automatic, you configure the backup location, the frequency of the backup, and how long to keep the backup files.

BizTalk Services: Backup and Restore provides the details.

Hybrid Connections

Hybrid Connections connect an Azure application, like Web Apps or Mobile Apps in Azure App Service, to an on-premises resource that uses a static TCP port, such as SQL Server, MySQL, HTTP Web APIs, and most custom Web Services. Hybrid Connections are managed in BizTalk Services.

To create or manage Hybrid Connections in Azure BizTalk Services, see Hybrid Connections.

Next

Now that you're familiar with the different tabs, you can learn more about the Azure BizTalk Services features:

See Also