IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

SetContainerACL Method

Sets the stored access policies and public access level for a container.

Syntax

azureblob.setContainerACL(publicAccess, [callback])

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 this 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 method sets the stored access policies and the public access level for the container currently specified by Container. The items in the AccessPolicy* properties determine the new set of stored access policies, and PublicAccess determines the new public access level. Possible values are:

acpaNone (0) The container is private.
acpaBlobs (1) Blob data within the container is publicly readable, but blobs cannot be listed.
acpaContainer (2) Container information and blob data within the container is publicly readable, and blobs can be listed.

Note that it is not possible to do a partial update of stored access policies. That is, all stored access policies currently associated with the container will be replaced with the stored access policies sent in the request. To prevent data loss, applications should call GetContainerACL to retrieve the container's current stored access polices, and then add/modify/remove them as desired, before using this method.

If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]