Struct StorageCredentials

pub struct StorageCredentials(pub Arc<RwLock<StorageCredentialsInner>>);

Credentials for accessing a storage account.

Example

The best way to create StorageCredentials is through use of one of the helper functions.

For example, to use an account name and access key:

azure_storage::StorageCredentials::access_key("my_account", azure_core::auth::Secret::new("SOMEACCESSKEY"));

Tuple Fields

0: Arc<RwLock<StorageCredentialsInner>>

Implementations

impl StorageCredentials

pub fn access_key<A, K>(account: A, key: K) -> Self

where A: Into<String>, K: Into<Secret>,

Create an Access Key based credential

When you create a storage account, Azure generates two 512-bit storage account access keys for that account. These keys can be used to authorize access to data in your storage account via Shared Key authorization.

ref: https://docs.microsoft.com/azure/storage/common/storage-account-keys-manage

pub fn sas_token<S>(token: S) -> Result<Self>

where S: AsRef<str>,

Create a Shared Access Signature (SAS) token based credential

SAS tokens are HTTP query strings that provide delegated access to resources in a storage account with granular control over how the client can access data in the account.

• ref: Grant limited access to Azure Storage resources using shared access signatures (SAS)
• ref: Create SAS tokens for storage containers

pub fn bearer_token<T>(token: T) -> Self

where T: Into<Secret>,

Create an Bearer Token based credential

Azure Storage accepts OAuth 2.0 access tokens from the Azure AD tenant associated with the subscription that contains the storage account.

While StorageCredentials::TokenCredential is the preferred way to manage access tokens, this method is provided for manual management of Oauth2 tokens.

ref: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory

pub fn token_credential(credential: Arc<dyn TokenCredential>) -> Self

Create a TokenCredential based credential

Azure Storage accepts OAuth 2.0 access tokens from the Azure AD tenant associated with the subscription that contains the storage account.

Token Credentials can be created and automatically updated using azure_identity.

use azure_storage::prelude::*;
let credential = azure_identity::create_credential().unwrap();
let storage_credentials = StorageCredentials::token_credential(credential);

ref: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory

pub fn anonymous() -> Self

Create an anonymous credential

Azure Storage supports optional anonymous public read access for containers and blobs. By default, anonymous access to data in a storage account data is not permitted. Unless anonymous access is explicitly enabled, all requests to a container and its blobs must be authorized. When a container’s public access level setting is configured to permit anonymous access, clients can read data in that container without authorizing the request.

ref: https://docs.microsoft.com/azure/storage/blobs/anonymous-read-access-configure

pub fn emulator() -> Self

Create an Access Key credential for use with the Azure Storage emulator

pub async fn replace(&self, other: Self) -> Result<()>

Replace the current credentials with new credentials

This method is useful for updating credentials that are used by multiple clients at once.

Trait Implementations

impl Clone for StorageCredentials

fn clone(&self) -> StorageCredentials

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StorageCredentials

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Arc<dyn TokenCredential>> for StorageCredentials

fn from(cred: Arc<dyn TokenCredential>) -> Self

Converts to this type from the input type.

impl TryFrom<&Url> for StorageCredentials

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Url) -> Result<Self, Self::Error>

Performs the conversion.