Add new module azure_rm_account_info to get facts for current logged in user

plugins/modules/azure_rm_account_info.py

@@ -0,0 +1,224 @@
+#!/usr/bin/python
+#
+# Copyright (c) 2022 Mandar Kulkarni, < @mandar242 >
+#
+# 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_account_info
+
+version_added: "1.14.0"
+
+short_description: Get Azure Account facts (output of az account show)
+
+description:
+    - Get facts for current logged in user.
+    - Output equivalent of `az account show` command.
+
+extends_documentation_fragment:
+    - azure.azcollection.azure
+
+author:
+    - Mandar Kulkarni (@mandar242)
+'''
+
+EXAMPLES = '''
+- name: Get facts for current logged in user
+  azure.azcollection.azure_rm_account_info:
+'''
+
+RETURN = '''
+account_info:
+    description:
+        - Facts for current logged in user, equivalent to `az account show`.
+    returned: always
+    type: dict
+    contains:
+        environmentName:
+            description: For cloud environments other than the US public cloud, the environment name.
+            returned: always
+            type: str
+            sample: AzureCloud
+        homeTenantId:
+            description: Subscription tenant id.
+            returned: always
+            type: str
+            sample: "00000000-0000-0000-0000-000000000000"
+        id:
+            description: Subscription id.
+            returned: always
+            type: str
+            sample: "00000000-0000-0000-0000-000000000000"
+        managedByTenants:
+            description: An array containing the tenants managing the subscription.
+            returned: always
+            type: list
+            elements: dict
+            contains:
+                tenantId:
+                    description: Subscription tenant id
+                    returned: always
+                    type: str
+                    sample: "00000000-0000-0000-0000-000000000000"
+        name:
+            description: The subscription display name.
+            returned: always
+            type: str
+            sample: "Pay-As-You-Go"
+        state:
+            description:
+                - The subscription state.
+                - Possible values include "Enabled", "Warned", "PastDue", "Disabled", "Deleted".
+            returned: always
+            type: str
+            sample: "Enabled"
+        tenant_id:
+            description: Subscription tenant id
+            returned: always
+            type: str
+            sample: "00000000-0000-0000-0000-000000000000"
+        user:
+            description: An dict containing the current user name and type.
+            returned: always
+            type: dict
+            elements: str
+            contains:
+                name:
+                    description: The principal name of the active directory user.
+                    returned: always
+                    type: str
+                    sample: "sample-user@sample-tenant.onmicrosoft.com"
+                type:
+                    description: Active Directory user type.
+                    returned: always
+                    type: str
+                    sample: "User"
+'''
+
+
+try:
+    from msrestazure.azure_exceptions import CloudError
+    from azure.graphrbac import GraphRbacManagementClient
+    from azure.graphrbac.models import GraphErrorException
+except ImportError:
+    # This is handled in azure_rm_common
+    pass
+
+from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase
+from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMAuth
+
+
+class AzureRMAccountInfo(AzureRMModuleBase):
+
+    def __init__(self):
+
+        self.module_arg_spec = dict(
+        )
+
+        self.results = dict(
+            changed=False,
+            account_info=[]
+        )
+
+        # Different return info is gathered using 2 different clients
+        # 1. All except "user" section of the return value uses azure.mgmt.subsctiption.operations.subscriptionoperations
+        # 2. "user" section of the return value uses different client (graphrbac)
+
+        super(AzureRMAccountInfo, self).__init__(derived_arg_spec=self.module_arg_spec,
+                                                 supports_check_mode=True,
+                                                 supports_tags=False,
+                                                 is_ad_resource=False)
+
+    def exec_module(self, **kwargs):
+
+        result = []
+        result = self.list_items()
+
+        self.results['account_info'] = result
+        return self.results
+
+    def list_items(self):
+
+        results = {}
+
+        # Get
+        # "homeTenantId": "xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
+        # "id": "xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
+        # "isDefault": true,                                    <- WIP on getting this param
+        # "managedByTenants": [
+        #     {
+        #     "tenantId": "64xxxxxx-xxxx-49fc-xxxx-ebxxxxxxxxxx"
+        #     },
+        #     {
+        #     "tenantId": "2axxxxxx-xxxx-xxxx-a339-ebxxxxxxxxxx"
+        #     },
+        #     {
+        #     "tenantId": "xxxxxxxx-xxxx-4e68-xxxx-ebxxxxxxxxxx"
+        #     }
+        # ],
+        # "name": "Pay-As-You-Go",
+        # "state": "Enabled",
+        # "tenantId": "xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
+
+        # Makes use of azure.mgmt.subsctiption.operations.subscriptionoperations
+        # https://docs.microsoft.com/en-us/python/api/azure-mgmt-subscription/azure.mgmt.subscription.operations.subscriptionsoperations?view=azure-python#methods
+
+        try:
+            subscription_list_response = list(self.subscription_client.subscriptions.list())
+        except CloudError as exc:
+            self.fail("Failed to list all subscriptions - {0}".format(str(exc)))
+
+        results['id'] = subscription_list_response[0].subscription_id
+        results['tenantId'] = subscription_list_response[0].tenant_id
+        results['homeTenantId'] = subscription_list_response[0].tenant_id
+        results['name'] = subscription_list_response[0].display_name
+        results['state'] = subscription_list_response[0].state
+        results['managedByTenants'] = self.get_managed_by_tenants_list(subscription_list_response[0].managed_by_tenants)
+        results['environmentName'] = self.azure_auth._cloud_environment.name
+        results['user'] = self.get_aduser_info(subscription_list_response[0].tenant_id)
+
+        return results
+
+    def get_managed_by_tenants_list(self, object_list):
+
+        return [dict(tenantId=item.tenant_id) for item in object_list]
+
+    def get_aduser_info(self, tenant_id):
+
+        # Create GraphRbacManagementClient for getting
+        # "user": {
+        #     "name": "mandar123456@abcdefg.onmicrosoft.com",
+        #     "type": "user"self.
+        # }
+
+        # Makes use of azure graphrbac
+        # https://docs.microsoft.com/en-us/python/api/overview/azure/microsoft-graph?view=azure-python#client-library
+
+        user = {}
+        self.azure_auth_graphrbac = AzureRMAuth(is_ad_resource=True)
+        cred = self.azure_auth_graphrbac.azure_credentials
+        base_url = self.azure_auth_graphrbac._cloud_environment.endpoints.active_directory_graph_resource_id
+        client = GraphRbacManagementClient(cred, tenant_id, base_url)
+
+        try:
+            user_info = client.signed_in_user.get()
+            user['name'] = user_info.user_principal_name
+            user['type'] = user_info.object_type
+
+        except GraphErrorException as e:
+            self.fail("failed to get ad user info {0}".format(str(e)))
+
+        return user
+
+
+def main():
+    AzureRMAccountInfo()
+
+
+if __name__ == '__main__':
+    main()

tests/integration/targets/azure_rm_account_info/aliases

@@ -0,0 +1 @@
+cloud/azure

tests/integration/targets/azure_rm_account_info/meta/main.yml

@@ -0,0 +1,2 @@
+dependencies:
+  - setup_azure

tests/integration/targets/azure_rm_account_info/tasks/main.yml

@@ -0,0 +1,10 @@
+---
+
+- name: Get facts for current logged in user
+  azure.azcollection.azure_rm_account_info:
+  register: result
+
+- assert:
+    that:
+      - result is not changed
+      - result is not failed