Repository files navigation

This repository is for the active development of the Azure SDK for Rust. For consumers of the SDK, we recommend visitingDocs.rs and looking up the docs for any of libraries in the SDK.

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

To get started with a library, see theREADME.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.

Usecargo to install crates from the Azure SDK for Rust.

cargo add azure_identity azure_security_keyvault_secrets tokio

🚨 WARNING 🚨: This project is under active development. Be aware that large breaking changes may happen before 1.0 is reached.

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

Each supported Azure service is its own separate crate.

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

• For reference documentation visitdocs.rs.
• For examples, go to theexamples subdirectory in any library's project folder e.g.,/sdk/identity/azure_identity/examples
• Have a question, or find a bug? File an issue viaGitHub Issues.
• Checkprevious questions or ask new ones on StackOverflow using theazure andrust tags.

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’sprivacy statement. For more information on the data collected by the Azure SDK, please visit theTelemetry Guidelines page.

AUser-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 settingUserPolicyOptions::application_id. This will appear at the beginning of theUser-Agent header.

To disable sending theUser-Agent header entirely, you can write aPolicy 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)]structRemoveUserAgent;#[async_trait]implPolicyforRemoveUserAgent{asyncfnsend(&self,ctx:&Context,request:&mutRequest,next:&[Arc<dynPolicy>],) ->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 ourazure_core example.

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 theSecurity TechCenter.

What features are important to you? You can let us know by looking at our openfeature 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.)

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

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

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

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

This project has adopted theMicrosoft Open Source Code of Conduct.For more information see theCode of Conduct FAQ orcontactopencode@microsoft.com with any additional questions or comments.