Recovery Services Vault #210 (#254)

* Resolved #234

* Adjusted code as per review comments

* Updated the main.yaml file extension and registered module in pr-pipelines.yml

* Removed azure_rm_backupazurevm_info from pr-pipelines.yaml

* Updated meta/main.yaml to meta/main.yml

* removed meta/main.yaml

* Updated module with latest review comments

* Adjusted task/main.yml as per the recommendation

* Adjusted long string with column size 80

* Update azure_rm_backupazurevm_info.py

* Update azure_rm_backupazurevm_info.py

* Updated azure_rm_backupazurevm_info with latest review comments

* Updated tests/sanity/ignore-2.xx

* Udpated tests/sanity/ignore-2.xx

* Updated ignore-2.9.txt(removed lines 186-189) and tasks/main.yml(removed extra blank line)

* Resolved #210 Recovery Service Vault

* Adjusted the state and added provision for deleting RSV

* Updated Class Name

* Adjusted the code with latest review comments

* Added new line at end of aliases main.yml files

* Adjusted tasks/main.yml

* removed line no 3 from tasks/main.yml

* Read Recovery Vault Details Pre Creation Logic Integrated

* Added idempotent test and adjusted module return type

* Adjusted code as per review comments

* '2016-06-01' is required for create, delete as per official doc

* Adjusted code as per latest review comments

* Adjusted indentation

* Removed whitespace from line 175

Co-authored-by: Suyeb Ansari <>
Co-authored-by: Fred-sun <37327967+Fred-sun@users.noreply.github.com>

plugins/modules/azure_rm_recoveryservicesvault.py

@@ -0,0 +1,319 @@
+#!/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 Delete Azure Recovery Services vault
+description:
+    - Create or Delete Azure Recovery Services vault.
+options:
+    resource_group:
+        description:
+            - The name of the resource group.
+        required: true
+        type: str
+    name:
+        description:
+            - The name of the Azure Recovery Service Vault.
+        required: true
+        type: str
+    location:
+        description:
+            - Azure Resource location.
+        required: true
+        type: str
+    state:
+        description:
+            - Assert the state of the protection item.
+            - Use C(present) for Creating Azure Recovery Service Vault.
+            - Use C(absent) for Deleting Azure Recovery Service Vault.
+        default: present
+        type: str
+        choices:
+            - present
+            - absent
+extends_documentation_fragment:
+    - azure.azcollection.azure
+    - azure.azcollection.azure_tags
+author:
+    - Suyeb Ansari (@suyeb786)
+'''
+
+EXAMPLES = '''
+    - name: Create/Update Azure Recovery Service vault
+      azure_rm_recoveryservicesvault:
+        resource_group: 'myResourceGroup'
+        name: 'testVault'
+        location: 'westeurope'
+        state: 'present'
+    - name: Delete Recovery Service Vault
+      azure_rm_recoveryservicesvault:
+        resource_group: 'myResourceGroup'
+        name: 'testVault'
+        location: 'westeurope'
+        state: 'absent'
+'''
+
+RETURN = '''
+response:
+    description:
+        - The response about the current state of the recovery services vault.
+    returned: always
+    type: complex
+    contains:
+        etag:
+            description:
+                - A unique read-only string that changes whenever the resource create.
+            returned: always
+            type: str
+            sample: "datetime'2020-09-16T02%3A44%3A27.834293Z'"
+        id:
+            description:
+                - Resource ID.
+            returned: always
+            type: str
+            sample:  "/subscriptions/xxxxxxx/resourceGroups/resourcegroup_name/ \
+            providers/Microsoft.RecoveryServices/vaults/rev_name"
+        location:
+            description:
+                - The location of the resource.
+            returned: always
+            type: str
+            sample: "eastus"
+        name:
+            description:
+                - Name of the recovery services vault name.
+            returned: always
+            type: str
+            sample: revault_name
+        properties:
+            description:
+                - The recovery service vault properties.
+            returned: always
+            type: dict
+            sample: {
+                    "privateEndpointStateForBackup": "None",
+                    "privateEndpointStateForSiteRecovery": "None",
+                    "provisioningState": "Succeeded"
+                    }
+        sku:
+            description:
+                - The sku type of the recovery service vault.
+            returned: always
+            type: str
+            sample: Standard
+        type:
+            description:
+                - The type of the recovery service vault.
+            returned: always
+            type: str
+            sample: "Microsoft.RecoveryServices/vaults"
+'''
+
+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 AzureRMRecoveryServicesVault(AzureRMModuleBaseExt):
+    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',
+                required=True
+            ),
+            state=dict(
+                type='str',
+                default='present',
+                choices=['present', 'absent']
+            )
+        )
+
+        self.resource_group = None
+        self.name = None
+        self.location = 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(AzureRMRecoveryServicesVault, 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'
+
+    def get_url(self):
+        if self.state == 'present' or self.state == 'absent':
+            return '/subscriptions/' \
+                   + self.subscription_id \
+                   + '/resourceGroups/' \
+                   + self.resource_group \
+                   + '/providers/Microsoft.RecoveryServices' \
+                   + '/vaults' + '/' \
+                   + self.name
+
+    def get_body(self):
+        if self.state == 'present':
+            return {
+                "properties": {},
+                "sku": {
+                    "name": "Standard"
+                },
+                "location": self.location
+            }
+        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)
+
+        old_response = self.get_resource()
+
+        changed = False
+        if self.state == 'present':
+            if old_response is False:
+                changed = True
+                response = self.create_recovery_service_vault()
+            else:
+                changed = False
+                response = old_response
+        if self.state == 'absent':
+            changed = True
+            response = self.delete_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 delete_recovery_service_vault(self):
+        # self.log('Deleting Recovery Service Vault {0}'.format(self.))
+        try:
+            response = self.mgmt_client.query(
+                self.url,
+                'DELETE',
+                self.query_parameters,
+                self.header_parameters,
+                None,
+                self.status_code,
+                600,
+                30,
+            )
+        except CloudError as e:
+            self.log('Error attempting to delete Azure Recovery Service Vault.')
+            self.fail('Error while deleting Azure Recovery Service Vault: {0}'.format(str(e)))
+
+        try:
+            response = json.loads(response.text)
+        except Exception:
+            response = {'text': response.text}
+        return response
+
+    def get_resource(self):
+        # self.log('Get Recovery Service Vault Name {0}'.format(self.))
+        found = False
+        try:
+            response = self.mgmt_client.query(
+                self.url,
+                'GET',
+                self.query_parameters,
+                self.header_parameters,
+                None,
+                self.status_code,
+                600,
+                30,
+            )
+            found = True
+        except CloudError as e:
+            self.log('Recovery Service Vault Does not exist.')
+        if found is True:
+            response = json.loads(response.text)
+            return response
+        else:
+            return False
+
+
+def main():
+    AzureRMRecoveryServicesVault()
+
+
+if __name__ == '__main__':
+    main()