Skip to content

Collector Configuration Manual for "Azure-Storage Collection"

Before reading this article, please read the following first:

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, e.g.: westus2

2. Configuration Examples

Specifying Subscriptions

Collect all instance objects under the subscription ID: xxxx1

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

Specifying Subscriptions and Regions

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']
}

Configuring Filters (Optional)

This collector script supports user-defined filters, allowing users to filter target resources by object attributes. 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 attributes:

Attribute Description
name Resource ID
resourceId Resource ID (same as the 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, 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-Storage 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 {{( brand_name )}} "Infrastructure - Resource Catalog".

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_storage_storageaccounts",
  "tags": {
    "cloud_provider": "azure",
    "location"      : "westus2",
    "name"          : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.storage/storageaccounts/aaa",
    "resource_group" : "xxx",
    "resource_id"    : "/subscriptions/sss/resourcegroups/xxx/providers/microsoft.storage/storageaccounts/aaa",
    "resource_name"  : "aaa",
    "subscription_id": "sss",
    "tenant_id"      : "ce9fe5b4-xxxx",
  },
  "fields": {
    "encryption"              : "{encryption data}",
    "primary_endpoints"        : "{service main node}",
    "sku"                     : "{server SKU}",
    "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.sku, fields.encryption, fields.primary_endpoints, fields.tags are all serialized JSON strings.

X. Appendix

Azure-related documentation: