Database for PostgreSQL Component

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Overview

You can use the Database for PostgreSQL component to represent and visualize PostgreSQL databases from your Azure environment.

Screenshot of an isometric Cloudcraft diagram showing interconnected Azure components.

Toolbar

Use the toolbar to configure and customize the component. The following options are available:

  • Color: Select accent and fill colors for the body of the component in 3D view.
  • Deployment option: Select the type of deployment for your database.
  • Tier: Select the performance tier of your database.
  • Instance: Select the instance type of your database. Changing the instance type changes the hardware details shown in the toolbar to reflect what is used by the hypervisor.
  • High availability: Select a high availability option for your database. Only available for when Deployment option is set to Flexible server.
  • Storage (GiB): Enter the total volume of storage available for your database in gibibytes.

API

Use the Cloudcraft API to programmatically access and render your architecture diagrams as JSON objects. The following is an example JSON object of a Database for Postgresql component:

Schema

{
	"type": "azurepostgresql",
	"id": "db7da7f6-9d1a-46df-808c-6979e02d5182",
	"region": "northcentralus",
	"mapPos": [5,0],
	"deploymentOption": "Single",
	"tier": "GeneralPurpose",
	"instance": "GP_Gen5_2",
	"storageMB": 20480,
	"haEnabled": false,
	"backupRetention": 7,
	"color": {
		"isometric": null,
		"2d": null
	},
	"accentColor": {
		"isometric": null,
		"2d": null
	},
	"link": "https://azure.microsoft.com/products/postgresql",
	"locked": true
}
  • type: string: The type of component. Must be a string of value azurepostgresql for this component.
  • id: string, uuid: The unique identifier for the component. The API uses a UUID v4 internally but accepts any unique string.
  • resourceId: string: The globally unique identifier for the component within Azure.
  • region: string: The Azure region for the component. The API supports all global regions, except China.
  • mapPos: array: The position of the component in the blueprint. The API uses a unique X and Y coordinate pair to express positioning.
  • deploymentOption: string: The type of deployment for the database. Defaults to Single.
  • tier: string: The database performance tier. Defaults to GeneralPurpose.
  • instance: string: The instance type for the database. Defaults to GP_Gen5_2.
  • storageMB: string: The total volume of storage available for the database in megabytes. Defaults to 20480.
  • haEnabled: boolean: Whether high availability is enabled. Defaults to false.
  • color: object: The fill color for the component body.
    • isometric: string: A hexadecimal color for the component body in 3D view. Defaults to #CEE0F5.
    • 2d: string: A hexadecimal color for the component body in 2D view. Defaults to null.
  • accentColor: object: The accent color for the component logo.
    • isometric: string: A hexadecimal color for the component logo in 3D view. Defaults to #0078D4.
    • 2d: string: A hexadecimal color for the component logo in 2D view. Defaults to null.
  • link: string, uri: A URI that links the component to another diagram or an external website. Accepts one of two formats, blueprint:// or https://.
  • locked: boolean: Whether to allow changes to the position of the component through the web interface. Defaults to false.