Skip to content

Collector Configuration Manual for "Azure-Load Balancer"

Before reading this article, please read the following first:

Before using this collector, you must install the 'Core Integration Package' and its associated third-party dependency packages

1. Configuration Structure

The configuration structure of this collector is as follows:

Field Type Required Description
subscriptions list Required List of subscription IDs to collect
subscriptions[#] str Subscription ID
locations list Optional Region list
locations[#] str Region, e.g., westus2

2. Configuration Example

Specified Subscription

Collect all instance objects under the subscription ID: xxxx1

Python
1
2
3
collector_configs = {
    'subscriptions': ['xxxx1']
}

Specified Subscription and Region

Collect all instance objects with the subscription ID: xxxx1 and in the westus2, westus regions.

Python
1
2
3
4
collector_configs = {
    'subscriptions': ['xxxx1'],
    'locations': ['westus2', 'westus']
}

Configuration Filter (Optional)

This collector script supports user-defined filters, allowing users to filter target resources based on object properties. The filter function returns True or False.

  • True: The target resource needs to be collected.
  • False: The target resource does not need to be collected.

Supported object properties for filtering:

Property Description
name Resource ID
resourceId Resource ID (same as name field)
resourceName Resource name
resourceGroup Resource group name
location Resource location
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Example: Enable a filter based on the resourceId property of an object; configuration format is as follows:
def filter_instance(instance):
    '''
    Collect instances with resourceId xxx
    '''
    # return True
    r_id = instance['resourceId']
    if r_id in ['xxx']:
        return True
    return False

@DFF.API('Azure-Load Balancer Collection', timeout=3600, fixed_crontab='*/15 * * * *')
def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_instance])).run()

3. Data Reporting Format

After data synchronization is successful, the data can be viewed in the "Infrastructure - Resource Catalog" section of {{( brand_name }}}.

Example of reported data:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "measurement": "azure_network_loadbalancers",
  "tags": {
    "cloud_provider" : "azure",
    "location"       : "westus2",
    "name"           : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.network/loadbalancers/lll",
    "resource_group" : "xxx",
    "resource_id"    : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.network/loadbalancers/lll",
    "resource_name"  : "lll",
    "subscription_id": "sss",
    "tenant_id"      : "ce9fe5b4-xxxx",
  },
  "fields": {
    "sku"                       : "{server SKU}",
    "frontend_ip_configurations": "[front-end IP configurations]",
    "backend_address_pools"     : "[back-end pool]"
    "message"                   : "{instance JSON data}",
    "tags"                      : "{tags configured in Azure console}"
  }
}

Fields in tags and fields may change with subsequent updates

The value of tags.name is the instance ID, serving as a unique identifier

fields.message, fields.sku, fields.frontend_ip_configurations, fields.backend_address_pools, fields.tags are all strings after JSON serialization

X. Appendix

Azure related documents: