Resolved ansible-collections#210 Recovery Service Vault

plugins/modules/azure_rm_recoveryservicesvault.py

@@ -0,0 +1,285 @@
+#!/usr/bin/python
+#
+# Copyright (c) 2020 Suyeb Ansari (@suyeb786)
+#
+# 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_recoveryservicesvault
+version_added: '1.1.0'
+short_description: Create and Update Azure Recovery Services vault
+description:
+    - Create Azure Recovery Services vault.
+    - Update Azure Recovery Services vault.
+options:
+    resource_group:
+        description:
+            - The name of the resource group.
+        required: true
+        type: str
+    recovery_service_vault_name:
+        description:
+            - The name of the Azure Recovery Service Vault.
+        required: true
+        type: str
+    location:
+        description:
+            - Azure Resource location.
+        required: true
+        type: str
+    enhanced_security_state:
+        description:
+            - Backup Policy ID present under Recovery Service Vault mentioned in recovery_vault_name field.
+        default: Enabled
+        type: str
+        choices:
+            - Enabled
+            - Disabled
+    soft_delete_feature_state:
+        description:
+            - Backup Policy ID present under Recovery Service Vault mentioned in recovery_vault_name field.
+        default: Enabled
+        type: str
+        choices:
+            - Enabled
+            - Disabled
+    state:
+        description:
+            - Assert the state of the protection item.
+            - Use C(create) for Creating Azure Recovery Services Vault.
+            - Use C(update) for Updating Azure Recovery Services Vault Soft Delete State.
+        default: create
+        type: str
+        choices:
+            - create
+            - update
+extends_documentation_fragment:
+    - azure.azcollection.azure
+    - azure.azcollection.azure_tags
+author:
+    - Suyeb Ansari ( @suyeb786 )
+'''
+
+EXAMPLES = '''
+    - name: Create Azure Recovery Services vault
+      azure_rm_recoveryservicesvault:
+        resource_group: 'myResourceGroup'
+        recovery_service_vault_name: 'testVault'
+        location: 'westeurope'
+        state: 'create'
+    - name: Update Azure Recovery Services vault
+      azure_rm_recoveryservicesvault:
+        resource_group: 'myResourceGroup'
+        recovery_service_vault_name: 'testVault'
+        location: 'westeurope'
+        enhanced_security_state: 'Enabled'
+        soft_delete_feature_state: "Disabled"
+        state: 'update'
+'''
+
+RETURN = '''
+id:
+    description:
+        - Azure Recovery Service Vault Details.
+    returned: always
+    type: str
+    sample: '{"response":{"location":"resource_location","name":"recovery_vault_name","properties":{},"id":"vault_id"}}'
+'''
+
+from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common_rest import GenericRestClient
+from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common_ext import AzureRMModuleBaseExt
+import re
+import json
+import time
+try:
+    from msrestazure.azure_exceptions import CloudError
+except ImportError:
+    # This is handled in azure_rm_common
+    pass
+
+class azure_rm_recoveryservicesvault(AzureRMModuleBaseExt):
+    def __init__(self):
+        self.module_arg_spec = dict(
+            resource_group=dict(
+                type='str',
+                required=True
+            ),
+            recovery_service_vault_name=dict(
+                type='str',
+                required=True
+            ),
+            location=dict(
+                type='str',
+                required=True
+            ),
+            enhanced_security_state=dict(
+                type='str',
+                default='Disabled',
+                choices=['Enabled', 'Disabled']
+            ),
+            soft_delete_feature_state=dict(
+                type='str',
+                default='Enabled',
+                choices=['Enabled', 'Disabled']
+            ),
+            state=dict(
+                type='str',
+                default='create',
+                choices=['create', 'update']
+            )
+        )
+
+        self.resource_group = None
+        self.recovery_service_vault_name = None
+        self.location = None
+        self.enhanced_security_state = None
+        self.soft_delete_feature_state = None
+        self.state = None
+
+        self.results = dict(changed=False)
+        self.mgmt_client = None
+        self.url = None
+        self.status_code = [200, 201, 202, 204]
+
+        self.body = {}
+        self.query_parameters = {}
+        self.query_parameters['api-version'] = None
+        self.header_parameters = {}
+        self.header_parameters['Content-Type'] = 'application/json; charset=utf-8'
+
+        super(azure_rm_recoveryservicesvault, self).__init__(derived_arg_spec=self.module_arg_spec,
+                                            supports_check_mode=True,
+                                            supports_tags=True)
+
+    def get_api_version(self):
+        return '2016-06-01' if self.state == 'create' else '2019-05-13'
+
+    def get_url(self):
+        if self.state == 'create':
+            return '/subscriptions/' \
+                   + self.subscription_id \
+                   + '/resourceGroups/' \
+                   + self.resource_group \
+                   + '/providers/Microsoft.RecoveryServices' \
+                   + '/vaults' + '/' \
+                   + self.recovery_service_vault_name
+        if self.state == 'update':
+            return '/subscriptions/' \
+                   + self.subscription_id \
+                   + '/resourceGroups/' \
+                   + self.resource_group \
+                   + '/providers/Microsoft.RecoveryServices' \
+                   + '/vaults' + '/' \
+                   + self.recovery_service_vault_name \
+                   + "/backupconfig/vaultconfig"
+
+    def get_body(self):
+        if self.state == 'create':
+            return {
+                "properties": {},
+                "sku": {
+                    "name": "Standard"  #The SKU is always "Standard".
+                    },
+                "location": self.location
+            }
+        elif self.state == 'update':
+            return {
+                "properties": {
+                "enhancedSecurityState": self.enhanced_security_state,
+                "softDeleteFeatureState": self.soft_delete_feature_state
+                    }
+                }
+        else:
+            return {}
+
+    def exec_module(self, **kwargs):
+        for key in list(self.module_arg_spec.keys()):
+            if hasattr(self, key):
+                setattr(self, key, kwargs[key])
+            elif kwargs[key] is not None:
+                self.body[key] = kwargs[key]
+
+        self.inflate_parameters(self.module_arg_spec, self.body, 0)
+
+        self.query_parameters['api-version'] = self.get_api_version()
+        self.url = self.get_url()
+        self.body = self.get_body()
+        old_response = None
+        response = None
+
+        self.mgmt_client = self.get_mgmt_svc_client(GenericRestClient,
+                                                    base_url=self._cloud_environment.endpoints.resource_manager)
+
+        changed = False
+        if self.state == 'create':
+            changed = True
+            response = self.create_recovery_service_vault()
+        if self.state == 'update':
+            changed = True
+            response = self.update_recovery_service_vault()
+
+        self.results['response'] = response
+        self.results['changed'] = changed
+
+        return self.results
+
+    def create_recovery_service_vault(self):
+        # self.log('Creating Recovery Service Vault Name {0}'.format(self.))
+        try:
+            response = self.mgmt_client.query(
+                self.url,
+                'PUT',
+                self.query_parameters,
+                self.header_parameters,
+                self.body,
+                self.status_code,
+                600,
+                30,
+            )
+        except CloudError as e:
+            self.log('Error in creating Azure Recovery Service Vault.')
+            self.fail('Error in creating Azure Recovery Service Vault {0}'.format(str(e)))
+
+        try:
+            response = json.loads(response.text)
+        except Exception:
+            response = {'text': response.text}
+
+        return response
+
+    def update_recovery_service_vault(self):
+        # self.log('Updating Recovery Service Vault Name {0}'.format(self.))
+        try:
+            response = self.mgmt_client.query(
+                self.url,
+                'PATCH',
+                self.query_parameters,
+                self.header_parameters,
+                self.body,
+                self.status_code,
+                600,
+                30,
+            )
+        except CloudError as e:
+            self.log('Error attempting to update Azure Recovery Service Vault.')
+            self.fail('Error while updating Azure Recovery Service Vault Name: {0}'.format(str(e)))
+
+        try:
+            response = json.loads(response.text)
+        except Exception:
+            response = {'text': response.text}
+        return response
+
+def main():
+    azure_rm_recoveryservicesvault()
+
+if __name__ == '__main__':
+    main()