| Crate | Docs | Crates.io | Downloads | Downloads@Latest |
|---|---|---|---|---|
| azure_sdk_auth_aad |  |
 |
 |
 |
| azure_sdk_core |  |
 |
 |
 |
| azure_sdk_cosmos |  |
 |
 |
 |
| azure_sdk_service_bus |  |
 |
 |
 |
| azure_sdk_storage_account |  |
 |
 |
 |
| azure_sdk_storage_blob |  |
 |
 |
 |
| azure_sdk_storage_core |  |
 |
 |
 |
| azure_sdk_storage_table |  |
 |
 |
 |
Microsoft Azure exposes its technologies via REST API. These APIs are easily consumable from any language (good) but are weakly typed. With this library and its related crate you can exploit the power of Microsoft Azure from Rust in a idiomatic way.
This crate relies heavily on the excellent crate called Hyper. As of this library version 0.4.0 all the methods are future-aware.
From version 0.8.0 for Cosmos and 0.9.0 for Storage the repo is embracing the builder pattern. As of 0.10.0, most of storage APIs have been migrated to the builder pattern but there are methods still missing. Please chech the relevant issues to follow the update process. This is still an in-progress transition but the resulting API is much more easy to use. Also most checks have been moved to compile-time. Unfortunately the changes are not backward-compatibile. I have blogged about my appoach here: https://dev.to/mindflavor/rust-builder-pattern-with-types-3chf.
From version 0.12.0 the library switched from hyper-tls to hyper-rustls as suggested by bmc-msft in the issue #120. This should allow the library to be 100% rust.
NOTE: This repository is under heavy development and is likely to break over time. The current releases will probabily contain bugs. As usual open issues if you find any.
Starting from version 0.20.0 the monolithic crate has been split in several smaller, more manageable, crates. This means you will have to update both your Cargo.toml and your use statements to use the new version. The names should be self-explanatory; the examples have been updated to use the new crate topology. In case of doubt please do not hesitate to open an issue. As for the functionality, the release 0.20.0 is equivalent to the 0.12.0 so you can migrate to the new crate topology without embedding extra bugs (hopefully! 😉).
Since 0.20.1 each crate follows its own versioning. In other words we will increase the version number only of the modified crate (instead of all of them at once). This way you won't need to update your referenced version so often if you use more stable crates (such as storage ones) but the newest one can proceed at their own pace. Please refer to the table above for the bleeding-edge versions. This will also mean releases will detail the most important crate version only (since we cannot have releases for each crate in GitHub). That's why, for example, you could find the release crate_A_0.30.0 before release crate_B_0.27.0.
Although I am a Microsoft employee, this is not a Microsoft endorsed project. It's simply a pet project of mine: I love Rust (who doesn't? 😏) and Microsoft Azure technologies so I thought to close the gap between them. It's also a good project for learning Rust. This library relies heavily on Hyper. We use the latest Hyper code so this library is fully async with Futures and Tokio.
You can find examples in the examples folder of each sub-crate. Here is a glimpse:
#[macro_use]
extern crate serde_derive;
// Using the prelude module of the Cosmos crate makes easier to use the Rust Azure SDK for Cosmos
// DB.
use azure_sdk_cosmos::prelude::*;
use futures::future::*;
use std::error::Error;
use tokio_core::reactor::Core;
#[derive(Serialize, Deserialize, Debug)]
struct MySampleStruct<'a> {
id: &'a str,
a_string: &'a str,
a_number: u64,
a_timestamp: i64,
}
const DATABASE: &str = "azuresdktestdb";
const COLLECTION: &str = "azuresdktc";
fn main() {
code().unwrap();
}
// This code will perform these tasks:
// 1. Find an Azure Cosmos DB called *DATABASE*. If it does not exist, create it.
// 2. Find an Azure Cosmos collection called *COLLECTION* in *DATABASE*.
// If it does not exist, create it.
// 3. Store an entry in collection *COLLECTION* of database *DATABASE*.
// 4. Delete everything.
//
// We will use multiple futures for this hoping to make the code clearer.
// There is no need to proceed this way in your code.
// You can go crazy with future combinators if you want to :)
fn code() -> Result<(), Box<dyn Error>> {
// Let's get Cosmos account and master key from env variables.
// This helps automated testing.
let master_key = std::env::var("COSMOS_MASTER_KEY").expect("Set env variable COSMOS_MASTER_KEY first!");
let account = std::env::var("COSMOS_ACCOUNT").expect("Set env variable COSMOS_ACCOUNT first!");
// First, we create an authorization token. There are two types of tokens, master and resource
// constrained. Please check the Azure documentation for details. You can change tokens
// at will and it's a good practice to raise your privileges only when needed.
let authorization_token = AuthorizationToken::new(account, TokenType::Master, &master_key)?;
// We will create a tokio-core reactor which will drive our futures.
let mut core = Core::new()?;
// Next we will create a Cosmos client. You need an authorization_token but you can later
// change it if needed. Notice the client will be tied to your reactor.
// There are other ClientBuilder functions (for example to use the emulator instead of the real CosmosDB).
// Please consult the docs on how to use them.
let client = ClientBuilder::new(authorization_token)?;
// list_databases will give us the databases available in our account. If there is
// an error (for example, the given key is not valid) you will receive a
// specific AzureError. In this example we will look for a specific database
// so we chain a filter operation.
let future = client
.list_databases()
.and_then(|databases| ok(databases.into_iter().find(|db| db.id == DATABASE)));
// Now we run the future and check the answer. If the requested database
// is not found we create it.
let database = match core.run(future)? {
Some(db) => db,
None => core.run(client.create_database(DATABASE))?,
};
println!("database == {:?}", database);
// Now we look for a specific collection. If is not already present
// we will create it. The collection creation is more complex and
// has many options (such as indexing and so on).
let collection = {
let collections = core.run(client.list_collections(&database.id))?;
if let Some(collection) = collections.into_iter().find(|coll| coll.id == COLLECTION) {
collection
} else {
let indexes = IncludedPathIndex {
kind: KeyKind::Hash,
data_type: DataType::String,
precision: Some(3),
};
let ip = IncludedPath {
path: "/*".to_owned(),
indexes: vec![indexes],
};
let ip = IndexingPolicy {
automatic: true,
indexing_mode: IndexingMode::Consistent,
included_paths: vec![ip],
excluded_paths: vec![],
};
let coll = Collection::new(COLLECTION, ip);
// Notice here we specify the expected performance level.
// Performance levels have price impact. Also, higher
// performance levels force you to specify an indexing
// strategy. Consult the documentation for more details.
core.run(client.create_collection(&database.id, 400, &coll))?
}
};
println!("collection = {:?}", collection);
// Now that we have a database and a collection we can insert
// data in them. Let's create a struct. The only constraint
// is that the struct should be Serializable.
let doc = MySampleStruct {
id: "unique_id1",
a_string: "Something here",
a_number: 100,
a_timestamp: chrono::Utc::now().timestamp(),
};
// Now we store the struct in Azure Cosmos DB.
// Notice how easy it is! :)
// The method create_document will return, upon success,
// the document attributes.
let document_attributes = core.run(client.create_document(&database.id, &collection.id, &doc).execute())?;
println!("document_attributes == {:?}", document_attributes);
// We will perform some cleanup. First we delete the collection...
core.run(client.delete_collection(DATABASE, COLLECTION))?;
println!("collection deleted");
// And then we delete the database.
core.run(client.delete_database(DATABASE))?;
println!("database deleted");
Ok(())
}Right now the key framework is in place (authentication, enumerations, parsing and so on). If you want to contribute please do! Methods are added daily so please check the release page for updates on the progress. Also note that the project is in early stages so the APIs are bound to change at any moment. I will strive to keep things steady but since I'm new to Rust I'm sure I'll have to correct some serious mistake before too long 😄. I generally build for the latest nightly and leave to Travis to check the retrocompatibility.
If you want to contribute please do! No formality required! 😉. Please note that asking for a pull request you accept to yield your code as per Apache license, version 2.0.
| Method | URL | Builder pattern |
|---|---|---|
| Get account information | https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information | yes |
| Method | URL | Builder pattern |
|---|---|---|
| Create container | https://docs.microsoft.com/en-us/rest/api/storageservices/create-container | yes |
| List containers | https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2 | yes |
| Delete container | https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container | yes |
| Get ACLs | https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl | yes |
| Set ACLs | https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl | yes |
| Get properties | https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties | yes |
| Acquire lease | https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container | yes |
| Break lease | https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container | yes |
| Release lease | https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container | yes |
| Renew lease | https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container | yes |
| Method | URL |
|---|---|
| Send Event | https://msdn.microsoft.com/en-us/library/azure/dn790664.aspx |
| Method | URL |
|---|---|
| Create database | https://docs.microsoft.com/en-us/rest/api/documentdb/create-a-database |
| List database | https://docs.microsoft.com/en-us/rest/api/documentdb/list-databases |
| Get database | https://docs.microsoft.com/en-us/rest/api/documentdb/get-a-database |
| Delete database | https://docs.microsoft.com/en-us/rest/api/documentdb/delete-a-database1 |
| Method | URL |
|---|---|
| Create collection | https://docs.microsoft.com/en-us/rest/api/documentdb/create-a-collection |
| List collections | https://docs.microsoft.com/en-us/rest/api/documentdb/list-collections |
| Get collection | https://docs.microsoft.com/en-us/rest/api/documentdb/get-a-collection |
| Delete collection | https://docs.microsoft.com/en-us/rest/api/documentdb/delete-a-collection |
| Replace collection | https://docs.microsoft.com/en-us/rest/api/documentdb/replace-a-collection |
| Method | URL |
|---|---|
| Create document | https://docs.microsoft.com/en-us/rest/api/documentdb/create-a-document |
| List documents | https://docs.microsoft.com/en-us/rest/api/documentdb/list-documents |
| Get document | https://docs.microsoft.com/en-us/rest/api/documentdb/get-a-document |
| Query documents | https://docs.microsoft.com/en-us/rest/api/documentdb/query-documents |
| Replace document | https://docs.microsoft.com/en-us/rest/api/cosmos-db/replace-a-document |
| Delete document | https://docs.microsoft.com/en-us/rest/api/cosmos-db/delete-a-document |
Azure tables entities can be manipulated in batches. The entities are serialized in JSON.
export STORAGE_ACCOUNT=<account>
export STORAGE_MASTER_KEY=<key>
export AZURE_SERVICE_BUS_NAMESPACE=<azure_service_bus_namespace>
export AZURE_EVENT_HUB_NAME=<azure_event_hub_name>
export AZURE_POLICY_NAME=<azure_policy_name>
export AZURE_POLICY_KEY=<azure policy key>
cd azure_sdk_service_bus
cargo test --features=test_e2e
cd ../azure_sdk_storage_blob
cargo test --features=test_e2e
cd ../azure_sdk_storage_account
cargo test --features=test_e2eset STORAGE_ACCOUNT=<account>
set STORAGE_MASTER_KEY=<key>
set AZURE_SERVICE_BUS_NAMESPACE=<azure_service_bus_namespace>
set AZURE_EVENT_HUB_NAME=<azure_event_hub_name>
set AZURE_POLICY_NAME=<azure_policy_name>
set AZURE_POLICY_KEY=<azure policy key>
cd azure_sdk_service_bus
cargo test --features=test_e2e
cd ../azure_sdk_storage_blob
cargo test --features=test_e2e
cd ../azure_sdk_storage_account
cargo test --features=test_e2eThis project is published under Apache license, version 2.0.