Merge branch 'main' into copilot/fix-2829 - resolve conflicts

Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>

Author: Copilot

.github/CODEOWNERS

@@ -55,7 +55,7 @@
 ####################
 
 # PRLabel: %Cosmos
-/sdk/cosmos/             @analogrelay @Pilchie @kirankumarkolli @tvaron3 @FabianMeiswinkel @kundadebdatta @nehrao1 @kushagraThapar
+/sdk/cosmos/             @Azure/azure-cosmos-rust-sdk
 
 # ServiceLabel: %Cosmos
 # AzureSDKOwners: @heaths
@@ -73,6 +73,12 @@
 # ServiceLabel: %Storage
 # AzureSDKOwners: @vincenttran-msft @jalauzon-msft
 
+# PRLabel: %Event Hubs
+/sdk/eventhubs/          @j7nw4r
+
+# ServiceLabel: %Event Hubs
+# AzureSDKOwners: @j7nw4r
+
 ####################
 # Management Libraries
 ####################
@@ -85,7 +91,7 @@
 /.github/workflows/      @Azure/azure-sdk-eng
 /.github/CODEOWNERS      @RickWinter @ronniegeraghty @Azure/azure-sdk-eng
 /.config/1espt/          @benbp @weshaggard
-/sdk/template/			 @hallipr
+/sdk/canary/             @hallipr
 
 # Add owners for notifications for specific pipelines
 /eng/common/pipelines/codeowners-linter.yml       @rickwinter

.github/copilot-instructions.md

@@ -6,6 +6,8 @@ You are an expert Rust programmer. You write safe, efficient, maintainable, and
 -   Do not be overly apologetic and focus on clear guidance.
 -   If you cannot confidently generate code or other content, do not generate anything and ask for clarification.
 
+> **Note**: For comprehensive guidance on how AI agents should interact with this repository, including workflows, automation boundaries, and repository structure, see [AGENTS.md](https://github.com/Azure/azure-sdk-for-rust/blob/main/AGENTS.md).
+
 ## Prerequisites
 
 - To use Azure SDK MCP tool calls, the user must have PowerShell installed. Provide [PowerShell installation instructions](https://learn.microsoft.com/powershell/scripting/install/installing-powershell) if not installed, and recommend restarting the IDE to start the MCP server.
@@ -37,6 +39,7 @@ Use these instructions for test generation as well.
 -   If you have trouble generating safe, efficient, maintainable, and lint-free code, insert a `TODO` comment describing what should happen.
 -   All imported types, constants, functions, modules, and macros should be imported explicitly. Never import `*`.
 -   Do not modify generated code, found in `generated` subdirectories. These files are generated by external tools and should not be edited manually.
+-   When searching for function call chains in Rust code, be aware that rustfmt often formats method chains across multiple lines like `obj\n    .foo()\n    .bar()`. Use multi-line search patterns (e.g., `rg` with `-U` flag) or search for individual method names rather than complete call chains.
 
 ## Test Generation
 

.gitignore

@@ -13,6 +13,7 @@ Cargo.lock
 .proxy/
 tests/data/
 review/
+results.json
 
 # Dependencies.
 vcpkg_installed/

.vscode/cspell.json

@@ -7,6 +7,7 @@
     "**/test-resources.json",
     "**/test-resources-post.ps1",
     "**/assets.json",
+    "**/*.pfx",
     ".config",
     ".devcontainer/devcontainer.json",
     ".devcontainer/Dockerfile",
@@ -35,12 +36,14 @@
     "bugbug",
     "checkpointstore",
     "clippy",
+    "codeowners",
     "contoso",
     "cplusplus",
     "cpptools",
     "cppvsdbg",
     "datalake",
     "datetime",
+    "deserializers",
     "devcontainers",
     "devicecode",
     "docsrs",
@@ -52,6 +55,7 @@
     "etag",
     "eventhub",
     "eventhubs",
+    "headerless",
     "hmac",
     "iothub",
     "keyvault",
@@ -72,7 +76,10 @@
     "posix",
     "pwsh",
     "reqwest",
+    "rsplit",
+    "rustfmt",
     "runtimes",
+    "rustfmt",
     "rustup",
     "schannel",
     "seekable",
@@ -199,7 +206,7 @@
       ]
     },
     {
-      "filename": "sdk/typespec/**",
+      "filename": "sdk/core/typespec*/**",
       "flagWords": [
         "azure",
         "azurite"

AGENTS.md

@@ -0,0 +1,255 @@
+# AGENTS.md
+
+This document provides guidance for AI agents (e.g., GitHub Copilot, MCP servers, or LLM-based assistants) interacting with the Azure SDK for Rust repository.
+
+## Repository Overview
+
+### Purpose
+
+The Azure SDK for Rust provides Rust language bindings and client libraries for Azure services, following the [Azure SDK Design Guidelines for Rust](https://azure.github.io/azure-sdk/rust_introduction.html).
+
+### Status
+
+⚠️ Under active development. Large breaking changes may occur before 1.0 release.
+
+### Primary Language
+
+Rust (MSRV: 1.85)
+
+### Key Technologies
+
+- Rust toolchain with Cargo
+- TypeSpec for API specification and code generation
+- OpenTelemetry for distributed tracing
+- Test Proxy for recorded integration tests
+
+## Repository Structure
+
+```
+.
+├── sdk/                       # Service-specific crates organized by service
+│   └── <service>/            # Service directory (e.g., "keyvault", "storage")
+│       ├── <crate>/          # Service crate (e.g., "azure_security_keyvault_secrets")
+│       ├── assets.json       # Pointer to test recordings (may be under <crate>/)
+│       ├── test-resources.bicep # Test resource definitions (may be under <crate>/)
+│       └── tsp-location.yaml # Pointer to TypeSpec in azure-rest-api-specs (may be under <crate>/)
+├── eng/                      # Engineering system scripts and common tooling
+├── doc/                      # Additional documentation
+├── .github/              
+│   ├── copilot-instructions.md # Copilot-specific Rust coding guidelines
+│   ├── instructions/         # Agent instruction files for specific tasks
+│   └── prompts/              # Reusable Copilot prompts
+├── CONTRIBUTING.md           # Contribution guidelines (see for detailed workflows)
+└── README.md                 # Repository overview
+```
+
+## Agent Capabilities
+
+### Recommended Actions
+
+AI agents can assist with:
+
+1. **Code Generation**
+   - Writing new Rust code following repository conventions (see `.github/copilot-instructions.md`)
+   - Generating unit tests using `#[cfg(test)]` modules
+   - Creating integration tests with `#[recorded::test]` attributes (see `CONTRIBUTING.md` for details)
+   - Generating documentation tests in `.rs` files (avoid `no_run` when tests can be run)
+   - In README markdown files, use ` ```rust no_run` for examples with placeholders
+   - Running `rustfmt` on all generated code to ensure proper formatting
+
+2. **Code Review Support**
+   - Identifying potential bugs or safety issues
+   - Suggesting improvements for idiomatic Rust patterns
+   - Checking adherence to Azure SDK design guidelines
+   - Reviewing error handling using `azure_core::Result<T>`
+
+3. **Documentation**
+   - Improving inline documentation (using `///` doc comments)
+   - Updating README files
+   - Creating or updating CHANGELOG entries (see `.github/instructions/changelog.instructions.md`)
+   - Writing hero scenario examples in doc comments (avoid examples in `examples/` directories unless demonstrating primary use cases)
+
+4. **Issue Triage**
+   - Labeling issues with appropriate tags
+   - Identifying duplicate issues
+   - Suggesting relevant code owners based on `CODEOWNERS`
+   - Summarizing issue discussions
+
+5. **Refactoring**
+   - Applying clippy suggestions
+   - Improving code organization and modularity
+   - Updating dependencies in `Cargo.toml`
+   - Consolidating imports (e.g., `use std::{borrow::Cow, marker::PhantomData};` instead of separate lines)
+
+### Restricted Actions
+
+AI agents **should not**:
+
+1. **Modify Generated Code**
+   - Never edit files in `generated/` subdirectories
+   - These are produced by TypeSpec code generators and will be overwritten
+   - Instead, propose changes to TypeSpec specifications in [Azure/azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs)
+
+2. **Break API Compatibility**
+   - Avoid introducing breaking changes without explicit approval
+   - Check if changes affect public APIs before proceeding
+   - Consider deprecation process (see `doc/deprecation-process.md`)
+
+3. **Bypass CI/CD Checks**
+   - Do not suggest skipping or disabling CI checks
+   - All code must pass `cargo build`, `cargo test`, and `cargo clippy`
+
+4. **Commit Secrets**
+   - Never include credentials, keys, or tokens in code
+   - Use environment variables for sensitive data
+   - Sanitize test recordings to remove secrets
+
+5. **Modify Security or License Files**
+   - Do not alter `SECURITY.md`, `LICENSE.txt`, or `CODE_OF_CONDUCT.md` without maintainer approval
+
+## Key Workflows
+
+### Building
+
+```bash
+# Build a specific crate
+cargo build -p <crate-name>
+
+# Build entire workspace (not recommended unless necessary)
+cargo build --workspace
+```
+
+### Testing
+
+```bash
+# Run tests for a specific crate
+cargo test -p <crate-name>
+
+# Run integration tests with recordings
+cargo test -p <crate-name> --test <test-name>
+
+# Provision test resources (see CONTRIBUTING.md for details)
+eng/common/TestResources/New-TestResources.ps1 -ServiceDirectory <service>
+
+# Record new test sessions (requires provisioned resources)
+AZURE_TEST_MODE=record cargo test -p <crate-name> --test <test-name>
+```
+
+See `CONTRIBUTING.md` for comprehensive testing guidance including debugging, Test Proxy usage, and trace logging.
+
+### Linting and Formatting
+
+```bash
+# Check for common issues
+cargo clippy -p <crate-name>
+
+# Auto-fix some issues
+cargo clippy --fix -p <crate-name>
+
+# Format code
+cargo fmt -p <crate-name>
+```
+
+### Code Generation
+
+For crates with TypeSpec specifications:
+
+```bash
+cd sdk/<service>/<crate-name>
+tsp-client update
+```
+
+### Running Examples
+
+```bash
+cargo run --package <crate-name> --example <example-name>
+```
+
+## Coding Standards
+
+Agents should follow guidelines in `.github/copilot-instructions.md` and `CONTRIBUTING.md`, including:
+
+- **Naming Conventions**: 
+  - Types/variants: `PascalCase`
+  - Functions/fields/parameters: `snake_case`
+  - Constants: `UPPER_SNAKE_CASE`
+  - Crates/modules: `snake_case`
+
+- **Import Style**:
+  - Explicit imports (no `use foo::*`)
+  - Consolidate related imports (e.g., `use std::{borrow::Cow, marker::PhantomData};`)
+  - Prefer `crate::` for internal references
+
+- **Error Handling**:
+  - Service crate code should return `azure_core::Result<T>` (where `E` defaults to `azure_core::Error`)
+  - Use the `?` operator for error propagation
+  - Examples should use `Result<(), Box<dyn std::error::Error>>`
+
+- **Documentation**:
+  - All public APIs need `///` doc comments
+  - Include runnable doc test examples where appropriate
+  - Hero scenario examples under the `examples/` directory should have `#[tokio::main]` async main functions
+  - Use absolute links in markdown files (e.g., `https://github.com/Azure/azure-sdk-for-rust/blob/main/AGENTS.md`) instead of relative links (e.g., `../AGENTS.md`)
+  - Links must work both online (from github.com) and offline (when viewed in an IDE)
+
+- **Testing**:
+  - Place unit tests in `#[cfg(test)] mod tests`
+  - Use `#[recorded::test]` for integration tests (see `CONTRIBUTING.md`)
+  - Test names should be descriptive, not prefixed with "test"
+
+## CI/CD Integration
+
+All pull requests trigger:
+- `cargo build` - Compilation check
+- `cargo test` - Unit and integration tests
+- `cargo clippy` - Lint checks
+- `cargo fmt --check` - Format validation
+- License/CLA verification
+- Code coverage analysis
+
+Integration tests use the Azure SDK Test Proxy for recording/playback. See `CONTRIBUTING.md` for Test Proxy setup and usage.
+
+## Safety and Security
+
+1. **Code Review**: All changes require review and approval from code owners
+2. **Static Analysis**: Must pass `cargo clippy` without warnings
+3. **Secret Scanning**: Automated checks prevent committing credentials
+4. **Dependencies**: Managed through workspace `Cargo.toml`, vetted for security
+5. **Vulnerability Reporting**: Via MSRC at <secure@microsoft.com>
+
+## Cross-References
+
+For detailed guidance, see:
+
+- **Rust Coding Guidelines**: `.github/copilot-instructions.md`
+- **Contribution Workflows**: `CONTRIBUTING.md`
+- **Changelog Guidelines**: `.github/instructions/changelog.instructions.md`
+- **Git Commit Standards**: `doc/git-commit-instructions.md`
+- **Deprecation Process**: `doc/deprecation-process.md`
+- **Azure SDK Design Guidelines**: https://azure.github.io/azure-sdk/rust_introduction.html
+
+## Agent-Specific Instructions
+
+Additional specialized instructions for specific workflows can be found in:
+- `.github/instructions/` - Task-specific agent instructions
+- `.github/prompts/` - Reusable Copilot prompts (use `#prompt` in Copilot)
+
+## Getting Help
+
+- **Issues**: https://github.com/Azure/azure-sdk-for-rust/issues
+- **Discussions**: Use issue comments or StackOverflow with `azure` + `rust` tags
+- **Code Owners**: See `.github/CODEOWNERS` for service-specific contacts
+
+## Telemetry and Privacy
+
+The SDK includes telemetry via `User-Agent` headers. Follow Microsoft Privacy Statement: https://go.microsoft.com/fwlink/?LinkID=824704
+
+## License
+
+All contributions are licensed under the MIT License. See `LICENSE.txt`.
+
+---
+
+**Last Updated**: 2025-01-20  
+**Version**: 1.0  
+**Canonical Spec**: https://agents.md

CONTRIBUTING.md

@@ -29,6 +29,8 @@ To generate a new performance test, for example, you might prompt with:
 Using #perf-test.prompt.md generate a perf test for SecretClient::get_secret.
 ```
 
+For comprehensive guidance on how AI agents should interact with this repository, including workflows, automation boundaries, and safety guidelines, see [AGENTS.md](https://github.com/Azure/azure-sdk-for-rust/blob/main/AGENTS.md).
+
 ## Generated code
 
 If you want to contribute to a file that is generated (the file is located in a `generated` subdirectory), the best approach is to open a PR on the TypeSpec specification since we cannot replace generated code that will be replaced when regenerated.