Skip to content

Data Source: azurermPostgresqlServer

Use this data source to access information about an existing PostgreSQL Azure Database Server.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const dataAzurermPostgresqlServerExample =
  new azurerm.dataAzurermPostgresqlServer.DataAzurermPostgresqlServer(
    this,
    "example",
    {
      name: "postgresql-server-1",
      resource_group_name: "api-rg-pro",
    }
  );
new cdktf.TerraformOutput(this, "postgresql_server_id", {
  value: dataAzurermPostgresqlServerExample.id,
});

Argument Reference

  • name - The name of the PostgreSQL Server.

  • resourceGroupName - Specifies the name of the Resource Group where the PostgreSQL Server exists.

Attributes Reference

  • id - The ID of the PostgreSQL Server.

  • location - The location of the Resource Group in which the PostgreSQL Server exists.

  • fqdn - The fully qualified domain name of the PostgreSQL Server.

  • identity - An identity block as defined below.

  • version - The version of the PostgreSQL Server.

  • administratorLogin - The administrator username of the PostgreSQL Server.

  • skuName - The SKU name of the PostgreSQL Server.

  • tags - A mapping of tags assigned to the resource.

An identity block exports the following:

  • principalId - The ID of the System Managed Service Principal assigned to the PostgreSQL Server.

  • tenantId - The ID of the Tenant of the System Managed Service Principal assigned to the PostgreSQL Server.

  • type - The identity type of the Managed Identity assigned to the PostgreSQL Server.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the PostgreSQL Azure Database Server.