CloudBlobContainer.SetMetadata Method ()

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.]

Sets the container's user-defined metadata.

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

Usage

Visual Basic
Dim instance As CloudBlobContainer

instance.SetMetadata

Syntax

Visual Basic
Public Sub SetMetadata
C#
public void SetMetadata ()
C++
public:
void SetMetadata ()
J#
JScript

Example

The following code example defines some metadata for a container and writes it to the container.

C# Copy Code
static void WriteContainerMetadata(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 container reference.
    CloudBlobContainer container = new CloudBlobContainer("mycontainer", blobClient);

    //Create the container if it does not exist.
    container.CreateIfNotExist();

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

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

Remarks

The SetMetadata method writes the metadata values that are specified by the container's Metadata property to the service. Note that setting the Metadata property sets metadata values on the blob reference only; you must call SetMetadata or BeginSetMetadata to write them to the service.

You can also set metadata on a container when the container is created, without calling SetMetadata.


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