Skip to content

Configuration Manual for the "Azure-Virtual Network Collection" Collector

Before reading this article, please first read:

Before using this collector, you must install the 'Integration Core Package' and its corresponding 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, example: westus2

2. Configuration Examples

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 under the subscription ID: xxxx1 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 attributes. The filter function returns True｜False.

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

Supported object attributes:

Attribute 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 the filter, filter by the resourceId of the object, with the following configuration format:
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-Virtual Network 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, you can view the data in the "Infrastructure - Resource Catalog" section of {{( brand_name }}}.

An example of reported data is as follows:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "measurement": "azure_network_virtualnetworks",
  "tags": {
    "cloud_provider": "azure",
    "location"      : "westus2",
    "name"          : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.network/virtualnetworks/vvv",
    "resource_group" : "xxx",
    "resource_id"    : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.network/virtualnetworks/vvv",
    "resource_name"  : "vvv",
    "subscription_id": "sss",
    "tenant_id"      : "ce9fe5b4-xxxx",
    "provisioning_state": "Succeeded",
  },
  "fields": {
    "address_space"  : "[Range of IP addresses available for subnet]",
    "subnets"       : "[Collection of subnets]",
    "message"       : "{Instance JSON data}",
    "tags"          : "{Tags configured in the Azure Console}"
  }
}

Fields in tags and fields may change with subsequent updates

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

fields.message, fields.tags, fields.address_space, fields.subnets are all strings after JSON serialization

X. Appendix

Azure related documentation: