BlobAttribute Class

Definition

Namespace:

Microsoft.Azure.WebJobs

Assembly:

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

Package:

Microsoft.Azure.WebJobs.Extensions.Storage.Blobs v5.3.3

Source:

BlobAttribute.cs

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:

• BlobClient
• BlobBaseClient
• AppendBlobClient
• BlockBlobClient
• PageBlobClient
• Stream
• String
• TextReader

Constructors

BlobAttribute(String, FileAccess)	Initializes a new instance of the BlobAttribute class.
BlobAttribute(String)	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.