com.microsoft.azure.storage.blob

Class BlobContainerPermissions

java.lang.Object

com.microsoft.azure.storage.Permissions<SharedAccessBlobPolicy>

com.microsoft.azure.storage.blob.BlobContainerPermissions

public final class BlobContainerPermissions
extends Permissions<SharedAccessBlobPolicy>

Represents the permissions for a container.

The container's permissions encompass two types of access settings for the container:

• The container's public access setting, represented by the publicAccess property. The public access setting indicates whether the container and its blobs can be read via an anonymous request.
• The container's access policies, represented by the Permissions.getSharedAccessPolicies() method. This setting references a collection of shared access policies for the container. A shared access policy may be used to control the start time, expiry time, and permissions for one or more shared access signatures. A shared access signature provides delegated access to the container's resources.

For more information on managing container permissions, see Managing Access to Containers and Blobs.

Constructor Summary

Constructors

Constructor and Description
BlobContainerPermissions() Creates an instance of the BlobContainerPermissions class.

Method Summary

Methods

Modifier and Type	Method and Description
BlobContainerPublicAccessType	getPublicAccess() Gets the public access setting for the container.
void	setPublicAccess(BlobContainerPublicAccessType publicAccess) Sets the public access setting for the container.

Methods inherited from class com.microsoft.azure.storage.Permissions

getSharedAccessPolicies, setSharedAccessPolicies

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlobContainerPermissions

public BlobContainerPermissions()

Creates an instance of the BlobContainerPermissions class.

Method Detail

getPublicAccess

public BlobContainerPublicAccessType getPublicAccess()

Gets the public access setting for the container.

The public access setting indicates whether the container and its blobs can be read via an anonymous request.

The BlobContainerPublicAccessType enumeration provides three levels of anonymous read access:

• BlobContainerPublicAccessType.OFF, which prevents anonymous access.
• BlobContainerPublicAccessType.BLOB, which permits anonymous read access to blob resources, but not to container metadata or to the list of blobs in the container.
• BlobContainerPublicAccessType.CONTAINER, which permits anonymous read access to blob resources, container metadata, and the list of blobs in the container.

For more information on managing anonymous access to Blob service resources, see Setting Access Control for Containers.

setPublicAccess

public void setPublicAccess(BlobContainerPublicAccessType publicAccess)

Sets the public access setting for the container.

The public access setting indicates whether the container and its blobs can be read via an anonymous request.

The BlobContainerPublicAccessType enumeration provides three levels of anonymous read access:

• BlobContainerPublicAccessType.OFF, which prevents anonymous access.
• BlobContainerPublicAccessType.BLOB, which permits anonymous read access to blob resources, but not to container metadata or to the list of blobs in the container.
• BlobContainerPublicAccessType.CONTAINER, which permits anonymous read access to blob resources, container metadata, and the list of blobs in the container.

For more information on managing anonymous access to Blob service resources, see Setting Access Control for Containers.