BlobContainerClient.SetAccessPolicy Method

Reference

Definition

Namespace:: Azure.Storage.Blobs

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.19.1

Package:: Azure.Storage.Blobs v12.20.0-beta.2

Source:: BlobContainerClient.cs

Source:: BlobContainerClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The SetAccessPolicy(PublicAccessType, IEnumerable<BlobSignedIdentifier>, BlobRequestConditions, CancellationToken) operation sets the permissions for the specified container. The permissions indicate whether blob container data may be accessed publicly.

For more information, see Set Container ACL.

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo> SetAccessPolicy (Azure.Storage.Blobs.Models.PublicAccessType accessType = Azure.Storage.Blobs.Models.PublicAccessType.None, System.Collections.Generic.IEnumerable<Azure.Storage.Blobs.Models.BlobSignedIdentifier> permissions = default, Azure.Storage.Blobs.Models.BlobRequestConditions conditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SetAccessPolicy : Azure.Storage.Blobs.Models.PublicAccessType * seq<Azure.Storage.Blobs.Models.BlobSignedIdentifier> * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>
override this.SetAccessPolicy : Azure.Storage.Blobs.Models.PublicAccessType * seq<Azure.Storage.Blobs.Models.BlobSignedIdentifier> * Azure.Storage.Blobs.Models.BlobRequestConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobContainerInfo>

Public Overridable Function SetAccessPolicy (Optional accessType As PublicAccessType = Azure.Storage.Blobs.Models.PublicAccessType.None, Optional permissions As IEnumerable(Of BlobSignedIdentifier) = Nothing, Optional conditions As BlobRequestConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BlobContainerInfo)

Parameters

accessType: PublicAccessType

Optionally specifies whether data in the container may be accessed publicly and the level of access. BlobContainer specifies full public read access for container and blob data. Clients can enumerate blobs within the container via anonymous request, but cannot enumerate containers within the storage account. Blob specifies public read access for blobs. Blob data within this container can be read via anonymous request, but container data is not available. Clients cannot enumerate blobs within the container via anonymous request. None specifies that the container data is private to the account owner.

permissions: IEnumerable<BlobSignedIdentifier>

Stored access policies that you can use to provide fine grained control over container permissions.

conditions: BlobRequestConditions

Optional BlobRequestConditions to add conditions on setting this blob container's access policy.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Response<BlobContainerInfo>

A Response<T> describing the updated container.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to