Skip to main content

BlobServiceClient

Struct BlobServiceClient 

Source
pub struct BlobServiceClient { /* private fields */ }

Implementations§

Source§

impl BlobServiceClient

Source

pub fn new( service_url: Url, credential: Option<Arc<dyn TokenCredential>>, options: Option<BlobServiceClientOptions>, ) -> Result<Self>

Creates a new BlobServiceClient from a service URL.

§Arguments
  • service_url - The full URL of the Azure storage account, for example https://myaccount.blob.core.windows.net/. The caller is responsible for percent-encoding the URL correctly; it will be used as-is.
  • credential - An optional implementation of TokenCredential that can provide an Entra ID token to use when authenticating.
  • options - Optional configuration for the client.
Source

pub fn blob_container_client(&self, container_name: &str) -> BlobContainerClient

Returns a new instance of BlobContainerClient.

§Arguments
  • container_name - The name of the container.
Source

pub fn blob_client(&self, container_name: &str, blob_name: &str) -> BlobClient

Returns a new instance of BlobClient.

§Arguments
  • container_name - The name of the container.
  • blob_name - The name of the blob.
Source

pub fn url(&self) -> &Url

Gets the URL of the resource this client is configured for.

Source§

impl BlobServiceClient

Source

pub fn find_blobs_by_tags( &self, filter_expression: &str, options: Option<BlobServiceClientFindBlobsByTagsOptions<'_>>, ) -> Result<Pager<FilteredBlobResponse, XmlFormat>>

Lists blobs across all containers whose tags match a given search expression.

§Arguments
  • filter_expression - Filters the results to return only blobs whose tags match the specified expression.
  • options - Optional parameters for the request.
Source

pub async fn get_account_info( &self, options: Option<BlobServiceClientGetAccountInfoOptions<'_>>, ) -> Result<Response<BlobServiceClientGetAccountInfoResult, NoFormat>>

Returns information about the storage account.

§Arguments
  • options - Optional parameters for the request.
§Response Headers

The returned Response implements the BlobServiceClientGetAccountInfoResultHeaders trait, which provides access to response headers. For example:

use azure_core::{Result, http::{Response, NoFormat}};
use azure_storage_blob::models::{BlobServiceClientGetAccountInfoResult, BlobServiceClientGetAccountInfoResultHeaders};
async fn example() -> Result<()> {
    let response: Response<BlobServiceClientGetAccountInfoResult, NoFormat> = unimplemented!();
    // Access response headers
    if let Some(account_kind) = response.account_kind()? {
        println!("x-ms-account-kind: {:?}", account_kind);
    }
    if let Some(is_hierarchical_namespace_enabled) = response.is_hierarchical_namespace_enabled()? {
        println!("x-ms-is-hns-enabled: {:?}", is_hierarchical_namespace_enabled);
    }
    if let Some(sku_name) = response.sku_name()? {
        println!("x-ms-sku-name: {:?}", sku_name);
    }
    Ok(())
}
§Available headers
Source

pub async fn get_properties( &self, options: Option<BlobServiceClientGetPropertiesOptions<'_>>, ) -> Result<Response<BlobServiceProperties, XmlFormat>>

Retrieves properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

§Arguments
  • options - Optional parameters for the request.
Source

pub async fn get_statistics( &self, options: Option<BlobServiceClientGetStatisticsOptions<'_>>, ) -> Result<Response<StorageServiceStats, XmlFormat>>

Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.

§Arguments
  • options - Optional parameters for the request.
Source

pub async fn get_user_delegation_key( &self, key_info: RequestContent<KeyInfo, XmlFormat>, options: Option<BlobServiceClientGetUserDelegationKeyOptions<'_>>, ) -> Result<Response<UserDelegationKey, XmlFormat>>

Retrieves a user delegation key for the Blob service. This is only a valid operation when using bearer token authentication.

§Arguments
  • key_info - Key information provided in the request.
  • options - Optional parameters for the request.
Source

pub fn list_containers( &self, options: Option<BlobServiceClientListContainersOptions<'_>>, ) -> Result<Pager<ListContainersResponse, XmlFormat>>

Returns a list of the containers in the specified account.

§Arguments
  • options - Optional parameters for the request.
Source

pub async fn set_properties( &self, storage_service_properties: RequestContent<BlobServiceProperties, XmlFormat>, options: Option<BlobServiceClientSetPropertiesOptions<'_>>, ) -> Result<Response<(), NoFormat>>

Sets properties for a storage account’s Blob service endpoint, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

§Arguments
  • storage_service_properties - The storage service properties to set.
  • options - Optional parameters for the request.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ServiceExt for T

Source§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
Source§

fn decompression(self) -> Decompression<Self>
where Self: Sized,

Decompress response bodies. Read more
Source§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
Source§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
Source§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more