cargo test --all

cataggar · Jan 7, 2024 · 2b4d01b · 2b4d01b
1 parent 918e9da
commit 2b4d01b
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 92 deletions.
diff --git a/sdk/identity/CHANGELOG.md b/sdk/identity/CHANGELOG.md
@@ -1,8 +1,9 @@
 # 0.20.0 (2023-02)
 
 - [#1532](https://github.com/Azure/azure-sdk-for-rust/pull/1532) add azure_identity::create_credential(), SpecificAzureCredential, AppServiceManagedIdentityCredential, VirtualMachineManagedIdentityCredential
-    - Most credentials now may fail earlier, when they are created, instead of only during `get_token`.
-    - `DefaultAzureCredentialBuilder::build` now returns a `Result`. If fails when it is unable to create a least one source credential.
+    - BREAKING CHANGE: `DefaultAzureCredentialBuilder::build` now returns a `Result`. If fails when it is unable to create at least one source credential.
+    - Most credentials may now fail earlier, when they are created, instead of only during `get_token`.
+    - `DefaultAzureCredential::default()` has been removed, because creating the credential may fail. Please use `azure_identity::create_default_credential()?` or `azure_identity::create_credential()?` instead.
 
 
 # 0.18.0 (2023-12)

diff --git a/sdk/identity/examples/client_certificate_credentials.rs b/sdk/identity/examples/client_certificate_credentials.rs
@@ -12,10 +12,10 @@ use std::env::var;
 use url::Url;
 
 async fn get_certficate(vault_name: &str, certificate_name: &str) -> azure_core::Result<Secret> {
-    let creds = DefaultAzureCredential::default();
+    let credential = azure_identity::create_credential()?;
     let client = KeyvaultClient::new(
         format!("https://{}.vault.azure.net", vault_name).as_str(),
-        std::sync::Arc::new(creds),
+        credential,
     )?
     .certificate_client();
     let response = client.get(certificate_name).await?;

diff --git a/sdk/iot_deviceupdate/src/client.rs b/sdk/iot_deviceupdate/src/client.rs
@@ -16,9 +16,8 @@ pub(crate) const API_VERSION_PARAM: &str = formatcp!("api-version={}", API_VERSI
 ///
 /// ```no_run
 /// use azure_iot_deviceupdate::DeviceUpdateClient;
-/// use azure_identity::DefaultAzureCredential;
-/// let creds = std::sync::Arc::new(DefaultAzureCredential::default());
-/// let client = DeviceUpdateClient::new("contoso.api.adu.microsoft.com", creds).unwrap();
+/// let credential = azure_identity::create_credential().unwrap();
+/// let client = DeviceUpdateClient::new("contoso.api.adu.microsoft.com", credential).unwrap();
 /// ```
 
 #[derive(Clone)]
@@ -35,9 +34,8 @@ impl DeviceUpdateClient {
     ///
     /// ```no_run
     /// use azure_iot_deviceupdate::DeviceUpdateClient;
-    /// use azure_identity::DefaultAzureCredential;
-    /// let creds = std::sync::Arc::new(DefaultAzureCredential::default());
-    /// let client = DeviceUpdateClient::new("contoso.api.adu.microsoft.com", creds).unwrap();
+    /// let credential = azure_identity::create_credential().unwrap();
+    /// let client = DeviceUpdateClient::new("contoso.api.adu.microsoft.com", credential).unwrap();
     /// ```
     pub fn new(
         device_update_url: &str,

diff --git a/sdk/security_keyvault/src/clients/certificate_client.rs b/sdk/security_keyvault/src/clients/certificate_client.rs
@@ -26,15 +26,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     let certificate = client.get("NAME").await.unwrap();
     ///     dbg!(&certificate);
@@ -55,16 +53,14 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
     /// use futures::StreamExt;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     let certificate_versions = client.get_versions("NAME").into_stream().next().await.unwrap();
     ///     dbg!(&certificate_versions);
@@ -85,15 +81,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     let certificate = client.get_operation("NAME").await.unwrap();
     ///     dbg!(&certificate);
@@ -116,15 +110,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     let certificate = client.create("NAME", "SUBJECT", "ISSUER").await.unwrap();
     ///     dbg!(&certificate);
@@ -154,15 +146,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     let certificate = client.merge("NAME", vec![String::from("X5C")]).await.unwrap();
     ///     dbg!(&certificate);
@@ -187,15 +177,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     let certificate = client.import("NAME", "VALUE").pwd("pwd").await.unwrap();
     ///     dbg!(&certificate);
@@ -225,15 +213,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     client.backup("NAME").await.unwrap();
     /// }
@@ -257,15 +243,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     client.delete("NAME").await.unwrap();
     /// }
@@ -289,15 +273,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     client.delete_operation("NAME").await.unwrap();
     /// }
@@ -315,16 +297,14 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use futures::StreamExt;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///          &"KEYVAULT_URL",
-    ///          Arc::new(creds),
+    ///          credential,
     ///     ).unwrap().certificate_client();
     ///     let certificates = client.list_certificates().into_stream().next().await.unwrap();
     ///     dbg!(&certificates);
@@ -343,15 +323,13 @@ impl CertificateClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
     /// use tokio::runtime::Runtime;
-    /// use std::sync::Arc;
     ///
     /// async fn example() {
-    ///     let creds = DefaultAzureCredential::default();
+    ///     let credential = azure_identity::create_credential().unwrap();
     ///     let mut client = KeyvaultClient::new(
     ///         &"KEYVAULT_URL",
-    ///         Arc::new(creds),
+    ///         credential,
     ///     ).unwrap().certificate_client();
     ///     client.restore_certificate("KUF6dXJlS2V5VmF1bHRTZWNyZXRCYWNrdXBWMS5taW").await.unwrap();
     /// }

diff --git a/sdk/security_keyvault/src/clients/keyvault_client.rs b/sdk/security_keyvault/src/clients/keyvault_client.rs
@@ -19,9 +19,8 @@ const API_VERSION_PARAM: &str = "api-version";
 ///
 /// ```no_run
 /// use azure_security_keyvault::KeyvaultClient;
-/// use azure_identity::DefaultAzureCredential;
-/// let creds = DefaultAzureCredential::default();
-/// let client = KeyvaultClient::new(&"https://test-key-vault.vault.azure.net", std::sync::Arc::new(creds)).unwrap();
+/// let credential = azure_identity::create_credential().unwrap();
+/// let client = KeyvaultClient::new(&"https://test-key-vault.vault.azure.net", credential).unwrap();
 /// ```
 #[derive(Clone)]
 pub struct KeyvaultClient {
@@ -44,10 +43,8 @@ impl KeyvaultClient {
     ///
     /// ```no_run
     /// use azure_security_keyvault::KeyvaultClient;
-    /// use azure_identity::DefaultAzureCredential;
-    /// use std::sync::Arc;
-    /// let creds = Arc::new(DefaultAzureCredential::default());
-    /// let client = KeyvaultClient::new("test-key-vault.vault.azure.net", creds).unwrap();
+    /// let credential = azure_identity::create_credential().unwrap();
+    /// let client = KeyvaultClient::new("test-key-vault.vault.azure.net", credential).unwrap();
     /// ```
     pub fn new(
         vault_url: &str,