AccessPolicy Property

The access policy assigned to a container.

Syntax

 azureblob.getAccessPolicy([callback])
 azureblob.setAccessPolicy( accessPolicy, [callback])

Possible Values

  0 (apFullPublic), 
  1 (apBlobsOnly), 
  2 (apPrivate)

Default Value

2

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAccessPolicy([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAccessPolicy([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property allows you to specify whether blobs in a container can be accessed publicly. The access policy is set for a container when calling CreateContainer or SetContainerACL. AccessPolicy will also be populated after a GetContainerACL call.

The available access policies are:

Data Type

Integer