add blob expiry support (#913)

Author: bmc-msft

sdk/storage_blobs/examples/set_blob_expiry.rs

@@ -0,0 +1,33 @@
+use azure_storage::core::prelude::*;
+use azure_storage_blobs::prelude::*;
+
+#[tokio::main]
+async fn main() -> azure_core::Result<()> {
+    // First we retrieve the account name and access key from environment variables.
+    let account =
+        std::env::var("STORAGE_ACCOUNT").expect("Set env variable STORAGE_ACCOUNT first!");
+    let master_key =
+        std::env::var("STORAGE_ACCESS_KEY").expect("Set env variable STORAGE_ACCESS_KEY first!");
+
+    let container = std::env::args()
+        .nth(1)
+        .expect("please specify container name as command line parameter");
+    let blob = std::env::args()
+        .nth(2)
+        .expect("please specify blob name as command line parameter");
+
+    let storage_client = StorageClient::new_access_key(&account, &master_key);
+
+    let blob_client = storage_client
+        .container_client(&container)
+        .blob_client(&blob);
+
+    let response = blob_client
+        .set_blob_expiry(BlobExpiry::RelativeToNow(1000 * 60 * 60 * 24 * 100))
+        .into_future()
+        .await?;
+
+    println!("response: {:?}", response);
+
+    Ok(())
+}

sdk/storage_blobs/examples/set_blob_properties_00.rs

@@ -5,11 +5,11 @@ use azure_storage_blobs::prelude::*;
 
 #[tokio::main]
 async fn main() -> azure_core::Result<()> {
-    // First we retrieve the account name and master key from environment variables.
+    // First we retrieve the account name and access key from environment variables.
     let account =
         std::env::var("STORAGE_ACCOUNT").expect("Set env variable STORAGE_ACCOUNT first!");
     let master_key =
-        std::env::var("STORAGE_MASTER_KEY").expect("Set env variable STORAGE_MASTER_KEY first!");
+        std::env::var("STORAGE_ACCESS_KEY").expect("Set env variable STORAGE_ACCESS_KEY first!");
 
     let container = std::env::args()
         .nth(1)

sdk/storage_blobs/src/blob/mod.rs

@@ -186,6 +186,10 @@ pub struct BlobProperties {
     pub remaining_retention_days: Option<u32>,
     pub tag_count: Option<u32>,
     pub rehydrate_priority: Option<RehydratePriority>,
+    #[serde(default)]
+    #[serde(rename = "Expiry-Time")]
+    #[serde(with = "azure_core::parsing::rfc2822_time_format_optional")]
+    pub expiry_time: Option<DateTime<Utc>>,
     #[serde(flatten)]
     extra: HashMap<String, String>, // For debug purposes, should be compiled out in the future
 }
@@ -298,6 +302,7 @@ impl Blob {
                 remaining_retention_days: None,     // TODO: Not present or documentation bug?
                 tag_count: None,                    // TODO
                 rehydrate_priority: None,           // TODO
+                expiry_time: None,
                 extra: HashMap::new(),
             },
             metadata,

sdk/storage_blobs/src/blob/operations/mod.rs

@@ -21,6 +21,7 @@ mod put_page_blob;
 mod release_lease;
 mod renew_lease;
 mod set_blob_tier;
+mod set_expiry;
 mod set_metadata;
 mod set_properties;
 mod update_page;
@@ -47,6 +48,7 @@ pub use put_page_blob::*;
 pub use release_lease::*;
 pub use renew_lease::*;
 pub use set_blob_tier::*;
+pub use set_expiry::*;
 pub use set_metadata::*;
 pub use set_properties::*;
 pub use update_page::*;

sdk/storage_blobs/src/blob/operations/set_expiry.rs

@@ -0,0 +1,78 @@
+use crate::prelude::*;
+use azure_core::{headers::*, prelude::*, RequestId, Response};
+use std::convert::{TryFrom, TryInto};
+
+#[derive(Debug, Clone)]
+pub struct SetBlobExpiryBuilder {
+    blob_client: BlobClient,
+    blob_expiry: BlobExpiry,
+    lease_id: Option<LeaseId>,
+    context: Context,
+}
+
+impl SetBlobExpiryBuilder {
+    pub(crate) fn new(blob_client: BlobClient, expiry: BlobExpiry) -> Self {
+        Self {
+            blob_client,
+            blob_expiry: expiry,
+            lease_id: None,
+            context: Context::new(),
+        }
+    }
+
+    setters! {
+        lease_id: LeaseId => Some(lease_id),
+        context: Context => context,
+    }
+
+    pub fn into_future(mut self) -> FutureResponse {
+        Box::pin(async move {
+            let mut url = self.blob_client.url_with_segments(None)?;
+            url.query_pairs_mut().append_pair("comp", "expiry");
+
+            let mut headers = self.blob_expiry.to_headers();
+            headers.add(self.lease_id);
+
+            let mut request =
+                self.blob_client
+                    .finalize_request(url, azure_core::Method::Put, headers, None)?;
+
+            let response = self
+                .blob_client
+                .send(&mut self.context, &mut request)
+                .await?;
+            response.try_into()
+        })
+    }
+}
+
+#[derive(Debug, Clone)]
+pub struct SetBlobExpiryResponse {
+    pub request_id: RequestId,
+    pub client_request_id: Option<String>,
+    pub version: String,
+}
+
+impl TryFrom<Response> for SetBlobExpiryResponse {
+    type Error = crate::Error;
+
+    fn try_from(response: Response) -> Result<Self, Self::Error> {
+        let headers = response.headers();
+        Ok(SetBlobExpiryResponse {
+            request_id: request_id_from_headers(headers)?,
+            client_request_id: client_request_id_from_headers_optional(headers),
+            version: version_from_headers(headers)?,
+        })
+    }
+}
+
+pub type FutureResponse =
+    futures::future::BoxFuture<'static, azure_core::Result<SetBlobExpiryResponse>>;
+#[cfg(feature = "into_future")]
+impl std::future::IntoFuture for SetBlobExpiryBuilder {
+    type IntoFuture = Response;
+    type Output = <Response as std::future::Future>::Output;
+    fn into_future(self) -> Self::IntoFuture {
+        Self::into_future(self)
+    }
+}

sdk/storage_blobs/src/clients/blob_client.rs

@@ -106,6 +106,16 @@ impl BlobClient {
         SetBlobTierBuilder::new(self.clone())
     }
 
+    /// Set an expiry time on an existing blob.  
+    ///
+    /// This operation is only allowed on Hierarchical Namespace enabled
+    /// accounts.
+    ///
+    /// Ref: https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-expiry
+    pub fn set_blob_expiry(&self, blob_expiry: BlobExpiry) -> SetBlobExpiryBuilder {
+        SetBlobExpiryBuilder::new(self.clone(), blob_expiry)
+    }
+
     pub fn update_page(
         &self,
         ba512_range: BA512Range,

sdk/storage_blobs/src/container/operations/list_blobs.rs

@@ -211,6 +211,7 @@ mod tests {
             <Properties>
                 <Creation-Time>Thu, 01 Jul 2021 10:44:59 GMT</Creation-Time>
                 <Last-Modified>Thu, 01 Jul 2021 10:44:59 GMT</Last-Modified>
+                <Expiry-Time>Thu, 07 Jul 2022 14:38:48 GMT</Expiry-Time>
                 <Etag>0x8D93C7D4629C227</Etag>
                 <Content-Length>8</Content-Length>
                 <Content-Type>text/plain</Content-Type>

sdk/storage_blobs/src/options/blob_expiry.rs

@@ -0,0 +1,37 @@
+use azure_core::headers::Headers;
+use chrono::{DateTime, Utc};
+
+const EXPIRY_TIME: &str = "x-ms-expiry-time";
+const EXPIRY_OPTION: &str = "x-ms-expiry-option";
+
+#[derive(Debug, Clone)]
+pub enum BlobExpiry {
+    RelativeToCreation(u64),
+    RelativeToNow(u64),
+    Absolute(DateTime<Utc>),
+    NeverExpire,
+}
+
+impl BlobExpiry {
+    pub fn to_headers(&self) -> Headers {
+        let mut headers = Headers::new();
+        match self {
+            BlobExpiry::RelativeToCreation(duration) => {
+                headers.insert(EXPIRY_OPTION, "RelativeToCreation");
+                headers.insert(EXPIRY_TIME, duration.to_string());
+            }
+            BlobExpiry::RelativeToNow(duration) => {
+                headers.insert(EXPIRY_OPTION, "RelativeToNow");
+                headers.insert(EXPIRY_TIME, duration.to_string());
+            }
+            BlobExpiry::Absolute(date) => {
+                headers.insert(EXPIRY_OPTION, "Abosolute");
+                headers.insert(EXPIRY_TIME, date.to_rfc2822());
+            }
+            BlobExpiry::NeverExpire => {
+                headers.insert(EXPIRY_OPTION, "NeverExpire");
+            }
+        }
+        headers
+    }
+}

sdk/storage_blobs/src/options/mod.rs

@@ -8,6 +8,7 @@ mod blob_content_encoding;
 mod blob_content_language;
 mod blob_content_md5;
 mod blob_content_type;
+mod blob_expiry;
 mod blob_versioning;
 mod block_id;
 mod condition_append_position;
@@ -26,6 +27,7 @@ pub use blob_content_encoding::BlobContentEncoding;
 pub use blob_content_language::BlobContentLanguage;
 pub use blob_content_md5::BlobContentMD5;
 pub use blob_content_type::BlobContentType;
+pub use blob_expiry::BlobExpiry;
 pub use blob_versioning::BlobVersioning;
 pub use block_id::BlockId;
 pub use condition_append_position::ConditionAppendPosition;