DatabaseListResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-sql-database/json-schema/microsoft-azure-sql-database-database-list-result-schema.json",
  "title": "DatabaseListResult",
  "description": "The response of a Database list operation.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-sql-database-databases-api-openapi.yml#/components/schemas/DatabaseListResult",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The Database items on this page",
      "items": {
        "$ref": "#/$defs/Database"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "Database": {
      "type": "object",
      "description": "A database resource.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/DatabaseProperties"
        },
        "sku": {
          "type": "object",
          "description": "An ARM Resource SKU.",
          "properties": {
            "name": {
              "type": "string",
              "description": "The name of the SKU, typically, a letter + Number code, e.g. P3."
            },
            "tier": {
              "type": "string",
              "description": "The tier or edition of the particular SKU, e.g. Basic, Premium."
            },
            "size": {
              "type": "string",
              "description": "Size of the particular SKU"
            },
            "family": {
              "type": "string",
              "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here."
            },
            "capacity": {
              "type": "integer",
              "format": "int32",
              "description": "Capacity of the particular SKU."
            }
          },
          "required": [
            "name"
          ]
        },
        "kind": {
          "type": "string",
          "description": "Kind of database. This is metadata used for the Azure portal experience.",
          "readOnly": true
        },
        "managedBy": {
          "type": "string",
          "description": "Resource that manages the database.",
          "readOnly": true
        },
        "identity": {
          "$ref": "#/$defs/DatabaseIdentity"
        }
      },
      "allOf": [
        {
          "type": "object",
          "title": "Tracked Resource",
          "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
          "properties": {
            "tags": {
              "type": "object",
              "description": "Resource tags.",
              "additionalProperties": {
                "type": "string"
              },
              "x-ms-mutability": [
                "read",
                "create",
                "update"
              ]
            },
            "location": {
              "type": "string",
              "description": "The geo-location where the resource lives",
              "x-ms-mutability": [
                "read",
                "create"
              ]
            }
          },
          "required": [
            "location"
          ],
          "allOf": [
            {
              "type": "object",
              "title": "Resource",
              "description": "Common fields that are returned in the response for all Azure Resource Manager resources",
              "properties": {
                "id": {
                  "type": "string",
                  "format": "arm-id",
                  "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"",
                  "readOnly": true
                },
                "name": {
                  "type": "string",
                  "description": "The name of the resource",
                  "readOnly": true
                },
                "type": {
                  "type": "string",
                  "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"",
                  "readOnly": true
                },
                "systemData": {
                  "type": "object",
                  "description": "Metadata pertaining to creation and last modification of the resource.",
                  "properties": {
                    "createdBy": {
                      "type": "string",
                      "description": "The identity that created the resource."
                    },
                    "createdByType": {
                      "type": "string",
                      "description": "The type of identity that created the resource.",
                      "enum": [
                        "User",
                        "Application",
                        "ManagedIdentity",
                        "Key"
                      ],
                      "x-ms-enum": {
                        "name": "createdByType",
                        "modelAsString": true
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time",
                      "description": "The timestamp of resource creation (UTC)."
                    },
                    "lastModifiedBy": {
                      "type": "string",
                      "description": "The identity that last modified the resource."
                    },
                    "lastModifiedByType": {
                      "type": "string",
                      "description": "The type of identity that last modified the resource.",
                      "enum": [
                        "User",
                        "Application",
                        "ManagedIdentity",
                        "Key"
                      ],
                      "x-ms-enum": {
                        "name": "createdByType",
                        "modelAsString": true
                      }
                    },
                    "lastModifiedAt": {
                      "type": "string",
                      "format": "date-time",
                      "description": "The timestamp of resource last modification (UTC)"
                    }
                  },
                  "readOnly": true
                }
              },
              "x-ms-azure-resource": true
            }
          ]
        }
      ]
    },
    "DatabaseIdentity": {
      "type": "object",
      "description": "Azure Active Directory identity configuration for a resource.",
      "properties": {
        "type": {
          "type": "string",
          "description": "The identity type",
          "enum": [
            "None",
            "UserAssigned"
          ],
          "x-ms-enum": {
            "name": "DatabaseIdentityType",
            "modelAsString": true,
            "values": [
              {
                "name": "None",
                "value": "None",
                "description": "None"
              },
              {
                "name": "UserAssigned",
                "value": "UserAssigned",
                "description": "UserAssigned"
              }
            ]
          }
        },
        "tenantId": {
          "type": "string",
          "format": "uuid",
          "description": "Universally Unique Identifier"
        },
        "userAssignedIdentities": {
          "type": "object",
          "description": "The resource ids of the user assigned identities to use",
          "additionalProperties": {
            "$ref": "#/$defs/DatabaseUserIdentity"
          }
        }
      }
    },
    "DatabaseProperties": {
      "type": "object",
      "description": "The database's properties.",
      "properties": {
        "createMode": {
          "type": "string",
          "description": "Specifies the mode of database creation.\n\nDefault: regular database creation.\n\nCopy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.\n\nSecondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.\n\nPointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.\n\nRecovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.\n\nRestore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.\n\nRestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.\n\nCopy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.",
          "enum": [
            "Default",
            "Copy",
            "Secondary",
            "PointInTimeRestore",
            "Restore",
            "Recovery",
            "RestoreExternalBackup",
            "RestoreExternalBackupSecondary",
            "RestoreLongTermRetentionBackup",
            "OnlineSecondary"
          ],
          "x-ms-enum": {
            "name": "CreateMode",
            "modelAsString": true,
            "values": [
              {
                "name": "Default",
                "value": "Default",
                "description": "Default"
              },
              {
                "name": "Copy",
                "value": "Copy",
                "description": "Copy"
              },
              {
                "name": "Secondary",
                "value": "Secondary",
                "description": "Secondary"
              },
              {
                "name": "PointInTimeRestore",
                "value": "PointInTimeRestore",
                "description": "PointInTimeRestore"
              },
              {
                "name": "Restore",
                "value": "Restore",
                "description": "Restore"
              },
              {
                "name": "Recovery",
                "value": "Recovery",
                "description": "Recovery"
              },
              {
                "name": "RestoreExternalBackup",
                "value": "RestoreExternalBackup",
                "description": "RestoreExternalBackup"
              },
              {
                "name": "RestoreExternalBackupSecondary",
                "value": "RestoreExternalBackupSecondary",
                "description": "RestoreExternalBackupSecondary"
              },
              {
                "name": "RestoreLongTermRetentionBackup",
                "value": "RestoreLongTermRetentionBackup",
                "description": "RestoreLongTermRetentionBackup"
              },
              {
                "name": "OnlineSecondary",
                "value": "OnlineSecondary",
                "description": "OnlineSecondary"
              }
            ]
          }
        },
        "collation": {
          "type": "string",
          "description": "The collation of the database.",
          "x-ms-mutability": [
            "read",
            "create"
          ]
        },
        "maxSizeBytes": {
          "type": "integer",
          "format": "int64",
          "description": "The max size of the database expressed in bytes."
        },
        "sampleName": {
          "type": "string",
          "description": "The name of the sample schema to apply when creating this database.",
          "enum": [
            "AdventureWorksLT",
            "WideWorldImportersStd",
            "WideWorldImportersFull"
          ],
          "x-ms-enum": {
            "name": "SampleName",
            "modelAsString": true,
            "values": [
              {
                "name": "AdventureWorksLT",
                "value": "AdventureWorksLT",
                "description": "AdventureWorksLT"
              },
              {
                "name": "WideWorldImportersStd",
                "value": "WideWorldImportersStd",
                "description": "WideWorldImportersStd"
              },
              {
                "name": "WideWorldImportersFull",
                "value": "WideWorldImportersFull",
                "description": "WideWorldImportersFull"
              }
            ]
          }
        },
        "elasticPoolId": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource identifier of the elastic pool containing this database.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.Sql/servers/elasticPools"
              }
            ]
          }
        },
        "sourceDatabaseId": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource identifier of the source database associated with create operation of this database.",
          "x-ms-mutability": [
            "create"
          ]
        },
        "status": {
          "type": "string",
          "description": "The status of the database.",
          "enum": [
            "Online",
            "Restoring",
            "RecoveryPending",
            "Recovering",
            "Suspect",
            "Offline",
            "Standby",
            "Shutdown",
            "EmergencyMode",
            "AutoClosed",
            "Copying",
            "Creating",
            "Inaccessible",
            "OfflineSecondary",
            "Pausing",
            "Paused",
            "Resuming",
            "Scaling",
            "OfflineChangingDwPerformanceTiers",
            "OnlineChangingDwPerformanceTiers",
            "Disabled",
            "Stopping",
            "Stopped",
            "Starting"
          ],
          "x-ms-enum": {
            "name": "DatabaseStatus",
            "modelAsString": true,
            "values": [
              {
                "name": "Online",
                "value": "Online",
                "description": "Online"
              },
              {
                "name": "Restoring",
                "value": "Restoring",
                "description": "Restoring"
              },
              {
                "name": "RecoveryPending",
                "value": "RecoveryPending",
                "description": "RecoveryPending"
              },
              {
                "name": "Recovering",
                "value": "Recovering",
                "description": "Recovering"
              },
              {
                "name": "Suspect",
                "value": "Suspect",
                "description": "Suspect"
              },
              {
                "name": "Offline",
                "value": "Offline",
                "description": "Offline"
              },
              {
                "name": "Standby",
                "value": "Standby",
                "description": "Standby"
              },
              {
                "name": "Shutdown",
                "value": "Shutdown",
                "description": "Shutdown"
              },
              {
                "name": "EmergencyMode",
                "value": "EmergencyMode",
                "description": "EmergencyMode"
              },
              {
                "name": "AutoClosed",
                "value": "AutoClosed",
                "description": "AutoClosed"
              },
              {
                "name": "Copying",
                "value": "Copying",
                "description": "Copying"
              },
              {
                "name": "Creating",
                "value": "Creating",
                "description": "Creating"
              },
              {
                "name": "Inaccessible",
                "value": "Inaccessible",
                "description": "Inaccessible"
              },
              {
                "name": "OfflineSecondary",
                "value": "OfflineSecondary",
                "description": "OfflineSecondary"
              },
              {
                "name": "Pausing",
                "value": "Pausing",
                "description": "Pausing"
              },
              {
                "name": "Paused",
                "value": "Paused",
                "description": "Paused"
              },
              {
                "name": "Resuming",
                "value": "Resuming",
                "description": "Resuming"
              },
              {
                "name": "Scaling",
                "value": "Scaling",
                "description": "Scaling"
              },
              {
                "name": "OfflineChangingDwPerformanceTiers",
                "value": "OfflineChangingDwPerformanceTiers",
                "description": "OfflineChangingDwPerformanceTiers"
              },
              {
                "name": "OnlineChangingDwPerformanceTiers",
                "value": "OnlineChangingDwPerformanceTiers",
                "description": "OnlineChangingDwPerformanceTiers"
              },
              {
                "name": "Disabled",
                "value": "Disabled",
                "description": "Disabled"
              },
              {
                "name": "Stopping",
                "value": "Stopping",
                "description": "Stopping"
              },
              {
                "name": "Stopped",
                "value": "Stopped",
                "description": "Stopped"
              },
              {
                "name": "Starting",
                "value": "Starting",
                "description": "Starting"
              }
            ]
          }
        },
        "databaseId": {
          "$ref": "#/$defs/tenantId"
        },
        "creationDate": {
          "type": "string",
          "format": "date-time",
          "description": "The creation date of the database (ISO8601 format).",
          "readOnly": true
        },
        "currentServiceObjectiveName": {
          "type": "string",
          "description": "The current service level objective name of the database.",
          "readOnly": true
        },
        "requestedServiceObjectiveName": {
          "type": "string",
          "description": "The requested service level objective name of the database.",
          "readOnly": true
        },
        "defaultSecondaryLocation": {
          "type": "string",
          "description": "The default secondary region for this database.",
          "readOnly": true
        },
        "failoverGroupId": {
          "type": "string",
          "description": "Failover Group resource identifier that this database belongs to.",
          "readOnly": true
        },
        "restorePointInTime": {
          "type": "string",
          "format": "date-time",
          "description": "Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.",
          "x-ms-mutability": [
            "create"
          ]
        },
        "sourceDatabaseDeletionDate": {
          "type": "string",
          "format": "date-time",
          "description": "Specifies the time that the database was deleted.",
          "x-ms-mutability": [
            "create"
          ]
        },
        "recoveryServicesRecoveryPointId": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource identifier of the recovery point associated with create operation of this database.",
          "x-ms-mutability": [
            "create"
          ]
        },
        "longTermRetentionBackupResourceId": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource identifier of the long term retention backup associated with create operation of this database.",
          "x-ms-mutability": [
            "create"
          ],
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.Sql/locations/longTermRetentionBackups"
              }
            ]
          }
        },
        "recoverableDatabaseId": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource identifier of the recoverable database associated with create operation of this database.",
          "x-ms-mutability": [
            "create"
          ]
        },
        "restorableDroppedDatabaseId": {
          "type": "string",
          "format": "arm-id",
          "description": "The resource identifier of the restorable dropped database associated with create operation of this database.",
          "x-ms-mutability": [
            "create"
          ]
        },
        "catalogCollation": {
          "type": "string",
          "description": "Collation of the metadata catalog.",
          "enum": [
            "DATABASE_DEFAULT",
            "SQL_Latin1_General_CP1_CI_AS"
          ],
          "x-ms-enum": {
            "name": "CatalogCollationType",
            "modelAsString": true,
            "values": [
              {
                "name": "DATABASE_DEFAULT",
                "value": "DATABASE_DEFAULT",
                "description": "DATABASE_DEFAULT"
              },
              {
                "name": "SQL_Latin1_General_CP1_CI_AS",
                "value": "SQL_Latin1_General_CP1_CI_AS",
                "description": "SQL_Latin1_General_CP1_CI_AS"
              }
            ]
          }
        },
        "zoneRedundant": {
          "type": "boolean",
          "description": "Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones."
        },
        "licenseType": {
          "type": "string",
          "description": "The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit.",
          "enum": [
            "LicenseIncluded",
            "BasePrice"
          ],
          "x-ms-enum": {
            "name": "DatabaseLicenseType",
            "modelAsString": true,
            "values": [
              {
                "name": "LicenseIncluded",
                "value": "LicenseIncluded",
                "description": "LicenseIncluded"
              },
              {
                "name": "BasePrice",
                "value": "BasePrice",
                "description": "BasePrice"
              }
            ]
          }
        },
        "maxLogSizeBytes": {
          "type": "integer",
          "format": "int64",
          "description": "The max log size for this database.",
          "readOnly": true
        },
        "earliestRestoreDate": {
          "type": "string",
          "format": "date-time",
          "description": "This records the earliest start date and time that restore is available for this database (ISO8601 format).",
          "readOnly": true
        },
        "readScale": {
          "type": "string",
          "description": "The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "x-ms-enum": {
            "name": "DatabaseReadScale",
            "modelAsString": true,
            "values": [
              {
                "name": "Enabled",
                "value": "Enabled",
                "description": "Enabled"
              },
              {
                "name": "Disabled",
                "value": "Disabled",
                "description": "Disabled"
              }
            ]
          }
        },
        "highAvailabilityReplicaCount": {
          "type": "integer",
          "format": "int32",
          "description": "The number of secondary replicas associated with the Business Critical, Premium, or Hyperscale edition database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool."
        },
        "secondaryType": {
          "type": "string",
          "description": "The secondary type of the database if it is a secondary.  Valid values are Geo, Named and Standby.",
          "enum": [
            "Geo",
            "Named",
            "Standby"
          ],
          "x-ms-enum": {
            "name": "SecondaryType",
            "modelAsString": true,
            "values": [
              {
                "name": "Geo",
                "value": "Geo",
                "description": "Geo"
              },
              {
                "name": "Named",
                "value": "Named",
                "description": "Named"
              },
              {
                "name": "Standby",
                "value": "Standby",
                "description": "Standby"
              }
            ]
          }
        },
        "currentSku": {
          "$ref": "#/$defs/sku"
        },
        "autoPauseDelay": {
          "type": "integer",
          "format": "int32",
          "description": "Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled"
        },
        "currentBackupStorageRedundancy": {
          "type": "string",
          "description": "The storage account type used to store backups for this database.",
          "enum": [
            "Geo",
            "Local",
            "Zone",
            "GeoZone"
          ],
          "x-ms-enum": {
            "name": "BackupStorageRedundancy",
            "modelAsString": true,
            "values": [
              {
                "name": "Geo",
                "value": "Geo",
                "description": "Geo"
              },
              {
                "name": "Local",
                "value": "Local",
                "description": "Local"
              },
              {
                "name": "Zone",
                "value": "Zone",
                "description": "Zone"
              },
              {
                "name": "GeoZone",
                "value": "GeoZone",
                "description": "GeoZone"
              }
            ]
          }
        },
        "requestedBackupStorageRedundancy": {
          "$ref": "#/$defs/currentBackupStorageRedundancy"
        },
        "minCapacity": {
          "type": "number",
          "format": "double",
          "description": "Minimal capacity that database will always have allocated, if not paused"
        },
        "pausedDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.",
          "readOnly": true
        },
        "resumedDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.",
          "readOnly": true
        },
        "maintenanceConfigurationId": {
          "type": "string",
          "description": "Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur."
        },
        "isLedgerOn": {
          "type": "boolean",
          "description": "Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created."
        },
        "isInfraEncryptionEnabled": {
          "type": "boolean",
          "description": "Infra encryption is enabled for this database.",
          "readOnly": true
        },
        "federatedClientId": {
          "$ref": "#/$defs/tenantId"
        },
        "keys": {
          "type": "object",
          "description": "The resource ids of the user assigned identities to use",
          "additionalProperties": {
            "type": "object",
            "description": "Database level key used for encryption at rest.",
            "properties": {
              "type": {
                "type": "string",
                "description": "The database key type. Only supported value is 'AzureKeyVault'.",
                "enum": [
                  "AzureKeyVault"
                ],
                "x-ms-enum": {
                  "name": "DatabaseKeyType",
                  "modelAsString": true,
                  "values": [
                    {
                      "name": "AzureKeyVault",
                      "value": "AzureKeyVault",
                      "description": "AzureKeyVault"
                    }
                  ]
                }
              },
              "thumbprint": {
                "type": "string",
                "description": "Thumbprint of the database key.",
                "readOnly": true
              },
              "creationDate": {
                "type": "string",
                "format": "date-time",
                "description": "The database key creation date.",
                "readOnly": true
              },
              "subregion": {
                "type": "string",
                "description": "Subregion of the server key.",
                "readOnly": true
              },
              "keyVersion": {
                "type": "string",
                "description": "The database key's version.",
                "readOnly": true
              }
            }
          }
        },
        "encryptionProtector": {
          "type": "string",
          "description": "The azure key vault URI of the database if it's configured with per Database Customer Managed Keys."
        },
        "preferredEnclaveType": {
          "type": "string",
          "description": "Type of enclave requested on the database i.e. Default or VBS enclaves.",
          "enum": [
            "Default",
            "VBS"
          ],
          "x-ms-enum": {
            "name": "AlwaysEncryptedEnclaveType",
            "modelAsString": true,
            "values": [
              {
                "name": "Default",
                "value": "Default",
                "description": "Default"
              },
              {
                "name": "VBS",
                "value": "VBS",
                "description": "VBS"
              }
            ]
          }
        },
        "useFreeLimit": {
          "type": "boolean",
          "description": "Whether or not the database uses free monthly limits. Allowed on one database in a subscription."
        },
        "freeLimitExhaustionBehavior": {
          "type": "string",
          "description": "Specifies the behavior when monthly free limits are exhausted for the free database.\n\nAutoPause: The database will be auto paused upon exhaustion of free limits for remainder of the month.\n\nBillForUsage: The database will continue to be online upon exhaustion of free limits and any overage will be billed.",
          "enum": [
            "AutoPause",
            "BillOverUsage"
          ],
          "x-ms-enum": {
            "name": "FreeLimitExhaustionBehavior",
            "modelAsString": true,
            "values": [
              {
                "name": "AutoPause",
                "value": "AutoPause",
                "description": "AutoPause"
              },
              {
                "name": "BillOverUsage",
                "value": "BillOverUsage",
                "description": "BillOverUsage"
              }
            ]
      

# --- truncated at 32 KB (36 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-sql-database/json-schema/microsoft-azure-sql-database-database-list-result-schema.json