Merge pull request #311993 from dominicbetts/aio-akri-contract

AIO: More links to connector contract

Author: prmerger-automator[bot]

articles/iot-operations/develop-edge-apps/howto-build-akri-connectors-vscode.md

@@ -85,6 +85,9 @@ Next, build the project to confirm there are no errors. Use the VS Code command
 
 In this example, you create an HTTP/REST connector using the Rust language, build a Docker image, and then run the connector application by using the VS Code extension:
 
+> [!IMPORTANT]
+> The following example code is meant for illustrative purposes only and is not intended to be used in production. In a production connector, you should implement robust error handling and retry logic, and ensure that any credentials used to connect to the asset are stored and used securely. A production quality connector must implement the contract described in the [Akri operator and connector contract](https://github.com/Azure/iot-operations-sdks/blob/main/doc/akri_connector/Akri%20operator%20and%20connector%20contract.md) document in the SDKs repository.
+
 1. Press `Ctrl+Shift+P` to open the command palette and search for the **Azure IoT Operations Akri Connectors: Create a New Akri Connector** command. Create a new folder called `my-connectors` and select it, select **Rust** as the language, and enter a name for the connector like `rest_connector`.
 
 1. The extension creates a new workspace named by using the connector name you chose in the previous step. The workspace includes the scaffolding for a connector written in the Rust language. There are `Implement` tags in the comments to help you write your own custom Akri connector. For testing purposes, you can try out the connector with just the scaffolding code. To see logs from your connector crate, replace the tag `sample_connector_scaffolding` with your connector name in the `DEFAULT_LOG_LEVEL` variable in the `main.rs` file.

articles/iot-operations/develop-edge-apps/overview-akri-connectors.md

@@ -21,6 +21,7 @@ For more information about Akri services and how they relate to Azure IoT Operat
 Understanding these core concepts is essential for developing custom Akri connectors:
 
 - **Akri connector**: A custom software component that acts as a protocol adapter, enabling Azure IoT Operations to discover, connect to, and communicate with physical devices. The connector translates between device-specific protocols and the standardized Azure IoT Operations data model.
+- **Akri operator and connector contract**: A defined interface and set of requirements that connectors must implement to ensure compatibility with Akri services and Azure IoT Operations. This contract specifies how connectors should handle configuration, device discovery, data exchange, and communication with other platform components. TO learn more, see the [Akri operator and connector contract](https://github.com/Azure/iot-operations-sdks/blob/main/doc/akri_connector/Akri%20operator%20and%20connector%20contract.md)
 - **Connector metadata**: A JSON file that describes the connector's configuration options, capabilities, and UI schemas. The metadata defines how the connector appears and behaves when you:
     - Create connector template instances in the Azure portal.
     - Configure devices and assets in the operations experience UI.
@@ -43,6 +44,7 @@ The development and deployment of Akri connectors follows a structured workflow
 - **Build the connector**: Use the Azure IoT Operations SDK, templates, or VS Code extension to develop connector logic that implements:
     - Connectivity to a physical device.
     - Authentication to a physical device.
+    - Configuration management based on the connector contract.
     - Data exchange with the physical device.
     - Optionally, device and asset discovery.
     - Delivery of the data to a destination in the cluster.
@@ -97,3 +99,4 @@ Akri connectors integrate seamlessly with the broader Azure IoT Operations envir
 - [What are Akri services?](../discover-manage-assets/overview-akri.md)
 - [Build and deploy Akri connectors](howto-develop-akri-connectors.md)
 - [Build Akri connectors with the VS Code extension](howto-build-akri-connectors-vscode.md)
+- [Akri operator and connector contract](https://github.com/Azure/iot-operations-sdks/blob/main/doc/akri_connector/Akri%20operator%20and%20connector%20contract.md)