Skip to main content
affpapa.org
RU EN
rule official · GitHub

azure-iot-edge-architecture — GitHub Copilot rule: how to install

Requires reviewing Azure IoT Edge documentation before proposing architectures. It targets Bicep, Terraform, and edge-related markdown files.

Install into GitHub Copilot · Manually: put the files in place All methods and platforms ↓ 
.github/instructions/azure-iot-edge-architecture.instructions.md
Open on GitHub

What azure-iot-edge-architecture does

This rule blocks the assistant from jumping straight to a list of Azure services. Copilot must check the documentation at https://learn.microsoft.com/azure/iot-edge/ or https://learn.microsoft.com/es-es/azure/iot-edge/ first. It has to verify the runtime architecture, supported systems, and release status. Without this step, architectural output is invalid. When the documentation is unreachable, the assistant must explicitly declare its assumptions.

The instruction triggers on **/*.bicep, **/*.tf, **/*iot*.md, **/*smart-city*.md, and **/*edge*.md. It covers edge gateways, disconnected setups, and edge processing. Copilot must always justify why Azure IoT Edge is needed for the scenario. It also forces operational planning into the response: update strategies, observability, and support models alongside managed identity and network isolation.

What it helps with

  • validate edge applicability before selecting cloud services
  • confirm runtime architecture and supported operating systems
  • define update strategies and support models for edge gateways
  • enforce network isolation and managed identities in IoT designs

Example prompts for the agent

  • Design an offline edge gateway architecture for smart-city-edge.md
  • Configure the edge infrastructure in main.bicep with network isolation
  • Review edge.tf and explain why Azure IoT Edge is needed here

How to install azure-iot-edge-architecture

Manually: put the files in place

.github/instructions/azure-iot-edge-architecture.instructions.md

The applyTo field sets which files it applies to

Step by step, with commands for each platform: AGENTS.md vs CLAUDE.md: what they are and which one to use

Questions about azure-iot-edge-architecture

How to install azure-iot-edge-architecture in GitHub Copilot?

Save the rule file to .github/instructions/azure-iot-edge-architecture.instructions.md. GitHub Copilot will automatically apply the instructions to matching files.

Which files does azure-iot-edge-architecture apply to?

The rule matches **/*.bicep, **/*.tf, **/*iot*.md, **/*smart-city*.md, and **/*edge*.md.

What happens if Copilot cannot access the Azure IoT Edge documentation?

The assistant must explicitly state that the documentation could not be consulted. It then proceeds with clearly labeled assumptions.

Source text

azure-iot-edge-architecture.instructions.md · MIT 
---
description: 'Require Azure IoT Edge documentation review before proposing edge IoT architectures or Azure implementation guidance.'
applyTo: '**/*.bicep,**/*.tf,**/*iot*.md,**/*smart-city*.md,**/*edge*.md'
---

## Azure IoT Edge Architecture Instruction

When the task includes Azure IoT, Smart City, edge processing, gateway design, or disconnected edge scenarios, do this before providing architecture recommendations:

1. Review Azure IoT Edge documentation first:
   - https://learn.microsoft.com/azure/iot-edge/
   - https://learn.microsoft.com/es-es/azure/iot-edge/
2. Confirm key constraints from the documentation:
   - Runtime architecture
   - Supported systems
   - Version/release status
   - Relevant Linux/Windows quickstart path
3. Explicitly state that you reviewed the documentation, or state that it could not be consulted.
4. If the documentation was not accessible, continue with clearly labeled assumptions.

### Response Rules

- Never jump directly to a list of services without validating edge applicability first.
- Always explain why IoT Edge is or is not required.
- Include operational implications: update strategy, observability, and support model.
- Prioritize secure defaults: managed identity, least privilege, secret management, and network isolation.

© github · MIT · github/awesome-copilot

Topics and platforms

All IDE rules for Cloud: AWS, Azure, GCP →

From the same set732

The whole set →
bicep-code-best-practices This rule guides GitHub Copilot when editing Bicep files, covering naming, parameters, resource references, and outputs. Use it to keep infrastructure code consistent with the stated conventions. ★ 40,418repo stars azure-verified-modules-bicep Instructs GitHub Copilot to use Azure Verified Modules when writing Bicep templates. It enforces AVM registry modules over raw Azure resource declarations. ★ 40,418repo stars azure-naming The rule makes GitHub Copilot name Azure resources following Microsoft CAF: type prefix, workload, environment, region, instance number. ★ 40,418repo stars azure-logic-apps-power-automate A GitHub Copilot rule that guides JSON workflow definitions for Azure Logic Apps and Power Automate: triggers, actions, error handling. ★ 40,418repo stars azure-functions-typescript This rule guides Copilot when generating TypeScript APIs for Azure Functions, including async code and endpoint file layout. It also calls for updating the OpenAPI schema and README.md when the API changes. ★ 40,418repo stars azure-functions-csharp A GitHub Copilot rule that sets conventions for building Azure Functions in C# with the isolated worker model. Useful when you want consistent style across a functions project. ★ 40,418repo stars azure-durable-functions-csharp Sets guidelines for building C# Azure Durable Functions in the isolated worker model. Enforces replay safety, correct logging, and task hub configuration. ★ 40,418repo stars azure-devops-pipelines This rule guides Azure DevOps Pipeline YAML structure, testing, security, and deployment. Use it when reviewing or maintaining pipeline files. ★ 40,418repo stars

Project sponsors

Companies that keep this analytics open
Gold sponsor
Nutra.Club

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor