diff --git a/lib/ansible/modules/cloud/azure/azure_rm_devtestlab.py b/lib/ansible/modules/cloud/azure/azure_rm_devtestlab.py index 21112b73b9f..000c88e596d 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_devtestlab.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_devtestlab.py @@ -41,7 +41,7 @@ options: - 'premium' premium_data_disks: description: - - "Allow creation of C(premium) data disks." + - "Allow creation of premium data disks." type: bool state: description: diff --git a/lib/ansible/modules/cloud/azure/azure_rm_devtestlab_facts.py b/lib/ansible/modules/cloud/azure/azure_rm_devtestlab_facts.py new file mode 100644 index 00000000000..533ad2a0205 --- /dev/null +++ b/lib/ansible/modules/cloud/azure/azure_rm_devtestlab_facts.py @@ -0,0 +1,264 @@ +#!/usr/bin/python +# +# Copyright (c) 2019 Zim Kalinowski, (@zikalino) +# +# 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_devtestlab_facts +version_added: "2.8" +short_description: Get Azure DevTest Lab facts. +description: + - Get facts of Azure DevTest Lab. + +options: + resource_group: + description: + - The name of the resource group. + name: + description: + - The name of the lab. + tags: + description: + - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. + +extends_documentation_fragment: + - azure + +author: + - "Zim Kalinowski (@zikalino)" +''' + +EXAMPLES = ''' + - name: List instances of DevTest Lab by resource group + azure_rm_devtestlab_facts: + resource_group: testrg + + - name: List instances of DevTest Lab in subscription + azure_rm_devtestlab_facts: + + - name: Get instance of DevTest Lab + azure_rm_devtestlab_facts: + resource_group: testrg + name: testlab +''' + +RETURN = ''' +labs: + description: A list of dictionaries containing facts for Lab. + returned: always + type: complex + contains: + id: + description: + - The identifier of the resource. + returned: always + type: str + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/microsoft.devtestlab/labs/testlab + resource_group: + description: + - The name of the resource. + returned: always + type: str + sample: testrg + name: + description: + - The name of the resource. + returned: always + type: str + sample: testlab + location: + description: + - The location of the resource. + returned: always + type: str + sample: eastus + storage_type: + description: + - Lab storage type. + returned: always + type: str + sample: standard + premium_data_disks: + description: + - Are premium data disks allowed. + returned: always + type: bool + sample: false + provisioning_state: + description: + - Lab provisioning state. + returned: always + type: str + sample: Succeeded + artifacts_storage_account: + description: + - Artifacts storage account ID. + returned: always + type: str + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/testlab6346 + default_premium_storage_account: + description: + - Default premium storage account ID. + returned: always + type: str + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/testlab6346 + default_storage_account: + description: + - Default storage account ID. + returned: always + type: str + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/testlab6346 + premium_data_disk_storage_account: + description: + - Default storage account ID. + returned: always + type: str + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/testlab6346 + vault_name: + description: + - Key vault ID. + returned: always + type: str + sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/testlab6788 + tags: + description: + - The tags of the resource. + returned: always + type: complex + sample: "{ 'MyTag': 'MyValue' }" +''' + +from ansible.module_utils.azure_rm_common import AzureRMModuleBase + +try: + from msrestazure.azure_exceptions import CloudError + from azure.mgmt.devtestlabs import DevTestLabsClient + from msrest.serialization import Model +except ImportError: + # This is handled in azure_rm_common + pass + + +class AzureRMDevTestLabFacts(AzureRMModuleBase): + def __init__(self): + # define user inputs into argument + self.module_arg_spec = dict( + resource_group=dict( + type='str' + ), + name=dict( + type='str' + ), + tags=dict( + type='list' + ) + ) + # store the results of the module operation + self.results = dict( + changed=False + ) + self.mgmt_client = None + self.resource_group = None + self.name = None + self.tags = None + super(AzureRMDevTestLabFacts, self).__init__(self.module_arg_spec, supports_tags=False) + + 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(DevTestLabsClient, + base_url=self._cloud_environment.endpoints.resource_manager) + + if self.resource_group is not None: + if self.name is not None: + self.results['labs'] = self.get() + else: + self.results['labs'] = self.list_by_resource_group() + else: + self.results['labs'] = self.list_by_subscription() + return self.results + + def list_by_resource_group(self): + response = None + results = [] + try: + response = self.mgmt_client.labs.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 Lab.') + + if response is not None: + for item in response: + if self.has_tags(item.tags, self.tags): + results.append(self.format_response(item)) + + return results + + def list_by_subscription(self): + response = None + results = [] + try: + response = self.mgmt_client.labs.list_by_subscription() + self.log("Response : {0}".format(response)) + except CloudError as e: + self.log('Could not get facts for Lab.') + + if response is not None: + for item in response: + if self.has_tags(item.tags, self.tags): + results.append(self.format_response(item)) + + return results + + def get(self): + response = None + results = [] + try: + response = self.mgmt_client.labs.get(resource_group_name=self.resource_group, + name=self.name) + self.log("Response : {0}".format(response)) + except CloudError as e: + self.log('Could not get facts for Lab.') + + if response and self.has_tags(response.tags, self.tags): + results.append(self.format_response(response)) + + return results + + def format_response(self, item): + d = item.as_dict() + d = { + 'id': d.get('id', None), + 'resource_group': self.resource_group, + 'name': d.get('name', None), + 'location': d.get('location', '').replace(' ', '').lower(), + 'storage_type': d.get('lab_storage_type', '').lower(), + 'premium_data_disks': d.get('premium_data_disks') == 'Enabled', + 'provisioning_state': d.get('provisioning_state'), + 'artifacts_storage_account': d.get('artifacts_storage_account'), + 'default_premium_storage_account': d.get('default_premium_storage_account'), + 'default_storage_account': d.get('default_storage_account'), + 'premium_data_disk_storage_account': d.get('premium_data_disk_storage_account'), + 'vault_name': d.get('vault_name'), + 'tags': d.get('tags', None) + } + return d + + +def main(): + AzureRMDevTestLabFacts() + + +if __name__ == '__main__': + main() diff --git a/test/integration/targets/azure_rm_devtestlab/aliases b/test/integration/targets/azure_rm_devtestlab/aliases index c1a773ecc73..5fc83a1a79d 100644 --- a/test/integration/targets/azure_rm_devtestlab/aliases +++ b/test/integration/targets/azure_rm_devtestlab/aliases @@ -2,3 +2,4 @@ cloud/azure destructive shippable/azure/group1 azure_rm_devtestlabvirtualnetwork +azure_rm_devtestlab_facts diff --git a/test/integration/targets/azure_rm_devtestlab/tasks/main.yml b/test/integration/targets/azure_rm_devtestlab/tasks/main.yml index 728857b7f39..b50e11ca14e 100644 --- a/test/integration/targets/azure_rm_devtestlab/tasks/main.yml +++ b/test/integration/targets/azure_rm_devtestlab/tasks/main.yml @@ -57,6 +57,45 @@ that: - output.changed +- name: Get DevTest Lab facts + azure_rm_devtestlab_facts: + resource_group: "{{ resource_group }}" + name: "{{ lab_name }}" + register: output +- name: Assert that facts are returned + assert: + that: + - output.changed == False + - output.labs[0]['id'] != None + - output.labs[0]['resource_group'] != None + - output.labs[0]['name'] != None + - output.labs[0]['location'] != None + - output.labs[0]['storage_type'] != None + - output.labs[0]['premium_data_disks'] != None + - output.labs[0]['provisioning_state'] != None + - output.labs[0]['artifacts_storage_account'] != None + - output.labs[0]['default_premium_storage_account'] != None + - output.labs[0]['default_storage_account'] != None + - output.labs[0]['premium_data_disk_storage_account'] != None + - output.labs[0]['vault_name'] != None + +- name: List DevTest Lab in a resource group + azure_rm_devtestlab_facts: + resource_group: "{{ resource_group }}" + register: output +- name: Assert that facts are returned + assert: + that: + - output.changed == False + - output.labs[0]['id'] != None + - output.labs[0]['resource_group'] != None + - output.labs[0]['name'] != None + - output.labs[0]['location'] != None + - output.labs[0]['storage_type'] != None + - output.labs[0]['premium_data_disks'] != None + - output.labs[0]['provisioning_state'] != None + - output.labs[0]['vault_name'] != None + - name: Create instance of DebTest Labs virtual network azure_rm_devtestlabvirtualnetwork: resource_group: "{{ resource_group }}"