DBEntityAspectApiDTO

Description

Inherits From

This DTO inherits from EntityAspect

Optional Parameters

dbEngine

  • type: string

  • description: The Database engine

dbEdition

  • type: string

  • description: The Database edition

dbVersion

  • type: string

  • description: The Database engine version

licenseModel

  • type: string

  • description: The license model of the database engine

deploymentType

  • type: string

  • description: The deployment type of the database engine

maxConcurrentWorkers

  • type: integer

  • format: int32

  • description: Maximum concurrent workers allowed for the DB

maxConcurrentSessions

  • type: integer

  • format: int32

  • description: Maximum concurrent sessions allowed for the DB

pricingModel

  • type: string

  • example: DTU

  • description: Database Pricing Model.

  • enum: ['DTU', 'vCore', 'DWU', 'RU']

replicationRole

  • type: string

  • example: Primary

  • description: Replication role if DB is part of geo replicated DB. Currently applies to Azure DB only.

  • enum: ['Primary', 'Secondary', 'None']

storageTier

  • type: string

  • example: GP2

  • description: Storage Tier

dbServerName

  • type: string

  • description: The server name of a database

serviceTier

  • type: string

  • example: Hyperscale

  • description: The service tier of a database, generally defines the storage architecture, space and I/O limits, and business continuity options related to availability and disaster recovery.

  • enum: ['Free', 'Basic', 'Standard', 'Premium', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale']

computeTier

  • type: string

  • example: Provisioned Compute

  • description: The compute tier of a database. Compute tier options include the provisioned and serverless compute tiers

hardwareGeneration

  • type: string

  • example: Gen4

  • description: Database hardware generation. The generation of hardware that underlies the DB instance

backupPolicy

  • type: string

  • example: Enabled

  • description: The policy to backup and restore a database.

workspace

  • type: string

  • description: The resource group where the database is located.

idleTime

  • type: integer

  • format: int64

  • description: Time duration for a database being idle in milliseconds.

poolType

  • type: string

  • description: Type of database pool.

resourceId

  • type: string

  • description: Resource identifier of the database. For example, the resource id in Azure, the ARN in AWS, or the full resource name in GCP.

serverConfiguration

  • type: string

  • description: The Database server configuration

creationTimeStamp

  • type: integer

  • format: int64

  • description: Timestamp in milliseconds for the creation of the database.