[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.]
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)
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
| Visual Basic |
|---|
Dim instance As CloudBlob Dim options As BlobRequestOptions instance.SetMetadata(options) |
Syntax
| Visual Basic |
|---|
Public Sub SetMetadata ( _ options As BlobRequestOptions _ ) |
| C# |
|---|
public void SetMetadata ( BlobRequestOptions options ) |
| C++ |
|---|
public: void SetMetadata ( BlobRequestOptions^ options ) |
| J# |
|---|
| JScript |
|---|
Parameters
- options
Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions
An object that specifies any additional options for the request.
Example
The following code example writes metadata to a blob.
| C# | Copy Code |
|---|---|
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);
}
| |
Remarks
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.
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.