azure_rm_postgresqlserver - Manage PostgreSQL Server instance.¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

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
azure >= 2.0.0

Parameters ¶

Parameter		Choices/Defaults	Comments
ad_user			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url (added in 2.6)		Default: None	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
admin_password			The password of the administrator login.
admin_username			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 (added in 2.5)		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.
auth_source (added in 2.5)		Choices: auto cli credential_file env msi	Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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.
cert_validation_mode (added in 2.5)		Choices: validate ignore	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			Azure client ID. Use when authenticating with a Service Principal.
cloud_environment (added in 2.4)		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		Default: Default	Create mode of SQL Server
enforce_ssl bool		Choices: no ← yes	Enable SSL enforcement.
location			Resource location. If not set, location from the resource group will be used as default.
name required			The name of the server.
password			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile			Security profile found in ~/.azure/credentials file.
resource_group 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			Azure client secret. Use when authenticating with a Service Principal.
sku			The SKU (pricing tier) of the server.
	tier	Choices: basic standard	The tier of the particular SKU, e.g. Basic.
	capacity		The scale up/out capacity, representing server's compute units.
	name		The name of the sku, typically, a letter + Number code, e.g. P3.
	size		The size code, to be interpreted by resource as appropriate.
state		Choices: present ← absent	Assert the state of the PostgreSQL server. Use 'present' to create or update a server and 'absent' to delete it.
storage_mb			The maximum storage allowed for a server.
subscription_id			Your Azure subscription Id.
tenant			Azure tenant ID. Use when authenticating with a Service Principal.
version		Choices: 9.5 9.6	Server version.

Notes ¶

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Examples ¶

- name: Create (or update) PostgreSQL Server
  azure_rm_postgresqlserver:
    resource_group: TestGroup
    name: testserver
    sku:
      name: GP_Gen4_2
      tier: GeneralPurpose
      capacity: 2
    location: eastus
    storage_mb: 1024
    enforce_ssl: 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 str	always	The fully qualified domain name of a server. Sample: postgresqlsrv1b6dd89593.postgresql.database.azure.com
id str	always	Resource ID Sample: /subscriptions/12345678-1234-1234-1234-123412341234/resourceGroups/samplerg/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593
state str	always	A state of a server that is visible to user. Possible values include: `Ready`, `Dropping`, `Disabled` Sample: Ready
version str	always	Server version. Possible values include: `9.5`, `9.6` Sample: 9.6

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation you can edit this document to improve it.