Coder Social home page Coder Social logo

azqr's Introduction

build CodeQL codecov

Azure Quick Review

Open in vscode.dev

Azure Quick Review (azqr) is a CLI tool used to identify Azure resources that may be or not compliant with Azure best practices and recommendations.

Azure Quick Review (azqr) outputs includes an overview section with the following information:

  • Subscription Id
  • Resource Group name
  • Location
  • Resource Type
  • Resource Name
  • SKU
  • SLA: SLA for the service, given the current configuration.
  • AZ: True if the service is Availability Zone aware.
  • PVT: True if the service has a private IP address.
  • DS: True if the service has diagnotics settings enabled.
  • CAF: True if the service is compliant with the Cloud Adoption Framework naming covention.

Check the Scan Results documentation for more information on Azure Quick Review (azqr) outputs.

Azure Quick Review Rules

Azure Quick Review (azqr) recommendations are based on a set of rules. To learn more check the rules documentation.

Supported Azure Services

  • Azure App Services
  • Azure Functions
  • Azure Container Apps
  • Azure Kubernetes Service
  • Azure Container Instances
  • Azure Container Registry
  • Azure API Management
  • Azure Event Hub
  • Azure Service Bus
  • Azure Event Grid
  • Azure SignalR Service
  • Azure Web PubSub
  • Azure Cache for Redis
  • Azure Cosmos DB
  • Azure Database for PostgreSQL Single Server
  • Azure Database for PostgreSQL Flexible Server
  • Azure Database for MySQL Single Server
  • Azure Database for MySQL Flexible Server
  • Azure SQL Database
  • Azure Key Vault
  • Azure App Configuration
  • Azure Application Gateway
  • Azure Front Door
  • Azure Storage Account
  • Azure Firewall
  • Azure Application Insights

Microsoft Defender Status

Azure Quick Review (azqr) also reports on the status of Microsoft Defender for Cloud plans.

Usage

Install on Linux or Azure Cloud Shell

latest_azqr=$(curl -sL https://api.github.com/repos/cmendible/azqr/releases/latest | jq -r ".tag_name" | cut -c1-)
wget https://github.com/cmendible/azqr/releases/download/$latest_azqr/azqr-ubuntu-latest-amd64 -O azqr
chmod +x azqr

Install on Mac

Download the latest release from here.

Install on Windows

winget install azqr

Authentication

azqr supports the following authentication methods:

  • Azure CLI
  • Service Principal. You'll need to set the following environment variables:
    • AZURE_CLIENT_ID
    • AZURE_CLIENT_SECRET
    • AZURE_TENANT_ID

Authorization

azqr requires the following permissions:

  • Subscription Reader

Running the Scan

To scan all resource groups in all subscription run:

./azqr scan

To scan all resource groups in a specific subscription run:

./azqr scan -s <subscription_id>

To scan a specific resource group in a specific subscription run:

./azqr scan -s <subscription_id> -g <resource_group_name>

For information on available commands and help run:

./azqr -h

Scan Results

Azure Quick Review (azqr) creates an excel spreadsheet with the results of the scan.

By default the Subscription Ids are masked in the spreadsheet.

Check the Azure Quick Review Scan Results documentation for more information.

Troubleshooting

Error: "RESPONSE 429: 429 Too Many Requests"

If the output of azqr shows an error similar to the following:

--------------------------------------------------------------------------------
RESPONSE 429: 429 Too Many Requests
ERROR CODE: ResourceRequestsThrottled
--------------------------------------------------------------------------------
{
  "error": {
    "code": "ResourceRequestsThrottled",
    "message": "Number of requests for action 'Microsoft.Cdn/profiles/read' exceeded the limit of '50' for time interval '00:05:00'. Please try again after '372' seconds."
  }
}

Reduce the number of parallel requests that azqr is making. You can do this by setting the value of the -p parameter to false as in the following example:

./azqr scan -s <subscription_id> -p=false

Support

This project uses GitHub Issues to track bugs and feature requests. Before logging an issue please check our troubleshooting guide.

Please search the existing issues before filing new issues to avoid duplicates.

  • For new issues, file your bug or feature request as a new issue.
  • For help, discussion, and support questions about using this project, join or start a discussion.

Support for this project / product is limited to the resources listed above.

Contributors

Thanks to everyone who has contributed!

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct

Trademark Notice

Trademarks 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. 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.

azqr's People

Contributors

cmendible avatar manuss20 avatar rag2111 avatar mloskot avatar malvaromg avatar satrox28 avatar sotrx 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.