SALES: 1-800-867-1380

CloudBlob.SetMetadata Method (BlobRequestOptions)

Updated: April 24, 2013

[This topic is part of the Windows Azure Storage Client Library 1.7, which has been deprecated. The current recommended version is Storage Client Library 3.0.]

Updates the blob's metadata, using a conditional request based on the BlobRequestOptions that you specify.

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

'Usage

public void SetMetadata (
	BlobRequestOptions options
)

Parameters

options

Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions

An object that specifies any additional options for the request.

The following code example writes metadata to a blob.

static void WriteBlobMetadata2(Uri blobEndpoint, string accountName, string accountKey)
{
    // Create service client for credentialed access to the blob.
    CloudBlobClient blobClient = new CloudBlobClient(blobEndpoint, 
        new StorageCredentialsAccountAndKey(accountName, accountKey)
        );

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

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

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

    // Set options for the request. E.g., Specify an operation timeout of 20 seconds.
    BlobRequestOptions options = new BlobRequestOptions();

    options.Timeout = TimeSpan.FromSeconds(20.0);

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

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


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

Development Platforms

Windows Vista, Windows 7 and Windows Server 2008

Target Platforms

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft