azure.azcollection.azure_rm_postgresqlflexibleserver module – Manage PostgreSQL Flexible Server instance

Note

This module is part of the azure.azcollection collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_postgresqlflexibleserver.

New in azure.azcollection 2.2.0

Synopsis

  • Create, update and delete instance of PostgreSQL Flexible Server.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

Comments

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

administrator_login

string

The administrator’s login name of a server.

Can only be specified when the server is being created (and is required for creation).

administrator_login_password

string

The administrator login password (required for server creation).

api_profile

string

added in azure.azcollection 0.0.1

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

Default: "latest"

append_tags

boolean

Use to control if tags field is canonical or just appends to existing tags.

When canonical, any tags not found in the tags parameter will be removed from the object’s metadata.

Choices:

  • false

  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

availability_zone

string

Availability zone information of the server

backup

dictionary

Backup properties of a server.

backup_retention_days

integer

Backup retention days for the server.

geo_redundant_backup

string

A value indicating whether Geo-Redundant backup is enabled on the server.

Choices:

  • "Enabled"

  • "Disabled"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

Default: "AzureCloud"

create_mode

string

The mode to create a new PostgreSQL server.

Choices:

  • "Default"

  • "Create"

  • "Update"

  • "PointInTimeRestore"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.

Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

fully_qualified_domain_name

string

The fully qualified domain name of a server.

high_availability

dictionary

High availability properties of a server.

mode

string

The HA mode for the server.

Choices:

  • "Disabled"

  • "ZoneRedundant"

standby_availability_zone

string

Availability zone information of the standby.

identity

dictionary

added in azure.azcollection 2.4.0

Identity for the Server.

type

string

Type of the managed identity

Choices:

  • "UserAssigned"

  • "None" ← (default)

user_assigned_identities

dictionary

User Assigned Managed Identities and its options

Default: {}

append

boolean

If the list of identities has to be appended to current identities (true) or if it has to replace current identities (false)

Choices:

  • false

  • true ← (default)

id

list / elements=string

List of the user assigned identities IDs associated to the VM

Default: []

is_restart

boolean

Whether to restart the Post gresql server.

Choices:

  • false ← (default)

  • true

is_start

boolean

Whether to start the Post gresql server.

Choices:

  • false ← (default)

  • true

is_stop

boolean

Whether to stop the Post gresql server.

Choices:

  • false ← (default)

  • true

location

string

Resource location. If not set, location from the resource group will be used as default.

log_mode

string

Parent argument.

log_path

string

Parent argument.

maintenance_window

dictionary

Maintenance window properties of a server.

custom_window

string

Indicates whether custom window is enabled or disabled.

day_of_week

integer

Day of week for maintenance window.

start_hour

integer

Start hour for maintenance window.

start_minute

integer

Start minute for maintenance window.

name

string / required

The name of the flexible server.

network

dictionary

Network properties of a server.

delegated_subnet_resource_id

string

Delegated subnet arm resource id.

private_dns_zone_arm_resource_id

string

Private dns zone arm resource id.

public_network_access

string

Public network access is enabled or not.

Choices:

  • "Enabled"

  • "Disabled"

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

point_in_time_utc

string

Restore point creation time (ISO8601 format), specifying the time to restore from.

It’s required when create_mode=PointInTimeRestore.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

The name of the resource group that contains the resource.

You can obtain this value from the Azure Resource Manager API or the portal.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

sku

dictionary

The SKU (pricing tier) of the server.

name

string / required

The name of the sku, typically, tier + family + cores, such as Standard_D4s_v3.

tier

string / required

The tier of the particular

Choices:

  • "Burstable"

  • "GeneralPurpose"

  • "MemoryOptimized"

source_server_resource_id

string

The source server resource ID to restore from.

It’s required when create_mode=PointInTimeRestore

state

string

Assert the state of the PostgreSQL Flexible server.

Use present to create or update a server and absent to delete it.

Choices:

  • "present" ← (default)

  • "absent"

storage

dictionary

Storage properties of a server.

storage_size_gb

integer

The storage size for the server.

subscription_id

string

Your Azure subscription Id.

tags

dictionary

Dictionary of string:string pairs to assign as metadata to the object.

Metadata tags on the object will be updated with any provided values.

To remove tags set append_tags option to false.

Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag.

Azure Front Door doesn’t support the use of

Azure Automation and Azure CDN only support 15 tags on resources.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

version

string

PostgreSQL Server version.

Choices:

  • "11"

  • "12"

  • "13"

  • "14"

  • "15"

  • "16"

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create (or update) PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: Standard_B1ms
      tier: Burstable
    administrator_login: azureuser
    administrator_login_password: Fred@0329
    version: 12
    storage:
      storage_size_gb: 128
    fully_qualified_domain_name: st-private-dns-zone.postgres.database.azure.com
    backup:
      backup_retention_days: 7
      geo_redundant_backup: Disabled
    maintenance_window:
      custom_window: Enabled
      start_hour: 8
      start_minute: 0
      day_of_week: 0
    point_in_time_utc: 2023-05-31T00:28:17.7279547+00:00
    availability_zone: 1
    create_mode: Default

- name: Delete PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver:
    resource_group: myResourceGroup
    name: testserver
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

servers

complex

A list of dictionaries containing facts for PostgreSQL Flexible servers.

Returned: always

administrator_login

string

The administrator’s login name of a server.

Returned: always

Sample: "azureuser"

availability_zone

string

Availability zone information of the server.

Returned: always

Sample: "1"

backup

complex

Backup properties of a server.

Returned: always

backup_retention_days

integer

Backup retention days for the server.

Returned: always

Sample: 7

geo_redundant_backup

string

A value indicating whether Geo-Redundant backup is enabled on the server.

Returned: always

Sample: "Disabled"

fully_qualified_domain_name

string

The fully qualified domain name of the flexible server.

Returned: always

Sample: "postflexiblefredpgsqlflexible.postgres.database.azure.com"

high_availability

complex

High availability properties of a server.

Returned: always

mode

string

The HA mode for the server.

Returned: always

Sample: "Disabled"

standby_availability_zone

string

availability zone information of the standby.

Returned: always

id

string

Resource ID of the postgresql flexible server.

Returned: always

Sample: "/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleservers/postgresql3"

location

string

The location the resource resides in.

Returned: always

Sample: "eastus"

maintenance_window

complex

Maintenance window properties of a server.

Returned: always

custom_window

string

Indicates whether custom window is enabled or disabled.

Returned: always

Sample: "Enabled"

day_of_week

integer

Day of week for maintenance window.

Returned: always

Sample: 0

start_hour

integer

Start hour for maintenance window.

Returned: always

Sample: 8

start_minute

integer

Start minute for maintenance window.

Returned: always

Sample: 0

name

string

Resource name.

Returned: always

Sample: "postgreabdud1223"

network

complex

Network properties of a server.

Returned: always

delegated_subnet_resource_id

string

Delegated subnet arm resource id.

Returned: always

private_dns_zone_arm_resource_id

string

Private dns zone arm resource id.

Returned: always

public_network_access

string

Public network access is enabled or not.

Returned: always

Sample: "Enabled"

point_in_time_utc

string

Restore point creation time (ISO8601 format).

Returned: always

resource_group

string

Resource group name.

Returned: always

Sample: "myResourceGroup"

sku

complex

The SKU of the server.

Returned: always

name

string

The name of the SKU.

Returned: always

Sample: "Standard_B1ms"

tier

string

The tier of the particular SKU.

Returned: always

Sample: "Burstable"

source_server_resource_id

string

The source server resource ID to restore from.

Returned: always

storage

complex

The maximum storage allowed for a server.

Returned: always

storage_size_gb

integer

ax storage allowed for a server.

Returned: always

Sample: 128

system_data

complex

The system metadata relating to this resource.

Returned: always

created_at

string

The timestamp of resource creation (UTC).

Returned: always

created_by

string

The identity that created the resource.

Returned: always

created_by_type

string

The type of identity that created the resource.

Returned: always

last_modified_at

string

The timestamp of resource last modification (UTC).

Returned: always

last_modified_by

string

The identity that last modified the resource.

Returned: always

last_modified_by_type

string

The type of identity that last modified the resource.

Returned: always

tags

dictionary

Tags assigned to the resource. Dictionary of string:string pairs.

Returned: always

Sample: {"tag1": "abc"}

version

string

Flexible Server version.

Returned: always

Can only return:

  • "11"

  • "12"

  • "13"

Sample: "12"

Authors

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)