Skip to content

spreegabe/AriPlus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AriPlus

AriPlus is an enhanced version of the Azure Resource Inventory (ARI) tool. ARI is a robust PowerShell script provided by Microsoft that generates an Excel report of any Azure environment to which you have read access. This tool aims to assist Cloud Administrators and other professionals in creating a comprehensive Excel report of an Azure Environment quickly and easily. AriPlus enhances the original script by capturing additional utilization metrics.

Table of Contents

Prerequisites

AriPlus can be executed in both Azure Cloudshell and PowerShell Desktop environments.

Requirements

Note: By default, Azure Resource Inventory will attempt to install the necessary PowerShell modules and Azure CLI components, but you need administrator privileges during the script execution.

  • PowerShell 7 or Azure CloudShell
  • Azure CLI
  • Azure CLI Account Extension
  • Azure CLI Resource-Graph Extension

Dependencies

Install the required PowerShell module:

Install-Module ImportExcel

Installation

  1. Clone the repository or download the ResourceInventory.ps1 script.
git clone https://github.com/stefoy/AriPlus
  1. Run the script. If you are in Azure CloudShell, you're already authenticated. In PowerShell Desktop, you will be redirected to the Azure sign-in page.
./ResourceInventory.ps1 -Online

Running the Script

AriPlus uses concurrency to execute commands in parallel, especially when gathering metrics. By default, the concurrency limit is set to 6. To change this, use the -ConcurrencyLimit option.

The -Online option fetches the latest modules from GitHub, meaning you only need to download the ResourceInventory.ps1.

Standard ARI+ Output:

./ResourceInventory.ps1 -Online -ConcurrencyLimit 8

Consumption ARI+ Output

This provides the Consumption in the ARI+ which will give a more comprehensive mapping of the Azure Environment

./ResourceInventory.ps1 -Online -ConcurrencyLimit 10 -Consumption -Debug

Parameters

The following table lists the parameters that can be used with the script:

Parameter Type Description
$TenantID String Specifies the Tenant ID you want to create a Resource Inventory
$Appid String Service Principal Authentication ID.
$SubscriptionID String Specifies the Subscription which will be run for Inventory.
$Secret String Client Secret of the Service Principal key.
$ResourceGroup String Specifies the Resource Group.
$Online Switch A switch to indicate if online mode is used.
$Debug Switch Enable Debug Mode
$SkipMetrics Switch A switch to skip metrics retrieval.
$Help Switch A switch to display the help message.
$Consumption Switch A switch to indicate if consumption metrics should be gathered.
$DeviceLogin Switch A switch to trigger device login.
$ConcurrencyLimit Integer Specifies the concurrency limit for parallel command execution. Default value is 6.

Script Output/Reports

When the script has completed, a zip file of the report will be saved in the folder AriPlusReports.


⚠️ Warning Messages

  • Important: Azure Resource Inventory will not upgrade the current version of the Powershell modules.

  • Important: If you're running the script inside Azure CloudShell, the final Excel will not have auto-fit columns, and you will see warnings during the script execution. This is an issue with the Import-Excel module but it does not affect the inventory which will remain accurate.


Acknowledgments

Special thanks to Doug Finke, the author of the PowerShell ImportExcel Module.


About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •