Detect and Report Azure IP Address Changes

Perl script that will query an external website to download and filter on data centers, regions, and services available from the Microsoft Azure cloud services in order to report on published IPv4 and IPv6 addresses. Create named baselines based on selected parameters in order to display IP address changes so that layer 3/4 boundary devices can be proactively configured to avoid service disruption. After the environment is configured with the necessary system packages and libraries, the program does not need any elevated permissions to run.

Installation Requirements

The Perl Script has been tested on Windows WSL and Ubuntu installations and requires the following Packages and Perl libraries to be installed.

Ubuntu System Packages

Here are the following Ubuntu system packages necessary to allow proper installation of the Perl libraries

cpanminus
build-essential
libwww-perl
libssl-dev
lib32z1-dev

Use the following command to install all system packages on Ubuntu

sudo apt update && sudo apt install cpanminus build-essential libwww-perl libssl-dev lib32z1-dev

Perl Libraries

The following Perl libraries required

Getopt::Long
LWP::UserAgent
LWP::Protocol::https
LWP::Simple
Date::EzDate
File::Copy

Use the following command to install all necessary Perl libraries and dependencies:

sudo cpanm Getopt::Long LWP::UserAgent LWP::Protocol::https LWP::Simple  Date::EzDate File::Copy

Typical Workflow

Here is the general outline on how this program should be utilized.

1. Determine what selections are required for your utilization of Azure cloud services.

   1. Choose your datacenter(s) using --parent. Options are "All, Public, Government, Germany, and China", multiple selections are permitted.
   2. Use --show and --csv with your --parent selection to generate a CSV output for filtering the available --regions and --services to meet your requirements.
   3. Import and save your options using --import_csv and --set_opt for future queries.

2. Create a baseline based on your selections.

   1. Use --create_baseline and --use_opt (or CLI options) to create a named baseline for a snapshot of the existing state.
   2. Multiple baselines can be created by calling the program again and providing a different name.

3. Use the baseline to detect any IP address changes.

   1. Using a baseline must include options (saved or CLI). Note it is NOT recommended changing options from the initial baseline creation and running --delta that compares that baseline against the current state.
   2. Use the same options when creating a baseline and performing a comparison. This includes the use of --ipv4 and/or --ipv6 for consistent and reliable output.

4. Automate the program to notify stakeholders of IP address changes.

   1. Run the program as a cron job to routinely check for IP address changes.
   2. Save the program output to a file to be used for your preferred method of sending a notification. (E.g., Have a separate cron job running Sendmail to read the outputted data into the body of an e-mail message.)

5. Choose to either manually update the baseline, or automatically update the baseline.

   1. The manual method will result in displaying the IP changes on each program execution, until a new baseline is created.
   2. The automatic method will overwrite the existing baseline on each program call after displaying IP changes. (Use --create_baseline "name of baseline" with --use_baseline "name of baseline)

Basic Usage

Display usage information:

./azure_datacenter_ip.pl --help

Select which Azure datacenter(s) are applicable to your environment and show all available regions and services that are available. Parent will default to 'Public' but the available options are: 'All, Public, Germany, Government, and China'

./azure_datacenter_ip.pl --parent public germany --show

Sample output:

Parent
        Region
                SystemService

germany
        common
                azuresiterecovery
                azurebackup
                azureiothub
                azureconnectors
...continued (2,000+ additional lines)

Format the output for easier manipulation and filtering:

./azure_datacenter_ip.pl --show --parent public germany --csv

Sample output:

Parent,Region,SystemService
public,uaecentral,hdinsight
public,uaecentral,azureservicebus
public,uaecentral,azuredataexplorermanagement
public,uaecentral,azuremachinelearning
...

Note: Recommend writing the CSV output to a file to filter the results to only the datacenter(s), region(s), and service(s) that are responsive to your use of Azure cloud services. (See the option --import_csv "csvfile.csv" below) to save those options to a user-provided name.

Display the IP addresses that are currently in use, after the selections (datacenter(s), region(s), service(s)) are determined.

./azure_datacenter_ip.pl --display --ipv4 --parent public --region eastus westus --service actiongroup azuredevops commonservice

Sample output:

public
        eastus
                azuredevops
IPv4
20.42.5.0/24

public
        eastus
                commonservice
IPv4
13.68.128.0/17
13.72.64.0/18

Only display the unique IPv4 and/or IPv6 addresses that are in use for easier importing into your network device(s) by using --compress.

./azure_datacenter_ip.pl --display --ipv4 --compress --parent public --region eastus westus --service actiongroup azuredevops commonservice

Sample output:

Unique IPv4 Addresses based on the selected scope
=================================================
52.152.128.0/17
20.85.128.0/17
168.61.0.0/19
52.101.52.0/22
168.62.192.0/19
...

Note: Command Line Interface (CLI) definition(s) of --region and --service will apply to all of the selected scope. E.g., Choosing the service named "AzureDevOps" will bring it into scope for all chosen regions and datacenters selected, which may not have the granularity that is desired. Instead, use --import_csv and --set_opt "my options" to set your specificity.

Save your CLI selection to a user defined name using --set_opt "user defined name". Multiple options can be defined and recalled.

./azure_datacenter_ip.pl --set_opt "my options" --parent public --region eastus westus --service actiongroup

Save your CSV selections using --import_csv "./my_csvselections.csv" and --set_opt "My Options"

./azure_datacenter_ip.pl --import_csv "my_csvselections.csv" --set_opt "my options"

Use your saved selections using --use_opt "my options".

./azure_datacenter_ip.pl --use_opt "my options" --display --ipv4 --compress

Create a baseline using --create_baseline "new baseline" using your selection or saved options. A baseline creates a point in time snapshot to display IPs based on your selected options based on the historical data. Baselines are primarily used with --delta described below.

Building a baseline using stored options:

./azure_datacenter_ip.pl --use_opt "my options" --create_baseline "new baseline"

Buiding a baseline using CLI options. (Note: Less granular)

./azure_datacenter_ip.pl --create_baseline "new baseline" --parent public --region eastus westus --service actiongroup azuredevops commonservice

Use a baseline using --use_baseline "new baseline" to --show --display, or --delta options based on options selected on the CLI or saved options.

./azure_datacenter_ip.pl --use_baseline "new baseline" --use_opt "my options" --display --ipv4 --ipv6

IP Changes: To display IP address changes, use --delta with chosen options. Must be used with --use_baseline. Compatible with --create_baseline, --ipv4, --ipv6, --csv, and --compress.

./azure_datacenter_ip.pl --delta --use_baseline "new baseline" --use_opt "my options" --ipv4 --ipv6 --compress

IP Changes and create new baseline: When running this program from a scheduled job (cron) consider using --create_baseline to automatically overwrite the named baseline after the program provides the IP changes.

./azure_datacenter_ip.pl --delta --use_baseline "new baseline" --create_baseine "new baseline" --use_opt "my options" --ipv4 --ipv6 --compress

Program Environment

The program will create various files and folders within the working directory to function.

./logs/azure_ip.log - Contains log files that are generated during the execution of the script. The command issued, what functions are called, warning messages, and error messages.

./baseline/YYYY-MM-DD-epoch_in_seconds_datacenter - Stores the raw JSON file(s) downloaded from "https://azservicetags.azurewebsites.net/" when --create_baseline is used.

./data/azure_ip.opt - File containing all stored options. Used when setting or using user defined options.

./data/azure_ip.bas - File containing all stored baselines names and the associated JSON file stored in ./baseline/

./report/YYYY-MM-DD-epoch_in_seconds - Contains all program output when --delta is called in case a notification was missed.

Full Usage Information

Purpose:

Provide the capability to display IPv4 or IPv6 addresses related to Microsoft's Azure datacenter services. Create a baseline of active IPs and compare against that baseline to find IP address changes, or changes to regions or services. Output can be sent to an external program for e-mail notification, but log files and delta reports are also generated based on each call to create a baseline or view a change in case a notification was missed. Run this program to determine the available data centers, regions, and services. Then display the IPv4 or IPv6 addresses that are currently in use. When satisfied on the scope of services selected, create a baseline based on those parameters. Finally, run this program from a cron or scheduled service to output the delta's and create a new baseline if changes were detected.

Usage:
      --help          This output for usage information

      --parent        Defaults to "Public". Choose the primary datacenter location (space separated list can be provided on the command line for multiple datacenters, or all)
                      Available options are: "government, public, germany, china, all"

      --region        Defaults to "All". Choose available regions (space separated list can be provided on the command line for multiple regions)

      --service       Defaults to "All". Choose available services (space separated list can be provided on the command line for multiple services)

      --show          Sets a flag to show available parents, regions, and services to filter on for use with the other options

      --display       Sets a flag to display the IPs based on the parent, region, service. Additional options are IPv4/IPv6 and output can be compressed, CSV, or default

      --csv           Sets a flag to output content in CSV (Comma Separated Values) format

      --compress      Sets a flag to only show unique IP addresses rather than displaying likely duplicates under each parent, region, and service

      --ipv4          Sets a flag to only provide IPv4 addresses that are responsive to the parent, region, and service (can be combined with --ipv6)

      --ipv6          Sets a flag to only provide IPv6 addresses that are responsive to the parent, region, and service (can be combined with --ipv4)

      --import_csv    Must be used with --use_opt. Provide a quoted string containing the path and filename of the csv to import selected options for more granular and easier configuration
                      First run --show with "--parent all --csv" and filter the results to options that are desired. Then import to save those options in "./data/azure_ip.opt"

      --set_opt       Provide a quoted string to save the options (parent, region, service) using the file ./data/azure_ip.opt to a name (case insensitive) set in --import_csv or on the CLI to ./data/azure_ip.opt
                      Can only be used with the following options "--parent --region --service or --import_csv"

      --use_opt       Provide a quoted string to read the options (parent, region, service) using the stored name in file ./data/azure_ip.opt)
                      Can only be used with the following options "--import_csv --display --delta --create_baseline --use_baseline --show"

      --delta         Sets a flag to compare selected baseline (--use_baseline) against the current state by using either the options chosen from --use_opt or the CLI.
                      Can be combined with --create_baseline to display the delta and either create a new baseline or overwrite the existing depending on the name provided.

      --create_baseline       Provide a quoted string containing the baseline file name to create.  Create a new baseline on based on the selected parent.
                              Creates an entry in ./data/azure_ip.bas and writes the raw JSON files to the following directory ./baselines/.

Examples:
      ./azure_datacenter_ip.pl --show --parent public --region eastus2 --csv
              Shows all available "services" for the Public cloud in the eastus2 region in CSV format. (Use this format to filter in your favorite spreadsheet and import to save your selection)

      ./azure_datacenter_ip.pl --display --parent all --region all --service AzureStorage --service AzureSQL --ipv4
              Displays all IPv4 address currently in use for all clouds and all regions, if they are tagged as an AzureStorage and AzureSQL service

      ./azure_datacenter_ip.pl --display --create_baseline "new_baseline_filename" --parent government --region uswest --compress
              Creates a new file in the baselines subdirectory based on the name provided that contains the current state based on your selection of government cloud and all services in the uswest region
              Additionally, the IP addresses are "compressed" so that no duplicate IPs are displayed (Easier updates for network configurations)
      ./azure_datacenter_ip.pl --display --delta --use_baseline "existing baseline file name"
              Displays the delta's based on the options stored in the selected baseline from the corresponding file(s) in the baseline subdirectory