#!/usr/bin/python # # Copyright (c) 2017 Zim Kalinowski, # # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: azure_rm_postgresqlserver_info version_added: "0.1.2" short_description: Get Azure PostgreSQL Server facts description: - Get facts of PostgreSQL Server. options: resource_group: description: - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. required: True type: str name: description: - The name of the server. type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. type: list elements: str extends_documentation_fragment: - azure.azcollection.azure author: - Zim Kalinowski (@zikalino) ''' EXAMPLES = ''' - name: Get instance of PostgreSQL Server azure_rm_postgresqlserver_info: resource_group: myResourceGroup name: server_name - name: List instances of PostgreSQL Server azure_rm_postgresqlserver_info: resource_group: myResourceGroup tags: - key ''' RETURN = ''' servers: description: - A list of dictionaries containing facts for PostgreSQL servers. returned: always type: complex contains: id: description: - Resource ID. returned: always type: str sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/po stgreabdud1223" resource_group: description: - Resource group name. returned: always type: str sample: myResourceGroup name: description: - Resource name. returned: always type: str sample: postgreabdud1223 location: description: - The location the resource resides in. returned: always type: str sample: eastus sku: description: - The SKU of the server. returned: always type: complex contains: name: description: - The name of the SKU. returned: always type: str sample: GP_Gen4_2 tier: description: - The tier of the particular SKU. returned: always type: str sample: GeneralPurpose capacity: description: - The scale capacity. returned: always type: int sample: 2 storage_mb: description: - The maximum storage allowed for a server. returned: always type: int sample: 128000 enforce_ssl: description: - Enable SSL enforcement. returned: always type: bool sample: False admin_username: description: - The administrator's login name of a server. returned: always type: str sample: serveradmin version: description: - Server version. returned: always type: str sample: "9.6" user_visible_state: description: - A state of a server that is visible to user. returned: always type: str sample: Ready fully_qualified_domain_name: description: - The fully qualified domain name of a server. returned: always type: str sample: postgreabdud1223.postgres.database.azure.com backup_retention_days: description: - Backup retention period between 7 and 35 days. 7 days by default if not set. returned: always type: int sample: 7 geo_redundant_backup: description: - Choose between locally redundant(default) or geo-redundant backup. This cannot be updated after first deployment. returned: always type: str sample: Disabled tags: description: - Tags assigned to the resource. Dictionary of string:string pairs. type: dict sample: { tag1: abc } ''' try: from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase from azure.core.exceptions import ResourceNotFoundError except ImportError: # This is handled in azure_rm_common pass class AzureRMPostgreSqlServersInfo(AzureRMModuleBase): def __init__(self): # define user inputs into argument self.module_arg_spec = dict( resource_group=dict( type='str', required=True ), name=dict( type='str' ), tags=dict( type='list', elements='str' ) ) # store the results of the module operation self.results = dict( changed=False ) self.resource_group = None self.name = None self.tags = None super(AzureRMPostgreSqlServersInfo, self).__init__(self.module_arg_spec, supports_check_mode=True, supports_tags=False, facts_module=True) def exec_module(self, **kwargs): is_old_facts = self.module._name == 'azure_rm_postgresqlserver_facts' if is_old_facts: self.module.deprecate("The 'azure_rm_postgresqlserver_facts' module has been renamed to 'azure_rm_postgresqlserver_info'", version=(2.9, )) for key in self.module_arg_spec: setattr(self, key, kwargs[key]) if (self.resource_group is not None and self.name is not None): self.results['servers'] = self.get() elif (self.resource_group is not None): self.results['servers'] = self.list_by_resource_group() return self.results def get(self): response = None results = [] try: response = self.postgresql_client.servers.get(resource_group_name=self.resource_group, server_name=self.name) self.log("Response : {0}".format(response)) except ResourceNotFoundError as e: self.log('Could not get facts for PostgreSQL Server.') if response and self.has_tags(response.tags, self.tags): results.append(self.format_item(response)) return results def list_by_resource_group(self): response = None results = [] try: response = self.postgresql_client.servers.list_by_resource_group(resource_group_name=self.resource_group) self.log("Response : {0}".format(response)) except Exception as e: self.log('Could not get facts for PostgreSQL Servers.') if response is not None: for item in response: if self.has_tags(item.tags, self.tags): results.append(self.format_item(item)) return results def format_item(self, item): d = item.as_dict() d = { 'id': d['id'], 'resource_group': self.resource_group, 'name': d['name'], 'sku': d['sku'], 'location': d['location'], 'storage_mb': d['storage_profile']['storage_mb'], 'storage_autogrow': (d['storage_profile']['storage_autogrow'] == 'Enabled'), 'version': d['version'], 'enforce_ssl': (d['ssl_enforcement'] == 'Enabled'), 'admin_username': d['administrator_login'], 'user_visible_state': d['user_visible_state'], 'fully_qualified_domain_name': d['fully_qualified_domain_name'], 'geo_redundant_backup': d['storage_profile']['geo_redundant_backup'], 'backup_retention_days': d['storage_profile']['backup_retention_days'], 'tags': d.get('tags') } return d def main(): AzureRMPostgreSqlServersInfo() if __name__ == '__main__': main()