API Reference › core-backend› BlobContainers › BlobContainer

BlobContainer Namespace

Types and functions for creating, deleting and authorizing access to cloud-based blob containers for an iTwin.

Interface

Name Description
BlobContainer.AccessContainerProps Information required to access an existing container.
BlobContainer.ContainerService Methods to create, delete, and access blob containers.
BlobContainer.CreatedContainerProps Information about a newly created container.
BlobContainer.CreateNewContainerProps Information required to create a new container.
BlobContainer.Metadata Metadata about the use of a container so that:
BlobContainer.MetadataResponse Properties returned by queryContainersMetadata
BlobContainer.QueryContainerProps Query Parameters for querying containers
BlobContainer.RequestTokenProps Information required to request an access token for a container.
BlobContainer.Scope The scope for a container.
BlobContainer.TokenProps Properties returned by Service.requestToken
BlobContainer.UriAndId The URI and Id of the container.

Type alias

Name Description
BlobContainer.ContainerId the name of the container within its Scope
BlobContainer.ContainerToken token that authenticates access to a container for either read or write.
BlobContainer.Provider name of cloud provider for a container.
BlobContainer.RequestAccessLevel Access level to request for token.
BlobContainer.UserToken token that authenticates a user.

Variable

Name Description
BlobContainer.service Object that implements the methods to create, delete, and request access to a container.

Defined in

Last Updated: 21 November, 2024