{"id":15021206,"url":"https://github.com/microsoft/ari","last_synced_at":"2025-05-14T12:07:52.592Z","repository":{"id":37679074,"uuid":"318340455","full_name":"microsoft/ARI","owner":"microsoft","description":"Azure Resource Inventory - It's a Powerful tool to create EXCEL inventory from Azure Resources with low effort","archived":false,"fork":false,"pushed_at":"2025-04-07T13:58:47.000Z","size":6512,"stargazers_count":1235,"open_issues_count":8,"forks_count":424,"subscribers_count":63,"default_branch":"main","last_synced_at":"2025-04-08T10:11:30.519Z","etag":null,"topics":["architecture","azure","azure-cloudshell","azure-inventory","azure-resource-inventory","cloud","documentation","importexcel","inventory","powershell"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-03T22:50:08.000Z","updated_at":"2025-04-07T13:49:53.000Z","dependencies_parsed_at":"2023-02-09T16:45:58.801Z","dependency_job_id":"8c092add-40ae-4e84-8bf4-9afaaf16bf61","html_url":"https://github.com/microsoft/ARI","commit_stats":{"total_commits":353,"total_committers":25,"mean_commits":14.12,"dds":0.7365439093484419,"last_synced_commit":"9a66b8a98561246b16343fae8274768de1fd9aaa"},"previous_names":["azureinventory/ari"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FARI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FARI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FARI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2FARI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/ARI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248476773,"owners_count":21110353,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture","azure","azure-cloudshell","azure-inventory","azure-resource-inventory","cloud","documentation","importexcel","inventory","powershell"],"created_at":"2024-09-24T19:56:17.543Z","updated_at":"2025-05-14T12:07:52.579Z","avatar_url":"https://github.com/microsoft.png","language":"PowerShell","readme":"---\nArtifactType: Excel spreadsheet with the full Azure environment\nLanguage: PowerShell\nPlatform: Windows / Linux / Mac\nTags: PowerShell, Azure, Inventory, Excel Report, Customer Engineer\n---\n\n\u003cdiv align=\"center\"\u003e\n\n# Azure Resource Inventory (ARI)\n\n\u003cimg src=\"images/ARI_Logo.png\" width=\"300\"\u003e\n\n### A powerful PowerShell module for generating comprehensive Azure environment reports\n\n[![GitHub](https://img.shields.io/github/license/microsoft/ARI)](https://github.com/microsoft/ARI/blob/main/LICENSE)\n[![GitHub repo size](https://img.shields.io/github/repo-size/microsoft/ARI)](https://github.com/microsoft/ARI)\n[![GitHub last commit](https://img.shields.io/github/last-commit/microsoft/ARI)](https://github.com/microsoft/ARI/commits/main)\n[![GitHub top language](https://img.shields.io/github/languages/top/microsoft/ARI)](https://github.com/microsoft/ARI)\n[![Azure](https://badgen.net/badge/icon/azure?icon=azure\u0026label)](https://azure.microsoft.com)\n\n\u003c/div\u003e\n\n## 📋 Table of Contents\n\n- [Overview](#-overview)\n- [Key Features](#-key-features)\n- [Getting Started](#-getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n  - [Quick Start](#quick-start)\n- [Usage Guide](#-usage-guide)\n  - [Basic Commands](#basic-commands)\n  - [Common Scenarios](#common-scenarios)\n- [Parameters Reference](#-parameters-reference)\n- [Output Examples](#-output-examples)\n  - [Excel Report](#excel-report)\n  - [Network Topology View](#network-topology-view)\n  - [Organization View](#organization-view)\n  - [Resources View](#resources-view)\n- [Important Notes](#-important-notes)\n- [Authors \u0026 Acknowledgments](#-authors--acknowledgments)\n- [Contributing](#-contributing)\n- [License](#-license)\n\n## 🔍 Overview\n\nAzure 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.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/ARIv35-Overview.png\" width=\"700\"\u003e\n\u003c/p\u003e\n\n## ✨ Key Features\n\n- **Complete Resource Documentation**: Detailed inventory of all Azure resources\n- **Interactive Excel Reports**: Well-formatted spreadsheets with resources organized by type\n- **Visual Network Diagrams**: Generate interactive topology maps of your Azure environment\n- **Security Analysis**: Integration with Azure Security Center (optional)\n- **Cross-Platform Support**: Works on Windows, Linux, Mac, and Azure Cloud Shell\n- **Automation-Ready**: Can be deployed via Azure Automation Accounts\n- **Low-Impact**: Read-only operations with no changes to your environment\n\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n- PowerShell 7.0+ (recommended) or PowerShell 5.1\n- Azure Account with read access to resources you want to inventory\n- Administrator privileges during script execution (for module installation)\n\n### Installation\n\nInstall the module directly from PowerShell Gallery:\n\n```powershell\nInstall-Module -Name AzureResourceInventory\n```\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/InstallARI.gif\" width=\"700\"\u003e\n\u003c/p\u003e\n\n\n### Quick Start\n\nTo generate a basic inventory report:\n\n```powershell\nImport-Module AzureResourceInventory\n```\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/ImportingARI.gif\" width=\"700\"\u003e\n\u003c/p\u003e\n\n\n```powershell\nInvoke-ARI\n```\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/RunningARI.gif\" width=\"700\"\u003e\n\u003c/p\u003e\n\n## 📖 Usage Guide\n\n### Basic Commands\n\nRun ARI with specific tenant:\n\n```powershell\nInvoke-ARI -TenantID \u003cAzure-Tenant-ID\u003e\n```\n\nScope to specific subscription:\n\n```powershell\nInvoke-ARI -TenantID \u003cAzure-Tenant-ID\u003e -SubscriptionID \u003cSubscription-ID\u003e\n```\n\nInclude resource tags in the report:\n\n```powershell\nInvoke-ARI -TenantID \u003cAzure-Tenant-ID\u003e -IncludeTags\n```\n\n### Common Scenarios\n\n**Run in Azure Cloud Shell:**\n\n```powershell\nInvoke-ARI -Debug\n```\n\n**Include Security Center Data:**\n\n```powershell\nInvoke-ARI -TenantID \u003cAzure-Tenant-ID\u003e -SubscriptionID \u003cSubscription-ID\u003e -SecurityCenter\n```\n\n**Skip Azure Advisor Data Collection:**\n\n```powershell\nInvoke-ARI -TenantID \u003cAzure-Tenant-ID\u003e -SubscriptionID \u003cSubscription-ID\u003e -SkipAdvisory\n```\n\n**Skip Network Diagram Generation:**\n\n```powershell\nInvoke-ARI -TenantID \u003cAzure-Tenant-ID\u003e -SkipDiagram\n```\n\n### Automation Account Integration\n\nIf you want to automatically run ARI, there is a way to do it using Automation Accounts:\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/Automation.png\" width=\"600\"\u003e\n\u003c/p\u003e\n\nSee the [Automation Guide](https://github.com/microsoft/ARI/blob/main/docs/advanced/automation.md) for implementation details.\n\n## 📝 Parameters Reference\n\n| Parameter | Description | Usage |\n|-----------|-------------|-------|\n| **Core Parameters** | | |\n| TenantID | Specify the tenant ID for inventory | `-TenantID \u003cID\u003e` |\n| SubscriptionID | Specify subscription(s) to inventory | `-SubscriptionID \u003cID\u003e` |\n| ResourceGroup | Limit inventory to specific resource group(s) | `-ResourceGroup \u003cNAME\u003e` |\n| **Authentication** | | |\n| AppId | Application ID for service principal auth | `-AppId \u003cID\u003e` |\n| Secret | Secret for service principal authentication | `-Secret \u003cVALUE\u003e` |\n| CertificatePath | Certificate path for service principal | `-CertificatePath \u003cPATH\u003e` |\n| DeviceLogin | Use device login authentication | `-DeviceLogin` |\n| **Scope Control** | | |\n| ManagementGroup | Inventory all subscriptions in management group | `-ManagementGroup \u003cID\u003e` |\n| TagKey | Filter resources by tag key | `-TagKey \u003cNAME\u003e` |\n| TagValue | Filter resources by tag value | `-TagValue \u003cNAME\u003e` |\n| **Content Options** | | |\n| SecurityCenter | Include Security Center data | `-SecurityCenter` |\n| IncludeTags | Include resource tags | `-IncludeTags` |\n| SkipPolicy | Skip Azure Policy collection | `-SkipPolicy` |\n| SkipVMDetails | Skip Azure VM Extra Details collection | `-SkipVMDetails` |\n| SkipAdvisory | Skip Azure Advisory collection | `-SkipAdvisory` |\n| IncludeCosts | Includes Azure Cost details for the Subscriptions (Requires the module Az.CostManagement) | `-IncludeCosts` |\n| SkipVMDetails | Skip extra details for the VM Families (Quota, vCPUs and memory) | `-SkipVMDetails` |\n| **Output Options** | | |\n| ReportName | Custom report filename | `-ReportName \u003cNAME\u003e` |\n| ReportDir | Custom directory for report | `-ReportDir \"\u003cPath\u003e\"` |\n| Lite | Use lightweight Excel generation (no charts) | `-Lite` |\n| **Diagram Options** | | |\n| SkipDiagram | Skip diagram creation | `-SkipDiagram` |\n| DiagramFullEnvironment | Include all network components in diagram | `-DiagramFullEnvironment` |\n| **Other Options** | | |\n| Debug | Run in debug mode | `-Debug` |\n| NoAutoUpdate | Skip the auto update of the ARI Module | `-NoAutoUpdate` |\n| AzureEnvironment | Specify Azure cloud environment | `-AzureEnvironment \u003cNAME\u003e` |\n| Automation | Run using Automation Account | `-Automation` |\n| StorageAccount | Storage account for automation output | `-StorageAccount \u003cNAME\u003e` |\n| StorageContainer | Storage container for automation output | `-StorageContainer \u003cNAME\u003e` |\n\n## 📊 Output Examples\n\n### Excel Report\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/ARIv3ExcelExample.png\" width=\"800\"\u003e\n\u003c/p\u003e\n\n### Network Topology View\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/DrawioImage.png\" width=\"700\"\u003e\n\u003c/p\u003e\n\nInteractive features show resource details on hover:\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/ARIv3DrawioHover.png\" width=\"400\"\u003e\n  \u003cimg src=\"images/ARIv3DrawioPeer.png\" width=\"400\"\u003e\n\u003c/p\u003e\n\n### Organization View\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/DrawioOrganization.png\" width=\"700\"\u003e\n\u003c/p\u003e\n\n### Resources View\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/drawiosubs.png\" width=\"700\"\u003e\n\u003c/p\u003e\n\n## ⚠️ Important Notes\n\n\u003e **Very Important:** ARI will not upgrade existing PowerShell modules. Ensure you have the required modules installed.\n\n\u003e **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.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/cloudshell-warning-lib.png\" width=\"600\"\u003e\n\u003c/p\u003e\n\n### Our Test Environment\n\n| Tool | Version |\n|------|---------|\n| Windows | 11 22H2 |\n| PowerShell | 7.4.4 |\n\n### Output Details\n\n- Default output location:\n  - Windows: `C:\\AzureResourceInventory\\`\n  - Linux/CloudShell: `$HOME/AzureResourceInventory/`\n- Output filename format: `AzureResourceInventory_Report_yyyy-MM-dd_HH_mm.xlsx`\n- Diagram filename format: `AzureResourceInventory_Diagram_yyyy-MM-dd_HH_mm.xml` (Draw.io format)\n\n## 👥 Authors \u0026 Acknowledgments\n\n- **Claudio Merola** (\u003cclaudio.merola@microsoft.com\u003e)\n- **Renato Gregio**\n\nSpecial thanks to **Doug Finke**, the author of PowerShell [ImportExcel](https://github.com/dfinke/ImportExcel) module.\n\n## 🤝 Contributing\n\nPlease read our [CONTRIBUTING.md](CONTRIBUTING.md) which outlines all policies, procedures, and requirements for contributing to this project.\n\n## 📜 License\n\nCopyright (c) 2025 Microsoft Corporation. All rights reserved.\n\nLicensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\nThis 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 \u0026 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.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fari","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fari","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fari/lists"}