BlobAttribute Class

Reference

Definition

Namespace:: Microsoft.Azure.WebJobs

Assembly:: Microsoft.Azure.WebJobs.Extensions.Storage.Blobs.dll

Package:: Microsoft.Azure.WebJobs.Extensions.Storage.Blobs v5.2.2

Package:: Microsoft.Azure.WebJobs.Extensions.Storage.Blobs v5.3.0-beta.1

Source:: BlobAttribute.cs

Source:: BlobAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attribute used to bind a parameter to an Azure Blob. The attribute supports binding to single blobs, blob containers, or collections of blobs.

[Microsoft.Azure.WebJobs.ConnectionProvider(typeof(Microsoft.Azure.WebJobs.StorageAccountAttribute))]
[Microsoft.Azure.WebJobs.Description.Binding]
[System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)]
public sealed class BlobAttribute : Attribute, Microsoft.Azure.WebJobs.IConnectionProvider

[<Microsoft.Azure.WebJobs.ConnectionProvider(typeof(Microsoft.Azure.WebJobs.StorageAccountAttribute))>]
[<Microsoft.Azure.WebJobs.Description.Binding>]
[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue)>]
type BlobAttribute = class
    inherit Attribute
    interface IConnectionProvider

Public NotInheritable Class BlobAttribute
Inherits Attribute
Implements IConnectionProvider

Inheritance: Attribute
BlobAttribute

Attributes: Microsoft.Azure.WebJobs.ConnectionProviderAttribute Microsoft.Azure.WebJobs.Description.BindingAttribute AttributeUsageAttribute

Implements: Microsoft.Azure.WebJobs.IConnectionProvider

Remarks

The method parameter type can be one of the following:

BlobBaseClient
AppendBlobClient
BlockBlobClient
PageBlobClient
Stream
TextReader
TextWriter
String (normally for reading, or as an out parameter for writing)
byte[] (normally for reading, or as an out parameter for writing)

In addition to single blob bindings, parameters can be bound to multiple blobs. The parameter type can be BlobContainerClient or IEnumerable<T> of one of the following element types:

Constructors

BlobAttribute(String)	Initializes a new instance of the BlobAttribute class.
BlobAttribute(String, FileAccess)	Initializes a new instance of the BlobAttribute class.

Properties

Access	Gets the kind of operations that can be performed on the blob.
BlobPath	Gets the path of the blob to which to bind.
Connection	Gets or sets the app setting name that contains the Azure Storage connection string.

Applies to