#!/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_devtestlabenvironment_facts version_added: "2.8" short_description: Get Azure Environment facts description: - Get facts of Azure Environment. options: resource_group: description: - The name of the resource group. required: True lab_name: description: - The name of the lab. required: True user_name: description: - The name of the user profile. required: True name: description: - The name of the environment. 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: Get instance of Environment azure_rm_devtestlabenvironment_facts: resource_group: myResourceGroup lab_name: myLab user_name: myUser name: myEnvironment ''' RETURN = ''' environments: description: - A list of dictionaries containing facts for Environment. returned: always type: complex contains: id: description: - The identifier of the artifact source. returned: always type: str sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/sc hedules/xxxxxxxx-xxxx-xxxx-xxxxx-xxxxxxxxxxxxx/environments/myEnvironment" resource_group: description: - Name of the resource group. returned: always type: str sample: myResourceGroup lab_name: description: - Name of the lab. returned: always type: str sample: myLab name: description: - The name of the environment. returned: always type: str sample: myEnvironment deployment_template: description: - The identifier of the artifact source. returned: always type: str sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/mylab/art ifactSources/public environment repo/armTemplates/WebApp" resource_group_id: description: - Target resource group id. returned: always type: str sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myLab-myEnvironment-982571" state: description: - Deployment state. returned: always type: str sample: Succeeded 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 AzureRMDtlEnvironmentFacts(AzureRMModuleBase): def __init__(self): # define user inputs into argument self.module_arg_spec = dict( resource_group=dict( type='str', required=True ), lab_name=dict( type='str', required=True ), user_name=dict( type='str', required=True ), 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.lab_name = None self.user_name = None self.name = None self.tags = None super(AzureRMDtlEnvironmentFacts, 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.name: self.results['environments'] = self.get() else: self.results['environments'] = self.list() return self.results def get(self): response = None results = [] try: response = self.mgmt_client.environments.get(resource_group_name=self.resource_group, lab_name=self.lab_name, user_name=self.user_name, name=self.name) self.log("Response : {0}".format(response)) except CloudError as e: self.log('Could not get facts for Environment.') if response and self.has_tags(response.tags, self.tags): results.append(self.format_response(response)) return results def list(self): response = None results = [] try: response = self.mgmt_client.environments.list(resource_group_name=self.resource_group, lab_name=self.lab_name, user_name=self.user_name) self.log("Response : {0}".format(response)) except CloudError as e: self.log('Could not get facts for Environment.') 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 format_response(self, item): d = item.as_dict() d = { 'resource_group': self.resource_group, 'lab_name': self.lab_name, 'name': d.get('name'), 'user_name': self.user_name, 'id': d.get('id', None), 'deployment_template': d.get('deployment_properties', {}).get('arm_template_id'), 'location': d.get('location'), 'provisioning_state': d.get('provisioning_state'), 'resource_group_id': d.get('resource_group_id'), 'tags': d.get('tags', None) } return d def main(): AzureRMDtlEnvironmentFacts() if __name__ == '__main__': main()