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 tool —
get_odcr_coverageavailable 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, Capacity Reservation Groups |
| Reader or Monitoring Reader | Activity Log queries |
| cp -r /tmp/az-scout/docs/plugin-scaffold ./az-scout-myplugin | |
| cd ./az-scout-myplugin |
Update pyproject.toml: name, entry point, package name
Rename src/az_scout_odcr_coverage/ to match your package
uv pip install -e . az-scout # plugin is auto-discovered
## Structure
```text
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
- The plugin JS loads the HTML fragment into
#plugin-tab-odcr-coverage. - It listens to
azscout:*context events from the core app. - When both are set, it fetches subscriptions from
/api/subscriptions. - The user picks a subscription and clicks the button.
- The plugin calls
GET /plugins/odcr-coverage/hello?subscription_name=…&tenant=…®ion=….
Quality checks
The scaffold includes GitHub Actions workflows in .github/workflows/:
ci.yml— Runs lint (ruff + mypy) and tests (pytest) on Python 3.11–3.13, triggered on push/PR tomain.publish.yml— Builds, creates a GitHub Release, and publishes to PyPI via trusted publishing (OIDC). Triggered on version tags (v*). Requires apypienvironment configured in your repo settings with OIDC trusted publishing.
Run the same checks locally:
uv run ruff check src/ tests/
uv run ruff format --check src/ tests/
uv run mypy src/
uv run pytest
To publish a release:
git tag v2026.2.0
git push origin v2026.2.0
Copilot support
The .github/copilot-instructions.md file provides context to GitHub Copilot about
the plugin structure, conventions, and az-scout plugin API. It helps Copilot generate
code that follows the project patterns.
License
Disclaimer
This tool is not affiliated with Microsoft. All capacity, pricing, and latency information are indicative and not a guarantee of deployment success. Spot placement scores are probabilistic. Quota values and pricing are dynamic and may change between planning and actual deployment. Latency values are based on Microsoft published statistics and must be validated with in-tenant measurements.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file az_scout_plugin_odcr_coverage-2026.3.0.tar.gz.
File metadata
- Download URL: az_scout_plugin_odcr_coverage-2026.3.0.tar.gz
- Upload date:
- Size: 130.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
22686c3522a9be27619465afb93bfe51fb06fb7fcc43910d2a0743b484448c9b
|
|
| MD5 |
688facba2826758b894e11b21a46a841
|
|
| BLAKE2b-256 |
e37094a81c87742a742cabe101b662c6fb0b2fed46b0f3943560ac43d93f2069
|
Provenance
The following attestation bundles were made for az_scout_plugin_odcr_coverage-2026.3.0.tar.gz:
Publisher:
publish.yml on az-scout/az-scout-plugin-odcr-coverage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
az_scout_plugin_odcr_coverage-2026.3.0.tar.gz -
Subject digest:
22686c3522a9be27619465afb93bfe51fb06fb7fcc43910d2a0743b484448c9b - Sigstore transparency entry: 1084139820
- Sigstore integration time:
-
Permalink:
az-scout/az-scout-plugin-odcr-coverage@221bb785a032bd43c0f56822fef63ba3966e47e0 -
Branch / Tag:
refs/tags/v2026.3.0 - Owner: https://github.com/az-scout
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@221bb785a032bd43c0f56822fef63ba3966e47e0 -
Trigger Event:
push
-
Statement type:
File details
Details for the file az_scout_plugin_odcr_coverage-2026.3.0-py3-none-any.whl.
File metadata
- Download URL: az_scout_plugin_odcr_coverage-2026.3.0-py3-none-any.whl
- Upload date:
- Size: 24.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
43f6b8c5b80c5c3c91f2eded22518fe0ba54f168f9e93d4638560b38c41c6c0a
|
|
| MD5 |
aef530b285e489e21dd7b24b73c22592
|
|
| BLAKE2b-256 |
294885b4c0f7b7ddceab1febe6da5236289a73c08c032619c8485fac911ffbc9
|
Provenance
The following attestation bundles were made for az_scout_plugin_odcr_coverage-2026.3.0-py3-none-any.whl:
Publisher:
publish.yml on az-scout/az-scout-plugin-odcr-coverage
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
az_scout_plugin_odcr_coverage-2026.3.0-py3-none-any.whl -
Subject digest:
43f6b8c5b80c5c3c91f2eded22518fe0ba54f168f9e93d4638560b38c41c6c0a - Sigstore transparency entry: 1084139888
- Sigstore integration time:
-
Permalink:
az-scout/az-scout-plugin-odcr-coverage@221bb785a032bd43c0f56822fef63ba3966e47e0 -
Branch / Tag:
refs/tags/v2026.3.0 - Owner: https://github.com/az-scout
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@221bb785a032bd43c0f56822fef63ba3966e47e0 -
Trigger Event:
push
-
Statement type: