azurerm_postgresql_database resource

[edit on GitHub]

Use the azurerm_postgresql_database InSpec audit resource to test properties and configuration of an Azure PostgreSQL Database on a PostgreSQL Server.

Azure REST API version

This resource interacts with version 2017-12-01 of the Azure Management API. For more information see the Official Azure Documentation.

At the moment, there doesn’t appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version.

Availability

Installation

This resource is available in the inspec-azure resourcepack. To use it, add the following to your inspec.yml in your top-level profile:

depends:
  inspec-azure:
    git: https://github.com/inspec/inspec-azure.git

You’ll also need to setup your Azure credentials; see the resource pack README.

Version

This resource first became available in 1.7.0 of the inspec-azure resource pack.

Syntax

The resource_group, server_name and database_name must be given as a parameter.

describe azurerm_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', database_name: 'order-db') do
  it { should exist }
end

Examples

If a PostgreSQL Database is referenced with a valid Resource Group, Server Name and Database name

describe azurerm_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', database_name: 'order-db') do
  it            { should exist }
  its('name')   { should be 'order-db' }
end

If a PostgreSQL Database is referenced with an invalid Resource Group, Server Name or Database Name

describe azurerm_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', database_name: 'invalid-db-name') do
  it { should_not exist }
end

Parameters

• resource_group - The resource Group to which the PostgreSQL Server belongs.
• server_name - The unique name of the PostgreSQL Server.
• database_name - The unique name of the PostgreSQL Database.

Attributes

• id
• name
• type
• properties

id

Azure resource ID.

name

SQL Server name, e.g. customer-database.

type

The type of Resource, typically Microsoft.DBforPostgreSQL/servers/databases.

properties

A collection of additional configuration properties related to the PostgreSQL Database, e.g. collation.

Other Attributes

There are additional attributes that may be accessed that we have not documented. Please take a look at the Azure documentation. Any attribute in the response may be accessed with the key names separated by dots (.).

The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If you find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you’ll be able to guard against nil keys. Pull requests are always welcome.

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

describe azurerm_postgresql_database(resource_group: 'my-rg', server_name: 'server-name-1', database_name: 'customer-db') do
  it { should exist }
end

Azure Permissions

Your ServicePrincipal must be setup with a contributor role on the subscription you wish to test.