Deploying and configuring the Microsoft Azure - Azure API extractor

Prerequisites

Depending on the Azure model, complete the following prerequisite steps: 

• Azure Resource Manager Model
• Azure Classic Model

Azure Resource Manager Model

Azure Classic Model

• Obtain a subscription ID: The subscription ID is a GUID that uniquely identifies your subscription to use Azure services.

• Upload the management certificate to the Microsoft Azure Classic portal: A management certificate is an SSL certificate that is a small data file that digitally binds a cryptographic key to an organization's details. This certificate is associated with your subscription and is required to authenticate your API calls. Create the management certificate and upload it in the Azure portal.

  The [expand] macro is a standalone macro and it cannot be used inline. Click on this message for details.
  This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
  

Configuring the ETL module

To integrate TrueSight Capacity Optimization with the extractor, complete the following steps:

1. In the TrueSight Capacity Optimization console, navigate to Administration > ETL & SYSTEM TASKS > ETL tasks.
2. In the ETL tasks page, under the Last run tab, click Add > Add ETL.
   The Add ETL page is displayed.
3. In the Run configuration tab, for the ETL module property, select Microsoft Azure - Azure API Extractor.
   

4. Specify values for the properties under each expandable tab. For details about the common properties, see ETL-common-configuration-properties. The following table lists the properties that are specific to this ETL module under the Microsoft Azure configuration tab:
   
   

   Note

   By default, the most common, basic properties that you can set for an ETL are displayed in the Add ETL page. You can accept these default selections.

   

   The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
   This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
   

5. Click Save.
   You return to the Last run tab under the ETL tasks page.
6. In simulation mode, validate the results: In the ETL tasks table under ETL tasks > Last run, locate your ETL (ETL task name), click Run  to run the ETL.
   After you run the ETL, the Last exit column in the ETL tasks table will display one of the following values:
   
   • OK: The ETL executed without any error in simulation mode.
   • WARNING: The ETL execution returned some warnings in simulation mode. Check the ETL log.
   • ERROR: The ETL execution returned errors and was unsuccessful. Edit the active Run configuration and try again.
7. After you verify that the ETL is running correctly, switch the ETL to production mode:
   
   1. In the ETL tasks table under ETL tasks > Last run, click the ETL name under the Name column.
   2. In the Run configurations table in the ETL details page, click Edit  to edit the active run configuration.
   3. In the Edit run configuration page, navigate to the Run configuration expandable tab and set Execute in simulation mode to No.
   4. Click Save.
8. Locate the ETL in the ETL tasks table and either schedule an ETL run or click Run  to run it now.
   After you run the ETL, or schedule the ETL for a run, it will extract the data from the source and transfer it to the TrueSight Capacity Optimization database. 
   In the left pane of Workspace, the following hierarchy of entities is displayed:

Collecting data for additional instance type configuration metrics

An out-of-the-box JSON file contains the mapping for configuration metrics collected by the extractor. This file is stored on the ETL Engine server. You can configure this file to modify the existing instance type configuration or to add new configuration metrics. For example, you can add the BY_BENCHMARK_VALUE metric in the following format:

To upload and then use a JSON file for collecting additional instance type configuration metrics:

1. Download the  attached JSON file and update the file for existing and additional metrics.
2. Name the JSON file appropriately, such as msazure-metric-conf.json, and save it to your local machine.
3. Upload the file to a folder on the ETL Engine server.
4. To use the file, include it when you create the ETL:
   1. In the Add ETL page, after you select Microsoft Azure - Azure extractor as the ETL, click Advanced and navigate to the Microsoft Azure configuration tab.
   2. Type the file path in Instance type definition JSON file path.
   3. Click Save.
      For detailed procedure, see Integration steps