Code Monkey home page Code Monkey logo

ari's Introduction

ArtifactType Language Platform Tags
Excel spreedcheet with the full Azure environment
Powershell
Windows
Powershell, Azure, Inventory, Excel Report, Customer Engineer

Azure Resource Inventory V2

Azure Resource inventory (ARI) is a powerful script writen in powershell to generate an Excel report of any Azure Environment you have read access.

This project is intend to help Cloud Admins and anyone that might need an easy and fast way to build a full Excel Report of an Azure Environment.

What's new ?

The first big change in Azure Resource Inventory V2 is the modularization.

  • In ARI V1 we have only one Script. Authentication, Extraction, Data handling and Spreadsheet creation are made in Main Script only ( AzureResourceInventory.ps1 ).
  • In ARI V2 the code is much more efficient. The Main Script is responsable only for Authentication and Extraction. Data management and spreadsheet creation are being performed through external modules that are scanned and executed by the Main script.

New Dashboard Overview

  • New Dashboard with much more information and resource list linking to the sheet.

Overview



Azure Diagram Inventory

  • The BIG Improvement for this version is Azure Diagram Inventory, a Extra Module that create your MS Visio Diagram environment. Overview



To much Resources extraction

For ARI V2 we added much more native modules ( and the possibility to create your own module ;)

Resources and Resource Providers:

Resource Provider Resource Type
microsoft.advisor Advisor
microsoft.security Security Center
microsoft.compute Virtual Machine
microsoft.compute Availability Set
microsoft.compute Virtual Machine Scale Set
microsoft.compute Managed Disk
microsoft.storage Storage Account
microsoft.network Virtual Network
microsoft.network Virtual Network Peerings
microsoft.network Virtual Network Gateway
microsoft.network Virtual WAN
microsoft.network Public IP Address
microsoft.network Load Balancer
microsoft.network Traffic Manager
microsoft.network Application Gateways
microsoft.network Frontdoor
microsoft.network Route Tables
microsoft.network Public DNS Zones
microsoft.network Private DNS Zones
microsoft.network Bastion Hosts
microsoft.network Azure Firewall
microsoft.sqlvirtualmachine SQL VM
microsoft.sql SQL Servers
microsoft.sql SQL Database
microsoft.dbformysql Azure Database for MySQL
microsoft.dbforpostgresql Azure Database for Postgre
microsoft.cache Azure Cache for Redis
microsoft.documentdb Cosmos DB
microsoft.databricks Databricks
microsoft.kusto Data Explorer
microsoft.web App Service Plan
microsoft.web App Services
microsoft.automation Automation Accounts and runbooks
microsoft.eventhub Event HUB
microsoft.servicebus Service BUS
microsoft.operationalinsights Log Analytics Workspaces
microsoft.containerservice Azure Kubernetes Service
microsoft.redhatopenshift Azure RedHat OpenShift
microsoft.desktopvirtualization Azure Virtual Desktop
microsoft.containerinstance Container Instances
microsoft.keyvault Key Vaults
microsoft.recoveryservices Recovery Services Vault
microsoft.devices IoT Hubs
microsoft.apimanagement API Management
microsoft.streamanalytics Streaming Analytics Jobs



Other improvements

  • Quota Usage
  • Service Principal Authentication
  • Scan Modules diretly in GitHub ARI Repository
  • Code Review: reduce and simplify of code, Less Loopings, Bug fix, modularization

Getting Started

These instructions will get you a copy of the project up and running on your local machine or CloudShell.

Supportability

Resource Provider Results VISIO Extension Comments
Windows Fully successfully tested Supported Best Results
MAC Fully successfully tested Not Tested
Linux Tested on Ubuntu Desktop Not Supported No Table auto-fit for columns
CloudShell Tested on Azure CloudShell Not Supported No Table auto-fit for columns

Our Test Environment:

Tool Version
Windows 10 21H1
Powershell 5.1.19041.1237
Az CLI 2.24.0
Resource-Graph 2.1.0
ImportExcel 7.1.3
Microsoft Visio 2018

Prerequisites

You can use Azure Resource Inventory in both in Cloudshell and Powershell Desktop.

What things you need to run the script

1. Install-Module ImportExcel
2. az cli
3. az extension add --name resource-graph

To install Azure CLI go to Microsoft Docs and follow the instructions to install.

By default Azure Resource Inventory will call to install both ImportExcel module and resource-graph extension but you need to have the right privileges during the script execution.

Special Thanks for Doug Finke, the Author of Powershell ImportExcel Module.



Warnings

Very Important: If you alread have Resource-Graph and ImplortExcel Azure Resource Inventory will not upgrade it even if your version isn't supported.
If you're facing the bellow errors during your execution and your inventory aren't being generated check for updates in your Resource Graph extension in Az Cli.

Resource Graph Error

1.  az extension list-available --output table  ## Check if resource-graph extension upgrade is available
2. az extension update --name resource-graph

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 (but the results of your inventory will not be changed :)

CloudShell Warnings

Running the script

  • Its really simple to use Azure Resource Inventory, all that you need to do is to call this script in PowerShell.

  • Run "AzureResourceInventory.ps1". In Azure CloudShell you're already authenticated. In PowerShell Desktop you will be redirected to Azure sign-in page.

Tenants Menu


  • If you have privileges in multiple tenants you can specify the desired one by using "-TenantID" parameter or Azure Resource will scan all your tenants ID and ask you to choose one.

Tenants Menu

  • After properly authenticated and with the TENANT selected, the Azure Resource Inventory will perform all the work of extracting and creating the inventory.

  • The duration will vary according to the number of subscriptions and resources. In our tests we managed to generate in 5 minutes the inventory of a Tenant with 15 subscriptions and about 12000 resources.

  • Azure ResourceInventory uses "C:\AzureResourceInventory" as default folder for PowerShell Desktop in Windows and "$HOME/AzureResourceInventory" for Azure CloudShell to save the final Excel file.

  • This file will have the name "AzureResourceInventory_Report_yyyy-MM-dd_HH_mm.xlsx" where "yyyy-MM-dd_HH_mm" are the date and time that this inventory was created.

ARI Final File Desktop

Versioning and changelog

We use SemVer for versioning. For the versions available, see the tags on this repository.

We also keep the CHANGELOG.md file in repository to Document version changes and updates.

Authors

The main authors of this project are:

  1. Claudio Merola ([email protected]).
  2. Renato Gregio ([email protected])

Contributing

Please read our CONTRIBUTING.md which outlines all of our policies, procedures, and requirements for contributing to this project.

ari's People

Contributors

claudio-merola avatar claudiomerola avatar renatogregio avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.