AzureSDK.Storage.Container (Azure SDK v0.1.0)

Copy Markdown View Source

Azure Blob Storage container operations.

list/2 and list_blobs/3 automatically follow Azure pagination markers until all results are retrieved.

Summary

Functions

Creates a container.

Deletes a container.

Lists containers in the storage account.

Lists blobs in a container.

Returns container metadata.

Types

container()

@type container() :: %{name: String.t(), properties: map(), metadata: map()}

Functions

create(client, name, opts \\ [])

@spec create(AzureSDK.Storage.Client.t(), String.t(), keyword()) ::
  {:ok, container()} | {:error, AzureSDK.Error.t()}

Creates a container.

delete(client, name, opts \\ [])

@spec delete(AzureSDK.Storage.Client.t(), String.t(), keyword()) ::
  {:ok, :deleted} | {:error, AzureSDK.Error.t()}

Deletes a container.

list(client, opts \\ [])

@spec list(
  AzureSDK.Storage.Client.t(),
  keyword()
) :: {:ok, [container()]} | {:error, AzureSDK.Error.t()}

Lists containers in the storage account.

Follows NextMarker pagination until all containers are returned.

list_blobs(client, container, opts \\ [])

@spec list_blobs(AzureSDK.Storage.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, AzureSDK.Error.t()}

Lists blobs in a container.

Follows NextMarker pagination until all blobs are returned.

metadata(client, name, opts \\ [])

@spec metadata(AzureSDK.Storage.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, AzureSDK.Error.t()}

Returns container metadata.