Skip to main content

az-scout plugin for On-Demand Capacity Reservation (ODCR) coverage analysis

Project description

az-scout-plugin-odcr-coverage

An az-scout plugin that analyses On-Demand Capacity Reservation (ODCR) coverage for Azure VMs.

Identifies VMs at risk of allocation failure by combining VM inventory, Activity Log allocation events, and existing ODCR utilization — then classifies each VM by risk level.

Features

  • Risk classification — critical (past allocation failures), high (always-on without ODCR), medium, low, covered
  • Allocation event timeline — start/deallocate/failed events from Activity Log with configurable lookback (3–30 days)
  • ODCR utilization — reserved capacity, used/unused counts per reservation group
  • Multi-subscription — analyse across multiple subscriptions with incremental rendering and progress bar
  • VM detail modal — click any VM row to see risk profile, allocation summary, and event timeline
  • Cross-highlighting — hover an ODCR card to highlight associated VMs, and vice versa
  • Azure Portal links — direct links to each VM in the Azure Portal
  • MCP toolget_odcr_coverage available to AI agents (Claude, VS Code Copilot)
  • Chat mode — "ODCR Advisor" for guided capacity reservation analysis
  • Caching — VM list (5 min), capacity reservations (5 min), activity log (10 min)

Installation

pip install az-scout-plugin-odcr-coverage
# or
uv pip install az-scout-plugin-odcr-coverage

Restart az-scout — the plugin is discovered automatically.

MCP Tool

Tool Parameters Description
get_odcr_coverage region, subscription_id, lookback_days? (default: 7), uptime_threshold? (default: 90), tenant_id? Analyse ODCR coverage with per-VM risk classification and allocation history

RBAC Requirements

Role Why
Reader List VMs (via ARG), Capacity Reservation Groups
Reader or Monitoring Reader Activity Log queries

Setup

uv pip install az-scout-plugin-odcr-coverage
az-scout  # plugin is auto-discovered

For development:

git clone https://github.com/az-scout/az-scout-plugin-odcr-coverage
cd az-scout-plugin-odcr-coverage
uv sync --group dev
uv pip install -e .
az-scout  # plugin is auto-discovered

Structure

az-scout-plugin-odcr-coverage/
├── .github/
│   ├── copilot-instructions.md  # Copilot context for this plugin
│   └── workflows/
│       └── ci.yml               # CI pipeline (lint + test, Python 3.11–3.13)
├── pyproject.toml
├── README.md
└── src/
    └── az_scout_odcr_coverage/
        ├── __init__.py          # Plugin class + module-level `plugin` instance
        ├── routes.py            # FastAPI APIRouter (optional)
        ├── tools.py             # MCP tool functions (optional)
        └── static/
            ├── css/
            │   └── odcr-coverage.css      # Plugin styles (auto-loaded via css_entry)
            ├── html/
            │   └── odcr-coverage-tab.html # HTML fragment (fetched by JS at runtime)
            └── js/
                └── odcr-coverage-tab.js   # Tab UI logic (auto-loaded via js_entry)

How it works

  1. The plugin JS loads the HTML fragment into #plugin-tab-odcr-coverage.
  2. It listens to azscout:* context events from the core app.
  3. When tenant and region are set, it fetches subscriptions from /api/subscriptions.
  4. The user picks subscriptions and clicks Analyse.
  5. The plugin calls GET /plugins/odcr-coverage/coverage?region=…&subscription_id=….
  6. VM list and power state are fetched via Azure Resource Graph (single query); capacity reservations and activity log are fetched in parallel.

Quality checks

uv run ruff check src/ tests/
uv run ruff format --check src/ tests/
uv run mypy src/
uv run pytest

Copilot support

The .github/copilot-instructions.md file provides context to GitHub Copilot about the plugin structure, conventions, and az-scout plugin API.

License

MIT

Disclaimer

This tool is not affiliated with Microsoft. All capacity, pricing, and availability information is indicative and not a guarantee of deployment success. Values are dynamic and may change between planning and actual deployment. Always validate in official Microsoft sources and in your target tenant/subscription.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

az_scout_plugin_odcr_coverage-2026.3.2.tar.gz (131.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file az_scout_plugin_odcr_coverage-2026.3.2.tar.gz.

File metadata

File hashes

Hashes for az_scout_plugin_odcr_coverage-2026.3.2.tar.gz
Algorithm Hash digest
SHA256 5f955822399bce94a8731c26d5ccc5930be6bd6dfc5a77451e3123b32375ba6a
MD5 90960166d1853be4a99ce155ad13fe83
BLAKE2b-256 71cd3157d76eab94df3fd691aabfd9e3799edb507222e9894ddcebaf58ea578e

See more details on using hashes here.

Provenance

The following attestation bundles were made for az_scout_plugin_odcr_coverage-2026.3.2.tar.gz:

Publisher: publish.yml on az-scout/az-scout-plugin-odcr-coverage

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file az_scout_plugin_odcr_coverage-2026.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for az_scout_plugin_odcr_coverage-2026.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9ea6b946fe352ddd73959e87cc25be6b60770a04cd1a322fba344a5d8e0329b6
MD5 0e72780b5d23d64857aa84c0c637891f
BLAKE2b-256 3ea16990c5d9f3c663bac1d2e07db5613cbe16e441cfd16845d2c3c89f1ee0f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for az_scout_plugin_odcr_coverage-2026.3.2-py3-none-any.whl:

Publisher: publish.yml on az-scout/az-scout-plugin-odcr-coverage

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page