Microsoft.Azure.WebJobs Attribute used to bind a parameter to an Azure Blob, causing the method to run when a blob is uploaded. The method parameter type can be one of the following: ICloudBlob CloudBlockBlob CloudPageBlob A custom type implementing Initializes a new instance of the class. The path of the blob to which to bind. The blob portion of the path can contain tokens in curly braces to indicate a pattern to match. The matched name can be used in other binding attributes to define the output name of a Job function. Gets the path of the blob to which to bind. The blob portion of the path can contain tokens in curly braces to indicate a pattern to match. The matched name can be used in other binding attributes to define the output name of a Job function. Provides extension methods for the interface. Binds the specified attribute. The type to which to bind. The binder to use to bind. The attribute to bind. The value bound. Attribute that can be applied to job functions, trigger parameters and classes to conditionally disable triggered functions. For example, by using this attribute, you can dynamically disable functions temporarily by changing application settings. Note that the disable check is done on startup only. If a in the hierarchy (Parameter/Method/Class) exists and indicates that the function should be disabled, the listener for that function will not be started. The attribute only affects triggered functions. Additionally, when running in an Azure Web App, you can set app setting WEBJOBS_STOPPED to 1 to completely disable the JobHost. In this case the JobHost won't even be started. Constructs a new instance. Constructs a new instance. The name of an application setting or environment variable that governs whether the function(s) should be disabled. If the specified setting exists and its value is "1" or "True", the function will be disabled. The setting name can contain binding parameters (e.g. {MethodName}, {MethodShortName}, %test%, etc.). Constructs a new instance. A Type which implements a method named "IsDisabled" taking a and returning . This function will be called to determine whether the target function should be disabled. Gets the name of the application setting or environment variable that will be used to determine whether the function(s) should be disabled. Gets the custom that will be invoked to determine whether the function(s) should be disabled. Defines an asynchronous collector (an insert-only collection). The type of items to collect. Adds an item to the . The item to be added. The token to monitor for cancellation requests. A task that will add the item to the collector. Defines a blob binder for a custom type. The type of object the binder can bind. Binds the content of the blob to a custom type. The blob stream to read. The token to monitor for cancellation requests. A that will provide the deserialized object. Binds the custom type to the contents of a blob. The value to serialize. The stream to which to write the value. The token to monitor for cancellation requests. A that will write to the stream. Interface defining functionality for dynamically binding to WebJobs SDK attributes at runtime. This interface enables imperative binding with attribute information specified at runtime. Binds the specified attribute. The type to which to bind. The attribute to bind. The token to monitor for cancellation requests. A that will provide the bound the value. Attribute used to bind a parameter to an Azure Blob. The attribute supports binding to single blobs, blob containers, or collections of blobs. The method parameter type can be one of the following: ICloudBlob CloudBlockBlob CloudPageBlob (read-only) CloudBlobStream (write-only) (normally for reading, or as an out parameter for writing) (normally for reading, or as an out parameter for writing) A custom type implementing (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 CloudBlobContainer, CloudBlobDirectory or of one of the following element types: ICloudBlob CloudBlockBlob CloudPageBlob Stream string TextReader Initializes a new instance of the class. The path of the blob to which to bind. Initializes a new instance of the class. The path of the blob to which to bind. The kind of operations that can be performed on the blob. Gets the path of the blob to which to bind. Gets the kind of operations that can be performed on the blob. Defines a collector (an insert-only collection). The type of items to collect. Adds an item to the . The item to be added. Attribute used to bind a parameter to an Azure Queue. The method parameter type can be one of the following: CloudQueue CloudQueueMessage (out parameter) (out parameter) (out parameter) A user-defined type (out parameter, serialized as JSON) of these types (to enqueue multiple messages via of these types (to enqueue multiple messages via Initializes a new instance of the class. The name of the queue to which to bind. Gets the name of the queue to which to bind. Attribute used to bind a parameter to an Azure Queue message, causing the function to run when a message is enqueued. The method parameter type can be one of the following: CloudQueueMessage A user-defined type (serialized as JSON) Initializes a new instance of the class. The name of the queue to which to bind. Gets the name of the queue to which to bind. This attribute can be applied to a job functions to ensure that only a single instance of the function is executed at any given time (even across host instances). A blob lease is used behind the scenes to implement the lock. This attribute can also be used in mode to ensure that the listener for a triggered function is only running on a single instance. Trigger bindings can make this implicit by applying the attribute to their IListener implementation. Functions can override an implicit singleton by applying a singleton to their function with mode . Constructs a new instance. Constructs a new instance using the specified scope settings. The scope value for the singleton lock. This value can be used to implement finer grained locks by including binding parameters that bind to function input data. The to use. When set to , the lock is only scoped to the specific function, meaning invocations of that function will be serialized. To implement locking across multiple functions, you can use and apply the same attribute to multiple functions. Each function will then use the same lock, and invocations of all the functions will be serialized. The default value is . Gets the scope identifier for the singleton lock. Gets or sets the this singleton should use. Defaults to if not explicitly specified. Gets or sets the this singleton should use. Defaults to if not explicitly specified. Gets the name of the Azure Storage account that the blob lease should be created in. If not specified, the default AzureWebJobs storage account will be used. Gets or sets the timeout value in seconds for lock acquisition. If the lock is not obtained within this interval, the invocation will fail. When set, this value will override the corresponding global configuration value set in JobHostConfiguration.Singleton. Enumeration of modes that can operate in. Indicates a singleton lock that is taken before each function invocation, and released immediately after. This is the default. Indicates a singleton lock that is taken when starting the listener for a triggered function. Using this mode, the listener (and therefore the function) will only be running on a single instance (when scaled out). Enumeration of values used to control the scope of Singleton locks. Indicates a Singleton lock that is scoped a single function. Indicates a Singleton lock that is scoped to the JobHost. This is useful in scenarios where locking across multiple functions is desired. In this case the same attribute can be applied to multiple functions, and they'll share the same lock. Attribute used to override the default Azure Storage account used by triggers and binders. This attribute can be applied at the parameter/method/class level, and the precedence is in that order. Constructs a new instance. The name of the Azure Storage connection string to use. This should be the name of one of the connection strings present in the application settings (or environment variables). The connection string name in settings should be prefixed with the standard "AzureWebJobs" prefix, but the value you specify here should not include that prefix. Gets the name of the Azure Storage connection string to use. Attribute used to bind a parameter to an Azure Table or Table entity. When only the table name is provided, the attribute binds to a table, and the method parameter type can be one of the following: CloudTable (where T implements ITableEntity) When the table name, partition key, and row key are provided, the attribute binds to a table entity, and the method parameter type can be one of the following: ITableEntity A user-defined type not implementing ITableEntity (serialized as strings for simple types and JSON for complex types) Initializes a new instance of the class. The name of the table to which to bind. Initializes a new instance of the class. The name of the table containing the entity. The partition key of the entity. The row key of the entity. Gets the name of the table to which to bind. When binding to a table entity, gets the name of the table containing the entity. When binding to a table entity, gets the partition key of the entity. When binding to an entire table, returns . When binding to a table entity, gets the row key of the entity. When binding to an entire table, returns . Attribute used to mark a job function that will not be automatically triggered. This attribute is useful in two cases: Functions with triggers Prevents automatic invocation of the triggers, allowing manual polling. Functions without other attributes Flags the function as an available job function. In both cases, functions marked with this attribute are never called automatically by JobHost (during RunAndBlock). Instead, they must be invoked manually using the Call method. Attribute that can be applied at the class or function level to limit the execution time of job functions. To receive the timeout cancellation, a function must include a parameter. Then, if a particular function invocation exceeds the timeout, the will be cancelled, and an error will be logged. The function should monitor the token for cancellation and abort when it is cancelled, and it should pass it to any async operations it initiates. Constructs a new instance. The timeout limit as a string (e.g. "00:30:00"). Gets the timeout value. Attribute used to specify for job functions. This setting will affect both Console logging as well as Dashboard logging. For very high throughput functions where performance is key you can set the level to if you don't want any logs (Console or Dashboard) to be produced. Dashboard logging is somewhat expensive, so this can improve your throughput. You can also choose to set the level to and logs will only be written for function invocations that fail. Constructs a new instance. The to use for the function. Gets the to use for the function.