https://github.com/microsoft/ari
Azure Resource Inventory - It's a Powerful tool to create EXCEL inventory from Azure Resources with low effort
https://github.com/microsoft/ari
architecture azure azure-cloudshell azure-inventory azure-resource-inventory cloud documentation importexcel inventory powershell
Last synced: 11 days ago
JSON representation
Azure Resource Inventory - It's a Powerful tool to create EXCEL inventory from Azure Resources with low effort
- Host: GitHub
- URL: https://github.com/microsoft/ari
- Owner: microsoft
- License: mit
- Created: 2020-12-03T22:50:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T13:58:47.000Z (16 days ago)
- Last Synced: 2025-04-08T10:11:30.519Z (15 days ago)
- Topics: architecture, azure, azure-cloudshell, azure-inventory, azure-resource-inventory, cloud, documentation, importexcel, inventory, powershell
- Language: PowerShell
- Homepage:
- Size: 6.21 MB
- Stars: 1,235
- Watchers: 63
- Forks: 424
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
---
ArtifactType: Excel spreadsheet with the full Azure environment
Language: PowerShell
Platform: Windows / Linux / Mac
Tags: PowerShell, Azure, Inventory, Excel Report, Customer Engineer
---
# Azure Resource Inventory (ARI)
### A powerful PowerShell module for generating comprehensive Azure environment reports
[](https://github.com/microsoft/ARI/blob/main/LICENSE)
[](https://github.com/microsoft/ARI)
[](https://github.com/microsoft/ARI/commits/main)
[](https://github.com/microsoft/ARI)
[](https://azure.microsoft.com)
## 📋 Table of Contents
- [Overview](#-overview)
- [Key Features](#-key-features)
- [Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Usage Guide](#-usage-guide)
- [Basic Commands](#basic-commands)
- [Common Scenarios](#common-scenarios)
- [Parameters Reference](#-parameters-reference)
- [Output Examples](#-output-examples)
- [Excel Report](#excel-report)
- [Network Topology View](#network-topology-view)
- [Organization View](#organization-view)
- [Resources View](#resources-view)
- [Important Notes](#-important-notes)
- [Authors & Acknowledgments](#-authors--acknowledgments)
- [Contributing](#-contributing)
- [License](#-license)
## 🔍 Overview
Azure Resource Inventory (ARI) is a comprehensive PowerShell module that generates detailed Excel reports of any Azure environment you have read access to. It is designed for Cloud Administrators and technical professionals who need an easy and fast way to document their Azure environments.
## ✨ Key Features
- **Complete Resource Documentation**: Detailed inventory of all Azure resources
- **Interactive Excel Reports**: Well-formatted spreadsheets with resources organized by type
- **Visual Network Diagrams**: Generate interactive topology maps of your Azure environment
- **Security Analysis**: Integration with Azure Security Center (optional)
- **Cross-Platform Support**: Works on Windows, Linux, Mac, and Azure Cloud Shell
- **Automation-Ready**: Can be deployed via Azure Automation Accounts
- **Low-Impact**: Read-only operations with no changes to your environment
## 🚀 Getting Started
### Prerequisites
- PowerShell 7.0+ (recommended) or PowerShell 5.1
- Azure Account with read access to resources you want to inventory
- Administrator privileges during script execution (for module installation)
### Installation
Install the module directly from PowerShell Gallery:
```powershell
Install-Module -Name AzureResourceInventory
```
### Quick Start
To generate a basic inventory report:
```powershell
Import-Module AzureResourceInventory
```
```powershell
Invoke-ARI
```
## 📖 Usage Guide
### Basic Commands
Run ARI with specific tenant:
```powershell
Invoke-ARI -TenantID
```
Scope to specific subscription:
```powershell
Invoke-ARI -TenantID -SubscriptionID
```
Include resource tags in the report:
```powershell
Invoke-ARI -TenantID -IncludeTags
```
### Common Scenarios
**Run in Azure Cloud Shell:**
```powershell
Invoke-ARI -Debug
```
**Include Security Center Data:**
```powershell
Invoke-ARI -TenantID -SubscriptionID -SecurityCenter
```
**Skip Azure Advisor Data Collection:**
```powershell
Invoke-ARI -TenantID -SubscriptionID -SkipAdvisory
```
**Skip Network Diagram Generation:**
```powershell
Invoke-ARI -TenantID -SkipDiagram
```
### Automation Account Integration
If you want to automatically run ARI, there is a way to do it using Automation Accounts:
See the [Automation Guide](https://github.com/microsoft/ARI/blob/main/Docs/Automation.md) for implementation details.
## 📝 Parameters Reference
| Parameter | Description | Usage |
|-----------|-------------|-------|
| **Core Parameters** | | |
| TenantID | Specify the tenant ID for inventory | `-TenantID ` |
| SubscriptionID | Specify subscription(s) to inventory | `-SubscriptionID ` |
| ResourceGroup | Limit inventory to specific resource group(s) | `-ResourceGroup ` |
| **Authentication** | | |
| AppId | Application ID for service principal auth | `-AppId ` |
| Secret | Secret for service principal authentication | `-Secret ` |
| CertificatePath | Certificate path for service principal | `-CertificatePath ` |
| DeviceLogin | Use device login authentication | `-DeviceLogin` |
| **Scope Control** | | |
| ManagementGroup | Inventory all subscriptions in management group | `-ManagementGroup ` |
| TagKey | Filter resources by tag key | `-TagKey ` |
| TagValue | Filter resources by tag value | `-TagValue ` |
| **Content Options** | | |
| SecurityCenter | Include Security Center data | `-SecurityCenter` |
| IncludeTags | Include resource tags | `-IncludeTags` |
| SkipPolicy | Skip Azure Policy collection | `-SkipPolicy` |
| SkipVMDetails | Skip Azure VM Extra Details collection | `-SkipVMDetails` |
| SkipAdvisory | Skip Azure Advisory collection | `-SkipAdvisory` |
| IncludeCosts | Includes Azure Cost details for the Subscriptions (Requires the module Az.CostManagement) | `-IncludeCosts` |
| SkipVMDetails | Skip extra details for the VM Families (Quota, vCPUs and memory) | `-SkipVMDetails` |
| **Output Options** | | |
| ReportName | Custom report filename | `-ReportName ` |
| ReportDir | Custom directory for report | `-ReportDir ""` |
| Lite | Use lightweight Excel generation (no charts) | `-Lite` |
| **Diagram Options** | | |
| SkipDiagram | Skip diagram creation | `-SkipDiagram` |
| DiagramFullEnvironment | Include all network components in diagram | `-DiagramFullEnvironment` |
| **Other Options** | | |
| Debug | Run in debug mode | `-Debug` |
| NoAutoUpdate | Skip the auto update of the ARI Module | `-NoAutoUpdate` |
| AzureEnvironment | Specify Azure cloud environment | `-AzureEnvironment ` |
| Automation | Run using Automation Account | `-Automation` |
| StorageAccount | Storage account for automation output | `-StorageAccount ` |
| StorageContainer | Storage container for automation output | `-StorageContainer ` |
## 📊 Output Examples
### Excel Report
### Network Topology View
Interactive features show resource details on hover:
### Organization View
### Resources View
## ⚠️ Important Notes
> **Very Important:** ARI will not upgrade existing PowerShell modules. Ensure you have the required modules installed.
> **CloudShell Limitation:** When running in Azure CloudShell, the Excel output will not have auto-fit columns and you may see warnings during execution. The inventory results will still be correct.
### Our Test Environment
| Tool | Version |
|------|---------|
| Windows | 11 22H2 |
| PowerShell | 7.4.4 |
### Output Details
- Default output location:
- Windows: `C:\AzureResourceInventory\`
- Linux/CloudShell: `$HOME/AzureResourceInventory/`
- Output filename format: `AzureResourceInventory_Report_yyyy-MM-dd_HH_mm.xlsx`
- Diagram filename format: `AzureResourceInventory_Diagram_yyyy-MM-dd_HH_mm.xml` (Draw.io format)
## 👥 Authors & Acknowledgments
- **Claudio Merola** ()
- **Renato Gregio**
Special thanks to **Doug Finke**, the author of PowerShell [ImportExcel](https://github.com/dfinke/ImportExcel) module.
## 🤝 Contributing
Please read our [CONTRIBUTING.md](CONTRIBUTING.md) which outlines all policies, procedures, and requirements for contributing to this project.
## 📜 License
Copyright (c) 2025 Microsoft Corporation. All rights reserved.
Licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.