#!/usr/bin/python # # Copyright (c) 2019 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_devtestlab version_added: "0.1.2" short_description: Manage Azure DevTest Lab instance description: - Create, update and delete instance of Azure DevTest Lab. options: resource_group: description: - The name of the resource group. required: True type: str name: description: - The name of the lab. required: True type: str location: description: - The location of the resource. type: str storage_type: description: - Type of storage used by the lab. It can be either C(premium) or C(standard). type: str choices: - 'standard' - 'premium' premium_data_disks: description: - Allow creation of premium data disks. type: bool state: description: - Assert the state of the DevTest Lab. - Use C(present) to create or update an DevTest Lab and C(absent) to delete it. default: present type: str choices: - absent - present extends_documentation_fragment: - azure.azcollection.azure - azure.azcollection.azure_tags author: - Zim Kalinowski (@zikalino) ''' EXAMPLES = ''' - name: Create (or update) DevTest Lab azure_rm_devtestlab: resource_group: myResourceGroup name: mylab storage_type: standard ''' RETURN = ''' id: description: - The identifier of the resource. returned: always type: str sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/mylab ''' from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase from ansible.module_utils.common.dict_transformations import _snake_to_camel try: from azure.core.polling import LROPoller from azure.core.exceptions import ResourceNotFoundError from azure.mgmt.devtestlabs import DevTestLabsClient except ImportError: # This is handled in azure_rm_common pass class Actions: NoAction, Create, Update, Delete = range(4) class AzureRMDevTestLab(AzureRMModuleBase): """Configuration class for an Azure RM DevTest Lab resource""" def __init__(self): self.module_arg_spec = dict( resource_group=dict( type='str', required=True ), name=dict( type='str', required=True ), location=dict( type='str' ), storage_type=dict( type='str', choices=['standard', 'premium'] ), premium_data_disks=dict( type='bool' ), state=dict( type='str', default='present', choices=['present', 'absent'] ) ) self.resource_group = None self.name = None self.lab = {} self.results = dict(changed=False) self.mgmt_client = None self.state = None self.to_do = Actions.NoAction super(AzureRMDevTestLab, self).__init__(derived_arg_spec=self.module_arg_spec, supports_check_mode=True, supports_tags=True) def exec_module(self, **kwargs): """Main module execution method""" for key in list(self.module_arg_spec.keys()) + ['tags']: if hasattr(self, key): setattr(self, key, kwargs[key]) elif kwargs[key] is not None: self.lab[key] = kwargs[key] if self.lab.get('storage_type'): self.lab['lab_storage_type'] = _snake_to_camel(self.lab['storage_type'], True) self.lab.pop('storage_type', None) if self.lab.get('premium_data_disks') is not None: self.lab['premium_data_disks'] = 'Enabled' if self.lab['premium_data_disks'] else 'Disabled' response = None self.mgmt_client = self.get_mgmt_svc_client(DevTestLabsClient, base_url=self._cloud_environment.endpoints.resource_manager, api_version='2018-10-15') resource_group = self.get_resource_group(self.resource_group) if self.lab.get('location') is None: self.lab['location'] = resource_group.location old_response = self.get_devtestlab() if not old_response: self.log("DevTest Lab instance doesn't exist") if self.state == 'absent': self.log("Old instance didn't exist") else: self.to_do = Actions.Create else: self.log("DevTest Lab instance already exists") if self.state == 'absent': self.to_do = Actions.Delete elif self.state == 'present': if self.lab.get('lab_storage_type') is not None and \ self.lab.get('lab_storage_type').lower() != old_response.get('lab_storage_type', '').lower(): self.to_do = Actions.Update if (self.lab.get('premium_data_disks') is not None and self.lab.get('premium_data_disks').lower() != old_response.get('premium_data_disks').lower()): self.to_do = Actions.Update if (self.to_do == Actions.Create) or (self.to_do == Actions.Update): self.log("Need to Create / Update the DevTest Lab instance") self.results['changed'] = True if self.check_mode: return self.results response = self.create_update_devtestlab() self.log("Creation / Update done") elif self.to_do == Actions.Delete: self.log("DevTest Lab instance deleted") self.results['changed'] = True if self.check_mode: return self.results self.delete_devtestlab() # This currently doesnt' work as there is a bug in SDK / Service if isinstance(response, LROPoller): response = self.get_poller_result(response) else: self.log("DevTest Lab instance unchanged") self.results['changed'] = False response = old_response if self.state == 'present': self.results.update({ 'id': response.get('id', None) }) return self.results def create_update_devtestlab(self): ''' Creates or updates DevTest Lab with the specified configuration. :return: deserialized DevTest Lab instance state dictionary ''' self.log("Creating / Updating the DevTest Lab instance {0}".format(self.name)) try: response = self.mgmt_client.labs.begin_create_or_update(resource_group_name=self.resource_group, name=self.name, lab=self.lab) if isinstance(response, LROPoller): response = self.get_poller_result(response) except Exception as exc: self.log('Error attempting to create the DevTest Lab instance.') self.fail("Error creating the DevTest Lab instance: {0}".format(str(exc))) return response.as_dict() def delete_devtestlab(self): ''' Deletes specified DevTest Lab instance in the specified subscription and resource group. :return: True ''' self.log("Deleting the DevTest Lab instance {0}".format(self.name)) try: response = self.mgmt_client.labs.begin_delete(resource_group_name=self.resource_group, name=self.name) except Exception as e: self.log('Error attempting to delete the DevTest Lab instance.') self.fail("Error deleting the DevTest Lab instance: {0}".format(str(e))) return True def get_devtestlab(self): ''' Gets the properties of the specified DevTest Lab. :return: deserialized DevTest Lab instance state dictionary ''' self.log("Checking if the DevTest Lab instance {0} is present".format(self.name)) found = False try: response = self.mgmt_client.labs.get(resource_group_name=self.resource_group, name=self.name) found = True self.log("Response : {0}".format(response)) self.log("DevTest Lab instance : {0} found".format(response.name)) except ResourceNotFoundError as e: self.log('Did not find the DevTest Lab instance.') if found is True: return response.as_dict() return False def main(): """Main execution""" AzureRMDevTestLab() if __name__ == '__main__': main()