Skip to content

Latest commit

 

History

History
97 lines (75 loc) · 4.44 KB

azure_postgresql_database.md

File metadata and controls

97 lines (75 loc) · 4.44 KB
Raw
title platform
About the azure_postgresql_database Resource
azure

azure_postgresql_database

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

Azure REST API version, endpoint and http client parameters

This resource interacts with api versions supported by the resource provider. The api_version can be defined as a resource parameter. If not provided, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

resource_group, server_name and name or the resource_id must be given as a parameter.

describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do
  it { should exist }
end
describe azure_postgresql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}') do
  it { should exist }
end

Parameters

Name Description
resource_group Azure resource group that the targeted resource resides in. MyResourceGroup
server_name The name of the server on which the database resides. serverName
name The unique name of the database. databaseName
database_name Alias for the name parameter.
resource_id The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}

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

  • resource_id
  • resource_group, server_name, and name
  • resource_group, server_name, and database_name

Properties

Property Description
properties.charset The charset of the database.

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

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test the Name of a Resource

describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do
  its('name')   { should be 'order-db' }
end
describe azure_postgresql_database(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/order-db') do
  its('name')   { should be 'order-db' }
end

Matchers

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

exists

# If we expect the resource to always exist
describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do
  it { should exist }
end

# If we expect the resource to never exist
describe azure_postgresql_database(resource_group: 'inspec-rg', server_name: 'customer_server', name: 'order-db') do
  it { should_not exist }
end

Azure Permissions

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