DEVOPS-274 run commands using python

Author: githubofkrishnadhas

.gitignore

@@ -99,7 +99,7 @@ ipython_config.py
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
+poetry.lock
 
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
@@ -159,4 +159,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

README.md

@@ -1,2 +1,6 @@
 # azure-runcommands-on-vm-vmss-with-python-sdk
 Code to execute run commands on Azure VMs and VMSS using python sdks
+
+
+https://azuresdkdocs.blob.core.windows.net/$web/python/azure-mgmt-compute/32.0.0/azure.mgmt.compute.html#azure.mgmt.compute.ComputeManagementClient.virtual_machine_run_commands
+

az_vm_runcommands.py

@@ -0,0 +1,54 @@
+import os
+import argparse
+from dotenv import load_dotenv
+from azure.mgmt.compute import ComputeManagementClient
+from azure.mgmt.compute.models import RunCommandInput
+from azure.identity import DefaultAzureCredential
+from resource_graph_query import run_azure_rg_query
+
+def run_commands_on_vm(resource_group:str, subscription_id:str, vm_name:str):
+	"""
+	Execute run commands on Azure using Compute Management Client class
+	:return:
+	"""
+	credential = DefaultAzureCredential()
+	compute_mgmt_client = ComputeManagementClient(credential=credential, subscription_id=subscription_id)
+
+	# Define the command parameters
+	run_command_parameters = RunCommandInput(
+		command_id='RunShellScript',
+		script=['sudo systemctl start jenkins']
+	)
+
+	response = compute_mgmt_client.virtual_machines.begin_run_command(resource_group_name=resource_group,
+													   vm_name=vm_name,parameters=run_command_parameters)
+
+	result = response.result()
+	print(result.value[0].message)
+
+
+def main():
+	"""
+	Execute program
+	:return:
+	"""
+	load_dotenv()
+	parser = argparse.ArgumentParser("Execute Run commands on an Azure VM")
+	parser.add_argument("--subscription_name", help="Azuer Subscription name", required=True, type=str)
+	parser.add_argument("--vm_name", help="Azure VM name",required=True, type=str)
+	parser.add_argument("--resource_group", help="Azure resource group name", type=str, required=True)
+
+	args = parser.parse_args()
+
+	subscription_name =args.subscription_name
+	vm_name = args.vm_name
+	resource_group = args.resource_group
+
+	subscription_id = run_azure_rg_query(subscription_name=subscription_name)
+
+	run_commands_on_vm(subscription_id=subscription_id, resource_group=resource_group, vm_name=vm_name)
+
+
+if __name__ == "__main__":
+	main()
+

pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "azure-runcommands-on-vm-vmss-with-python-sdk"
+version = "0.1.0"
+description = ""
+authors = ["githubofkrishnadhas <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+azure-mgmt-compute = "^32.0.0"
+python-dotenv = "^1.0.1"
+azure-identity = "^1.17.1"
+azure-mgmt-resourcegraph = "^8.0.0"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

resource_graph_query.py

@@ -0,0 +1,48 @@
+from azure.identity import DefaultAzureCredential
+import azure.mgmt.resourcegraph as arg
+import logging
+import os
+from dotenv import load_dotenv
+
+def run_azure_rg_query(subscription_name: str):
+    """
+    Run a resource graph query to get the subscription id of a subscription back
+    :return: subscription_id str
+    """
+    credential = DefaultAzureCredential()
+    # Create Azure Resource Graph client and set options
+    arg_client = arg.ResourceGraphClient(credential)
+
+    query = f"""
+             resourcecontainers 
+             | where type == 'microsoft.resources/subscriptions' and name == '{subscription_name}' 
+             | project subscriptionId 
+            """
+
+    print(f"query is {query}")
+
+    # Create query
+    arg_query = arg.models.QueryRequest( query=query)
+
+    # Run query
+    arg_result = arg_client.resources(arg_query)
+
+    # Show Python object
+    # print(arg_result)
+    subscription_id = arg_result.data[0]['subscriptionId']
+    print(f"Subscription ID of {subscription_name} is : {subscription_id}")
+    return subscription_id
+
+def main():
+    """
+    To test the script
+    :return:
+    """
+    load_dotenv()
+    logging.info("ARG query being prepared......")
+    run_azure_rg_query(subscription_name="TECH-ARCHITECTS-NONPROD")
+    logging.info("ARG query Completed......")
+
+
+if __name__ == "__main__":
+    main()