CloudBlob.Metadata Property

Storage Client Library NET API

[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]

Gets the blob's user-defined metadata.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Usage

Visual Basic
Dim instance As CloudBlob
Dim value As NameValueCollection

value = instance.Metadata

Syntax

Visual Basic
Public Property Metadata As NameValueCollection
C#
public NameValueCollection Metadata { get; }
C++
public:
property NameValueCollection^ Metadata {
	NameValueCollection^ get ();
}
J#
JScript

Property Value

Type: System.Collections.Specialized.NameValueCollection

The metadata of the blob.

Example

The following code example writes metadata to a blob.

C# Copy Code
static void WriteBlobMetadata(Uri blobEndpoint, string accountName, string accountKey)
{
    // Create service client for credentialed access to the Blob service.
    CloudBlobClient blobClient = 
        new CloudBlobClient(blobEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));

    // Return a blob reference.
    CloudBlob blob = new CloudBlob("mycontainer/myblob.txt", blobClient);

    // Write some text to the blob.
    blob.UploadText("this is a text blob");

    // Define some metadata for the blob.
    blob.Metadata["category"] = "images";
    blob.Metadata["owner"] = "azureix";

    // Write the metadata to the service.
    blob.SetMetadata();
}

Remarks

The FetchAttributes method populates the system properties and user-defined metadata of a blob. Before reading the properties or metadata of a blob, you should always call this method or the BeginFetchAttributes method to retrieve the latest values for the properties and metadata of the blob from the service.


Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Change History

See Also