Docs4dev
Docs
ansible / latest / collections / azure / azcollection / azure_rm_postgresqlserver_module.html

azure.azcollection.azure_rm_postgresqlserver – Manage PostgreSQL Server instance

Note

This plugin is part of the azure.azcollection collection (version 1.10.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.

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

New in version 0.1.2: of azure.azcollection

Synopsis

  • Create, update and delete instance of PostgreSQL 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-azure.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 Choices/Defaults 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 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
admin_password
string
The password of the administrator login.
admin_username
string
The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
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.
append_tags
boolean
    Choices:
  • no
  • yes ←
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.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
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.
backup_retention_days
integer
Backup retention period between 7 and 35 days. 7 days by default if not set
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
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.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"AzureCloud"
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.
create_mode
string
    Choices:
  • default ←
  • geo_restore
  • point_in_time_restore
Create mode of SQL Server. Blank (default), restore from geo redundant (geo_restore), or restore from point in time (point_in_time_restore).
enforce_ssl
boolean
    Choices:
  • no ←
  • yes
Enable SSL enforcement.
geo_redundant_backup
boolean
    Choices:
  • no ←
  • yes
Choose between locally redundant(default) or geo-redundant backup. This cannot be updated after first deployment
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.
name
string / required
The name of the server.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
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.
restore_point_in_time
string
Restore point creation time (ISO8601 format), specifying the time to restore from.
Required if create_mode=point_in_time_restore.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
sku
dictionary
The SKU (pricing tier) of the server.
capacity
string
The scale up/out capacity, representing server's compute units.
name
string
The name of the SKU, typically, tier + family + cores, for example B_Gen4_1, GP_Gen5_8.
size
string
The size code, to be interpreted by resource as appropriate.
tier
string
    Choices:
  • Basic
  • Standard
The tier of the particular SKU, for example Basic.
source_server_id
string
Id if the source server if create_mode=default.
state
string
    Choices:
  • present ←
  • absent
Assert the state of the PostgreSQL server. Use present to create or update a server and absent to delete it.
storage_autogrow
boolean
    Choices:
  • no ←
  • yes
Enable storage autogrow.
storage_mb
integer
The maximum storage allowed for a 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.
version
string
    Choices:
  • 9.5
  • 9.6
  • 10
  • 11
Server version.

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 Server
  azure_rm_postgresqlserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: B_Gen5_1
      tier: Basic
    location: eastus
    storage_mb: 1024
    enforce_ssl: True
    storage_autogrow: True
    admin_username: cloudsa
    admin_password: password

Return Values

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

Key Returned Description
fully_qualified_domain_name
string
always
The fully qualified domain name of a server.

Sample:
postgresqlsrv1b6dd89593.postgresql.database.azure.com
id
string
always
Resource ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593
state
string
always
A state of a server that is visible to user. Possible values include Ready, Dropping, Disabled.

Sample:
Ready
version
string
always
Server version. Possible values include 9.5, 9.6, 10, 11.

Sample:
9.6


Authors

  • Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_postgresqlserver_module.html