» azurerm_postgresql_server

Manages a PostgreSQL Server.

» Example Usage

resource "azurerm_resource_group" "test" {
  name     = "api-rg-pro"
  location = "West Europe"
}

resource "azurerm_postgresql_server" "test" {
  name                = "postgresql-server-1"
  location            = "${azurerm_resource_group.test.location}"
  resource_group_name = "${azurerm_resource_group.test.name}"

  sku {
    name     = "B_Gen5_2"
    capacity = 2
    tier     = "Basic"
    family   = "Gen4"
  }

  storage_profile {
    storage_mb            = 5120
    backup_retention_days = 7
    geo_redundant_backup  = "Disabled"
    auto_grow             = "Enabled"
  }

  administrator_login          = "psqladminun"
  administrator_login_password = "H@Sh1CoR3!"
  version                      = "9.5"
  ssl_enforcement              = "Enabled"
}

» Argument Reference

The following arguments are supported:

  • name - (Required) Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.

  • resource_group_name - (Required) The name of the resource group in which to create the PostgreSQL Server. Changing this forces a new resource to be created.

  • location - (Required) Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • sku - (Required) A sku block as defined below.

  • storage_profile - (Required) A storage_profile block as defined below.

  • administrator_login - (Required) The Administrator Login for the PostgreSQL Server. Changing this forces a new resource to be created.

  • administrator_login_password - (Required) The Password associated with the administrator_login for the PostgreSQL Server.

  • version - (Required) Specifies the version of PostgreSQL to use. Valid values are 9.5, 9.6, 10, 10.0, and 11. Changing this forces a new resource to be created.

  • ssl_enforcement - (Required) Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.

  • tags - (Optional) A mapping of tags to assign to the resource.


sku supports the following:

  • name - (Required) Specifies the SKU Name for this PostgreSQL Server. The name of the SKU, follows the tier + family + cores pattern (e.g. B_Gen4_1, GP_Gen5_8). For more information see the product documentation.

  • capacity - (Required) The scale up/out capacity, representing server's compute units.

  • tier - (Required) The tier of the particular SKU. Possible values are Basic, GeneralPurpose, and MemoryOptimized. For more information see the product documentation.

  • family - (Required) The family of hardware Gen4 or Gen5, before selecting your family check the product documentation for availability in your region.


storage_profile supports the following:

  • storage_mb - (Required) Max storage allowed for a server. Possible values are between 5120 MB(5GB) and 1048576 MB(1TB) for the Basic SKU and between 5120 MB(5GB) and 4194304 MB(4TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation.

  • backup_retention_days - (Optional) Backup retention days for the server, supported values are between 7 and 35 days.

  • geo_redundant_backup - (Optional) Enable/Disable Geo-redundant for server backup. Valid values for this property are Enabled or Disabled, not supported for the basic tier. This allows you to choose between locally redundant or geo-redundant backup storage in the General Purpose and Memory Optimized tiers. When the backups are stored in geo-redundant backup storage, they are not only stored within the region in which your server is hosted, but are also replicated to a paired data center. This provides better protection and ability to restore your server in a different region in the event of a disaster. The Basic tier only offers locally redundant backup storage.

  • auto_grow - (Optional) Enable/Disable auto-growing of the storage. Valid values for this property are Enabled or Disabled. Storage auto-grow prevents your server from running out of storage and becoming read-only. If storage auto grow is enabled, the storage automatically grows without impacting the workload. The default value if not explicitly specified is Enabled.

» Attributes Reference

The following attributes are exported:

  • id - The ID of the PostgreSQL Server.

  • fqdn - The FQDN of the PostgreSQL Server.

» Import

PostgreSQL Server's can be imported using the resource id, e.g.

terraform import azurerm_postgresql_server.server1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.DBforPostgreSQL/servers/server1