Prefix Property

Filters the results to return only blobs/containers whose names begin with the specified prefix.

Object Oriented Interface

public function getPrefix();
public function setPrefix($value);

Procedural Interface

inazure_blob_get($res, 54 );
inazure_blob_set($res, 54, $value );

Default Value

''

Remarks

This property is used to filter the results returned by ListBlobs and ListContainers. When set prior to retrieving a blob or container list, only the blobs or containers starting with the specified prefix will be returned.

Prefix is useful for traversing a virtual namespace hierarchy and can work in conjunction with BlobDelimiter.

Note, the Azure Blob Storage does not support hierarchical structures. However blob names can be used to simulate a virtual hierarchical folder structure.

For example, we have blobs with the following names:

MyCompany, MyCompany/Department1, MyCompany/Department2

If we set BlobDelimiter to "/", calling ListBlobs, will return the "MyCompany" blob. The PrefixList event will also fire for "MyCompany/".

If you then wanted to traverse the blobs contained within the "MyCompany/" virtual folder, you can set Prefix to "MyCompany/" and call ListBlobs. The resulting blob list will contain the "MyCompany/Department1" and "MyCompany/Department2" blobs.

This property is not available at design time.

Data Type

String