[new module] azure_rm_sqlserver_facts (#34608)

* updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts * updates to azure_rm_sqlserver_facts
7 years ago · ade02bcce5
parent 9aba711519
commit ade02bcce5
4 changed files with 312 additions and 0 deletions
--- a/lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py
+++ b/lib/ansible/modules/cloud/azure/azure_rm_sqlserver_facts.py
@ -0,0 +1,203 @@
+#!/usr/bin/python
+#
+# Copyright (c) 2017 Zim Kalinowski, <zikalino@microsoft.com>
+#
+# 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
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = '''
+---
+module: azure_rm_sqlserver_facts
+version_added: "2.5"
+short_description: Get SQL Server facts.
+description:
+    - Get facts of SQL 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
+    server_name:
+        description:
+            - The name of the server.
+
+extends_documentation_fragment:
+    - azure
+
+author:
+    - "Zim Kalinowski (@zikalino)"
+
+'''
+
+EXAMPLES = '''
+  - name: Get instance of SQL Server
+    azure_rm_sqlserver_facts:
+      resource_group: resource_group_name
+      server_name: server_name
+
+  - name: List instances of SQL Server
+    azure_rm_sqlserver_facts:
+      resource_group: resource_group_name
+'''
+
+RETURN = '''
+servers:
+    description: A list of dict results where the key is the name of the SQL Server and the values are the facts for that SQL Server.
+    returned: always
+    type: complex
+    contains:
+        sqlserver_name:
+            description: The key is the name of the server that the values relate to.
+            type: complex
+            contains:
+                id:
+                    description:
+                        - Resource ID.
+                    returned: always
+                    type: str
+                    sample: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645
+                name:
+                    description:
+                        - Resource name.
+                    returned: always
+                    type: str
+                    sample: sqlcrudtest-4645
+                type:
+                    description:
+                        - Resource type.
+                    returned: always
+                    type: str
+                    sample: Microsoft.Sql/servers
+                location:
+                    description:
+                        - Resource location.
+                    returned: always
+                    type: str
+                    sample: japaneast
+                kind:
+                    description:
+                        - Kind of sql server. This is metadata used for the Azure portal experience.
+                    returned: always
+                    type: str
+                    sample: v12.0
+                version:
+                    description:
+                        - The version of the server.
+                    returned: always
+                    type: str
+                    sample: 12.0
+                state:
+                    description:
+                        - The state of the server.
+                    returned: always
+                    type: str
+                    sample: Ready
+                fully_qualified_domain_name:
+                    description:
+                        - The fully qualified domain name of the server.
+                    returned: always
+                    type: str
+                    sample: fully_qualified_domain_name
+'''
+
+from ansible.module_utils.azure_rm_common import AzureRMModuleBase
+
+try:
+    from msrestazure.azure_exceptions import CloudError
+    from msrestazure.azure_operation import AzureOperationPoller
+    from azure.mgmt.sql import SqlManagementClient
+    from msrest.serialization import Model
+except ImportError:
+    # This is handled in azure_rm_common
+    pass
+
+
+class AzureRMServersFacts(AzureRMModuleBase):
+    def __init__(self):
+        # define user inputs into argument
+        self.module_arg_spec = dict(
+            resource_group=dict(
+                type='str',
+                required=True
+            ),
+            server_name=dict(
+                type='str'
+            )
+        )
+        # store the results of the module operation
+        self.results = dict(
+            changed=False,
+            ansible_facts=dict()
+        )
+        self.mgmt_client = None
+        self.resource_group = None
+        self.server_name = None
+        super(AzureRMServersFacts, self).__init__(self.module_arg_spec)
+
+    def exec_module(self, **kwargs):
+        for key in self.module_arg_spec:
+            setattr(self, key, kwargs[key])
+        self.mgmt_client = self.get_mgmt_svc_client(SqlManagementClient,
+                                                    base_url=self._cloud_environment.endpoints.resource_manager)
+
+        if (self.resource_group is not None and
+                self.server_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):
+        '''
+        Gets facts of the specified SQL Server.
+
+        :return: deserialized SQL Serverinstance state dictionary
+        '''
+        response = None
+        results = {}
+        try:
+            response = self.mgmt_client.servers.get(resource_group_name=self.resource_group,
+                                                    server_name=self.server_name)
+            self.log("Response : {0}".format(response))
+        except CloudError as e:
+            self.log('Could not get facts for Servers.')
+
+        if response is not None:
+            results[response.name] = response.as_dict()
+
+        return results
+
+    def list_by_resource_group(self):
+        '''
+        Gets facts of the specified SQL Server.
+
+        :return: deserialized SQL Serverinstance state dictionary
+        '''
+        response = None
+        results = {}
+        try:
+            response = self.mgmt_client.servers.list_by_resource_group(resource_group_name=self.resource_group)
+            self.log("Response : {0}".format(response))
+        except CloudError as e:
+            self.log('Could not get facts for Servers.')
+
+        if response is not None:
+            for item in response:
+                results[item.name] = item.as_dict()
+
+        return results
+
+
+def main():
+    AzureRMServersFacts()
+if __name__ == '__main__':
+    main()
--- a/test/integration/targets/azure_rm_sqlserver_facts/aliases
+++ b/test/integration/targets/azure_rm_sqlserver_facts/aliases
@ -0,0 +1,3 @@
+cloud/azure
+destructive
+posix/ci/cloud/group2/azure
--- a/test/integration/targets/azure_rm_sqlserver_facts/meta/main.yml
+++ b/test/integration/targets/azure_rm_sqlserver_facts/meta/main.yml
@ -0,0 +1,2 @@
+dependencies:
+  - setup_azure
--- a/test/integration/targets/azure_rm_sqlserver_facts/tasks/main.yml
+++ b/test/integration/targets/azure_rm_sqlserver_facts/tasks/main.yml
@ -0,0 +1,104 @@
+- name: Prepare random number
+  set_fact:
+    rpfx: "{{ 1000 | random }}{{ resource_group | hash('md5') | truncate(7, True, '') }}"
+  run_once: yes
+
+- name: Create SQL Server
+  azure_rm_sqlserver:
+    resource_group: "{{ resource_group }}"
+    name: "sqlsrv{{ rpfx }}"
+    location: eastus
+    admin_username: mylogin
+    admin_password: Testpasswordxyz12!
+
+- name: Create SQL Server - 2
+  azure_rm_sqlserver:
+    resource_group: "{{ resource_group }}"
+    name: "sqlsrv{{ rpfx }}x"
+    location: eastus
+    admin_username: mylogin
+    admin_password: Testpasswordxyz12!
+
+- name: Gather facts SQL Server
+  azure_rm_sqlserver_facts:
+    resource_group: "{{ resource_group }}"
+    server_name: "sqlsrv{{ rpfx }}"
+  register: output
+- name: Assert that facts are returned
+  assert:
+    that:
+      - output.changed == False
+      - output.servers.sqlsrv{{ rpfx }}.id != None
+      - output.servers.sqlsrv{{ rpfx }}.name == "sqlsrv{{ rpfx }}"
+      - output.servers.sqlsrv{{ rpfx }}.type != None
+      - output.servers.sqlsrv{{ rpfx }}.location != None
+      - output.servers.sqlsrv{{ rpfx }}.kind != None
+      - output.servers.sqlsrv{{ rpfx }}.version != None
+      - output.servers.sqlsrv{{ rpfx }}.state != None
+      - output.servers.sqlsrv{{ rpfx }}.fully_qualified_domain_name != None
+
+- name: Gather facts SQL Server - second
+  azure_rm_sqlserver_facts:
+    resource_group: "{{ resource_group }}"
+    server_name: "sqlsrv{{ rpfx }}x"
+  register: output
+- name: Assert that facts are returned
+  assert:
+    that:
+      - output.changed == False
+      - output.servers.sqlsrv{{ rpfx }}x.id != None
+      - output.servers.sqlsrv{{ rpfx }}x.name == "sqlsrv{{ rpfx }}x"
+      - output.servers.sqlsrv{{ rpfx }}x.type != None
+      - output.servers.sqlsrv{{ rpfx }}x.location != None
+      - output.servers.sqlsrv{{ rpfx }}x.kind != None
+      - output.servers.sqlsrv{{ rpfx }}x.version != None
+      - output.servers.sqlsrv{{ rpfx }}x.state != None
+      - output.servers.sqlsrv{{ rpfx }}x.fully_qualified_domain_name != None
+
+- name: Gather facts SQL Server - unexisting
+  azure_rm_sqlserver_facts:
+    resource_group: "{{ resource_group }}"
+    server_name: "unexisting"
+  register: output
+- name: Assert that facts are returned
+  assert:
+    that:
+      - output.changed == False
+      - output.servers == {}
+
+- name: Gather facts SQL Server - list
+  azure_rm_sqlserver_facts:
+    resource_group: "{{ resource_group }}"
+  register: output
+- name: Assert that facts are returned
+  assert:
+    that:
+      - output.changed == False
+      - output.servers.sqlsrv{{ rpfx }}.id != None
+      - output.servers.sqlsrv{{ rpfx }}.name == "sqlsrv{{ rpfx }}"
+      - output.servers.sqlsrv{{ rpfx }}.type != None
+      - output.servers.sqlsrv{{ rpfx }}.location != None
+      - output.servers.sqlsrv{{ rpfx }}.kind != None
+      - output.servers.sqlsrv{{ rpfx }}.version != None
+      - output.servers.sqlsrv{{ rpfx }}.state != None
+      - output.servers.sqlsrv{{ rpfx }}.fully_qualified_domain_name != None
+      - output.servers.sqlsrv{{ rpfx }}x.id != None
+      - output.servers.sqlsrv{{ rpfx }}x.name == "sqlsrv{{ rpfx }}x"
+      - output.servers.sqlsrv{{ rpfx }}x.type != None
+      - output.servers.sqlsrv{{ rpfx }}x.location != None
+      - output.servers.sqlsrv{{ rpfx }}x.kind != None
+      - output.servers.sqlsrv{{ rpfx }}x.version != None
+      - output.servers.sqlsrv{{ rpfx }}x.state != None
+      - output.servers.sqlsrv{{ rpfx }}x.fully_qualified_domain_name != None
+
+- name: Delete instance of SQL Server
+  azure_rm_sqlserver:
+    resource_group: "{{ resource_group }}"
+    name: "sqlsrv{{ rpfx }}"
+    state: absent
+
+- name: Delete instance of SQL Server
+  azure_rm_sqlserver:
+    resource_group: "{{ resource_group }}"
+    name: "sqlsrv{{ rpfx }}x"
+    state: absent