Package com.azure.cosmos.encryption

Class CosmosEncryptionDatabase

java.lang.Object
com.azure.cosmos.encryption.CosmosEncryptionDatabase
public final class CosmosEncryptionDatabase extends Object
CosmosEncryptionDatabase with encryption capabilities.

  • Method Details

    • getClientEncryptionKey

      public CosmosClientEncryptionKey getClientEncryptionKey(String id)
      Gets a CosmosClientEncryptionKey object without making a service call
      Parameters:
      id - id of the clientEncryptionKey
      Returns:
      Cosmos ClientEncryptionKey

    • readAllClientEncryptionKeys

      public CosmosPagedIterable<CosmosClientEncryptionKeyProperties> readAllClientEncryptionKeys()
      Reads all cosmos client encryption keys in a database.

      After subscription the operation will be performed. The CosmosPagedIterable will contain one or several feed response of the read cosmos client encryption keys. In case of failure the CosmosPagedIterable will error.

      Returns:
      a CosmosPagedIterable.

    • createClientEncryptionKey

      public CosmosClientEncryptionKeyResponse createClientEncryptionKey(String clientEncryptionKeyId, String encryptionAlgorithm, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)
      Creates a client encryption key after subscription the operation will be performed.
      Parameters:
      clientEncryptionKeyId - Client Encryption Key id.
      encryptionAlgorithm - Encryption Algorithm.
      encryptionKeyWrapMetadata - EncryptionKeyWrapMetadata.
      Returns:
      the resource response with the created cosmos client encryption key or an error.

    • rewrapClientEncryptionKey

      public CosmosClientEncryptionKeyResponse rewrapClientEncryptionKey(String clientEncryptionKeyId, EncryptionKeyWrapMetadata newEncryptionKeyWrapMetadata)
      Rewrap a cosmos client encryption key
      Parameters:
      clientEncryptionKeyId - the client encryption key properties to create.
      newEncryptionKeyWrapMetadata - EncryptionKeyWrapMetadata.
      Returns:
      the resource response with the read client encryption key or an error.

    • getCosmosDatabase

      public CosmosDatabase getCosmosDatabase()
      Gets a CosmosDatabase.
      Returns:
      cosmos database

    • getCosmosEncryptionContainer

      public CosmosEncryptionContainer getCosmosEncryptionContainer(CosmosContainer container)
      Gets a Container with Encryption capabilities
      Parameters:
      container - original container
      Returns:
      container with encryption capabilities

    • getCosmosEncryptionContainer

      public CosmosEncryptionContainer getCosmosEncryptionContainer(String containerId)
      Gets a Container with Encryption capabilities
      Parameters:
      containerId - original container id
      Returns:
      container with encryption capabilities