BlobEventsTrigger Class

Trigger that runs every time a Blob event occurs.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

BlobEventsTrigger(*, events: List[str | _models.BlobEventTypes], scope: str, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, annotations: List[MutableMapping[str, Any]] | None = None, pipelines: List[_models.TriggerPipelineReference] | None = None, blob_path_begins_with: str | None = None, blob_path_ends_with: str | None = None, ignore_empty_blobs: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection. Default value: None
description	str Trigger description. Default value: None
annotations	list[<xref:JSON>] List of tags that can be used for describing the trigger. Default value: None
pipelines	list[TriggerPipelineReference] Pipelines that need to be started. Default value: None
blob_path_begins_with	str The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. Default value: None
blob_path_ends_with	str The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. Default value: None
ignore_empty_blobs	bool If set to true, blobs with zero bytes will be ignored. Default value: None
events	list[str or BlobEventTypes] The type of events that cause this trigger to fire. Required.
scope	str The ARM resource ID of the Storage Account. Required.

Variables

Name	Description
additional_properties	dict[str, <xref:JSON>] Unmatched properties from the message are deserialized to this collection.
type	str Trigger type. Required.
description	str Trigger description.
runtime_state	str or TriggerRuntimeState Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. Known values are: "Started", "Stopped", and "Disabled".
annotations	list[<xref:JSON>] List of tags that can be used for describing the trigger.
pipelines	list[TriggerPipelineReference] Pipelines that need to be started.
blob_path_begins_with	str The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.
blob_path_ends_with	str The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith.
ignore_empty_blobs	bool If set to true, blobs with zero bytes will be ignored.
events	list[str or BlobEventTypes] The type of events that cause this trigger to fire. Required.
scope	str The ARM resource ID of the Storage Account. Required.

Feedback

Was this page helpful?