Akri Connectors Visual Studio Code Extension

Overview

The Akri Connectors Visual Studio Code Extension supplies tools streamlining development of Akri Connectors and associated metadata. Extension code is written in TypeScript, subsequently transpiled to JavaScript and packaged into a VSIX package.

Development Lifecycle

The extension provides a two-command workflow for managing the runtime environment:

Start Development Environment

Run Akri Connectors: Start Development Environment from the Command Palette. This:

Validates the workspace and checks the Docker image exists.
Launches the runtime container.

If the runtime is already running, you are prompted to restart.

Debug (F5)

Press F5 to start a debug session. The pre-launch task:

Verifies the runtime container is already running (it does not start it).
Deploys device and asset YAMLs into the runtime.
Prepares volume mounts for the connector application.

If the runtime is not running, the task fails with a message directing you to run the Start command first.

After the debug session ends, the post-debug task cleans up connector-specific resources (debug/release containers, mounts, state) while leaving the runtime container running for the next session.

Stop Development Environment

Run Akri Connectors: Stop Development Environment to perform a full teardown:

Connector containers and mounts
Runtime container
Docker volume and network
All VS Code terminals

Commands

Command	Description
Create Akri Connector	Scaffold a new connector project (C# or Rust)
Build Akri Connector	Build the connector Docker image
Start Development Environment	Start the runtime container
Stop Development Environment	Stop and clean up all resources
Apply Device YAML on cluster	Deploy a device configuration
Apply Asset YAML on cluster	Deploy an asset configuration
Delete Device YAML from cluster	Remove a device configuration
Delete Asset YAML from cluster	Remove an asset configuration
Capture Connector State	Generate a diagnostics support bundle
Publish Akri Connector Image	Publish connector image to ACR
Publish Akri Connector Metadata	Publish connector metadata to ACR

Resources

Check https://aka.ms/aio-vsx-connectors to learn more.

Data/Telemetry

This project collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. Learn more in our FAQ.

Azure IoT Operations Akri Connectors

Microsoft