Azure SDK for Rust

This repository is for the active development of the Azure SDK for Rust.

Crates 📦

All Azure SDK for Rust crates are published on crates.io.

Getting started

To get started with a library, see the README.md file located in the library's project folder. You can find these library project folders grouped by service in the /sdk directory.

For full file code examples, check out the /examples directory in any library project folder.

Installing crates

Use cargo to install crates from the Azure SDK for Rust.

cargo add azure_identity azure_security_keyvault_secrets tokio

Status

This project is the successor to the azure_sdk* crates from MindFlavor/AzureSDKForRust. The crates have been renamed, so those older crates should be considered fully deprecated.

Project Structure

Each supported Azure service is its own separate crate.

Building each crate should be as straight forward as cargo build, but check each crate's README for more specific information.

Need help?

• For examples, go to the examples subdirectory in any library's project folder e.g., /sdk/identity/azure_identity/examples
• Have a question, or find a bug? File an issue via GitHub Issues.
• Check previous questions or ask new ones on StackOverflow using the azure and rust tags.

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described below. You can learn more about data collection and use in the help documentation and Microsoft’s privacy statement. For more information on the data collected by the Azure SDK, please visit the Telemetry Guidelines page.

Telemetry Configuration

A User-Agent header is sent in requests by default with a value similar to:

azsdk-rust-security_keyvault_secrets/0.4.0 (1.86.0; linux; aarch64)

You can assign an optional application ID for your own telemetry by setting UserAgentOptions::application_id. This will appear at the beginning of the User-Agent header.

To disable sending the User-Agent header entirely, you can write a Policy that will remove it:

use async_trait::async_trait;
use azure_core::http::{
    policies::{Policy, PolicyResult},
    Context, Request,
};
use std::sync::Arc;

// Define a policy that will remove the User-Agent header.
#[derive(Debug)]
struct RemoveUserAgent;

#[async_trait]
impl Policy for RemoveUserAgent {
    async fn send(
        &self,
        ctx: &Context,
        request: &mut Request,
        next: &[Arc<dyn Policy>],
    ) -> PolicyResult {
        let headers = request.headers_mut();

        // Note: HTTP headers are case-insensitive but client-added headers are normalized to lowercase.
        headers.remove("user-agent");

        next[0].send(ctx, request, &next[1..]).await
    }
}

For a complete example, see our azure_core example.

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

We want your thoughts

Feature Requests

What features are important to you? You can let us know by looking at our open feature requests and sharing your thoughts by giving the issue a thumbs up or thumbs down. (Note the list is sorted by the number of thumbs up in descending order.)

Design Discussions

We would love to incorporate the community's input into our library design process. Here's a list of design discussions that we're currently having. Participate in the discussions by leaving your comments in the issue!

Contributing

For details on contributing to this repository, see the contributing guide.

For guidance on how AI agents should interact with this repository, see AGENTS.md.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.