azure_postgresql_server resource

Use the azure_postgresql_server InSpec audit resource to test the properties and configuration of an Azure PostgreSql server.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

resource_group and name, or the resource_id are required parameters.

describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do
  it { should exist }
end

describe azure_postgresql_server(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}') do
  it { should exist }
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

name

Name of the PostgreSql server to test.

server_name

Alias for the name parameter.

resource_id

The unique resource ID.

configurations_api_version

The endpoint API version for the configurations property. The latest version will be used unless provided.

Either one of the parameter sets can be provided for a valid query:

• resource_id
• resource_group and name
• resource_group and server_name

Properties

configurations

An object containing all the configurations of a DB server available through configurations endpoint. Configuration values can be accessed as follows, configurations.client_encoding.properties.value, configurations.deadlock_timeout.properties.value, and so on.

sku

The SKU (pricing tier) of the server.

firewall_rules

An object of firewall rules applied on postgresql server.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.). For example, properties.<attribute>.

Examples

Test the administrator’s login name of a PostgreSql server:

describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do
  its('properties.administratorLogin') { should cmp 'admin' }
end

Test the fully qualified domain name of a PostgreSql server:

describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'i-dont-exist') do
  its('properties.fullyQualifiedDomainName') { should cmp 'pgtestsvc1.postgres.database.azure.com' }
end

Test the client encoding configuration value of a PostgreSql server:

describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do
  its('configurations.client_encoding.properties.value') { should cmp 'sql_ascii' }
end

Test the deadlock timeout configuration value of a PostgreSql server:

describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do
  its('configurations.deadlock_timeout.properties.value') { should cmp '1000' }
end

Test a PostgreSql server’s location and maximum replica capacity:

describe azure_postgresql_server(resource_id: '/subscriptions/.../my-server') do
  its('properties.replicaCapacity') { should cmp 2 }
  its('location') { should cmp 'westeurope' }
end

Test a PostgreSql server’s firewall rules:

describe azure_postgresql_server(resource_id: '/subscriptions/.../my-server') do
  its('firewall_rules') { should eq {} }
end

Matchers

This resource has the following special matchers.

exists

# If we expect a resource to always exist.

describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do
  it { should exist }
end

not_exists

# If we expect a resource to never exist.

describe azure_postgresql_server(resource_group: 'RESOURCE_GROUP', name: 'SERVER_NAME') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.