Feature/create infrastructure classes (#88)

Author: simonkurtz-MSFT

infrastructure/afd-apim-pe/create.ipynb

@@ -22,13 +22,20 @@
     "import utils\n",
     "from apimtypes import *\n",
     "\n",
-    "# User-defined parameters (change these as needed)\n",
+    "# ------------------------------\n",
+    "#    USER CONFIGURATION\n",
+    "# ------------------------------\n",
+    "\n",
     "rg_location = 'eastus2'             # Azure region for deployment\n",
     "index       = 1                     # Infrastructure index (use different numbers for multiple environments)\n",
     "apim_sku    = APIM_SKU.STANDARDV2   # Options: 'STANDARDV2', 'PREMIUMV2' (Basic not supported for private endpoints)\n",
-    "use_aca     = True                  # Include Azure Container Apps backends\n",
     "\n",
-    "# Create an instance of the desired infrastructure\n",
+    "\n",
+    "\n",
+    "# ------------------------------\n",
+    "#    SYSTEM CONFIGURATION\n",
+    "# ------------------------------\n",
+    "\n",
     "inb_helper = utils.InfrastructureNotebookHelper(rg_location, INFRASTRUCTURE.AFD_APIM_PE, index, apim_sku) \n",
     "success = inb_helper.create_infrastructure()\n",
     "\n",

infrastructure/afd-apim-pe/create_infrastructure.py

@@ -20,13 +20,20 @@
     "import utils\n",
     "from apimtypes import *\n",
     "\n",
-    "# User-defined parameters (change these as needed)\n",
-    "rg_location     = 'eastus2'         # Azure region for deployment\n",
-    "index           = 1                 # Infrastructure index (use different numbers for multiple environments)\n",
-    "apim_sku        = APIM_SKU.BASICV2  # Options: 'BASICV2', 'STANDARDV2', 'PREMIUMV2'\n",
-    "reveal_backend  = True              # Set to True to reveal the backend details in the API operations\n",
+    "# ------------------------------\n",
+    "#    USER CONFIGURATION\n",
+    "# ------------------------------\n",
+    "\n",
+    "rg_location = 'eastus2'             # Azure region for deployment\n",
+    "index       = 1                     # Infrastructure index (use different numbers for multiple environments)\n",
+    "apim_sku    = APIM_SKU.BASICV2      # Options: 'BASICV2', 'STANDARDV2', 'PREMIUMV2'\n",
+    "\n",
+    "\n",
+    "\n",
+    "# ------------------------------\n",
+    "#    SYSTEM CONFIGURATION\n",
+    "# ------------------------------\n",
     "\n",
-    "# Create an instance of the desired infrastructure\n",
     "inb_helper = utils.InfrastructureNotebookHelper(rg_location, INFRASTRUCTURE.APIM_ACA, index, apim_sku) \n",
     "success = inb_helper.create_infrastructure()\n",
     "\n",

infrastructure/apim-aca/create.ipynb

@@ -1,274 +1,76 @@
 """
-Infrastructure creation module for APIM-ACA.
-
-This module provides a reusable way to create API Management with Azure Container Apps
-infrastructure that can be called from notebooks or other scripts.
+This module provides a reusable way to create API Management with Azure Container Apps infrastructure that can be called from notebooks or other scripts.
 """
 
 import sys
-import os
 import argparse
-from pathlib import Path
+from apimtypes import APIM_SKU, API, GET_APIOperation, BACKEND_XML_POLICY_PATH
+from infrastructures import ApimAcaInfrastructure
 import utils
-from apimtypes import *
-import json
-
-def _create_apim_aca_infrastructure(
-    rg_location: str = 'eastus2',
-    index: int | None = None,
-    apim_sku: APIM_SKU = APIM_SKU.BASICV2,
-    reveal_backend: bool = True,
-    custom_apis: list[API] | None = None,
-    custom_policy_fragments: list[PolicyFragment] | None = None
-) -> utils.Output:
-    """
-    Create APIM-ACA infrastructure with the specified parameters.
-    
-    Args:
-        rg_location (str): Azure region for deployment. Defaults to 'eastus2'.
-        index (int | None): Index for the infrastructure. Defaults to None (no index).
-        apim_sku (APIM_SKU): SKU for API Management. Defaults to BASICV2.
-        reveal_backend (bool): Whether to reveal backend details in API operations. Defaults to True.
-        custom_apis (list[API] | None): Custom APIs to deploy. If None, uses default Hello World API.
-        custom_policy_fragments (list[PolicyFragment] | None): Custom policy fragments. If None, uses defaults.
-        
-    Returns:
-        utils.Output: The deployment result.
-    """
-    
-    # 1) Setup deployment parameters
-    deployment = INFRASTRUCTURE.APIM_ACA
-    rg_name = utils.get_infra_rg_name(deployment, index)
-    rg_tags = utils.build_infrastructure_tags(deployment)
-
-    print(f'\n🚀 Creating APIM-ACA infrastructure...\n')
-    print(f'   Infrastructure : {deployment.value}')
-    print(f'   Index          : {index}')
-    print(f'   Resource group : {rg_name}')
-    print(f'   Location       : {rg_location}')
-    print(f'   APIM SKU       : {apim_sku.value}\n')
-    
-    # 2) Set up the policy fragments
-    if custom_policy_fragments is None:
-        pfs: List[PolicyFragment] = [
-            PolicyFragment('AuthZ-Match-All', utils.read_policy_xml(utils.determine_shared_policy_path('pf-authz-match-all.xml')), 'Authorizes if all of the specified roles match the JWT role claims.'),
-            PolicyFragment('AuthZ-Match-Any', utils.read_policy_xml(utils.determine_shared_policy_path('pf-authz-match-any.xml')), 'Authorizes if any of the specified roles match the JWT role claims.'),
-            PolicyFragment('Http-Response-200', utils.read_policy_xml(utils.determine_shared_policy_path('pf-http-response-200.xml')), 'Returns a 200 OK response for the current HTTP method.'),
-            PolicyFragment('Product-Match-Any', utils.read_policy_xml(utils.determine_shared_policy_path('pf-product-match-any.xml')), 'Proceeds if any of the specified products match the context product name.'),
-            PolicyFragment('Remove-Request-Headers', utils.read_policy_xml(utils.determine_shared_policy_path('pf-remove-request-headers.xml')), 'Removes request headers from the incoming request.')
-        ]
-    else:
-        pfs = custom_policy_fragments
-    
-    # 3) Define the APIs
-    if custom_apis is None:
-        # Default APIs with Container Apps backends
-        pol_hello_world = utils.read_policy_xml(HELLO_WORLD_XML_POLICY_PATH)
-        pol_backend = utils.read_policy_xml(BACKEND_XML_POLICY_PATH)
-        pol_aca_backend_1 = pol_backend.format(backend_id = 'aca-backend-1')
-        pol_aca_backend_2 = pol_backend.format(backend_id = 'aca-backend-2')
-        pol_aca_backend_pool = pol_backend.format(backend_id = 'aca-backend-pool')
-
-        # Hello World (Root)
-        api_hwroot_get = GET_APIOperation('This is a GET for Hello World in the root', pol_hello_world)
-        api_hwroot = API('hello-world', 'Hello World', '', 'This is the root API for Hello World', operations = [api_hwroot_get])
-
-        # Hello World (ACA Backend 1)
-        api_hwaca_1_get = GET_APIOperation('This is a GET for Hello World on ACA Backend 1')
-        api_hwaca_1 = API('hello-world-aca-1', 'Hello World (ACA 1)', '/aca-1', 'This is the ACA API for Backend 1', policyXml = pol_aca_backend_1, operations = [api_hwaca_1_get])
 
-        # Hello World (ACA Backend 2)
-        api_hwaca_2_get = GET_APIOperation('This is a GET for Hello World on ACA Backend 2')
-        api_hwaca_2 = API('hello-world-aca-2', 'Hello World (ACA 2)', '/aca-2', 'This is the ACA API for Backend 2', policyXml = pol_aca_backend_2, operations = [api_hwaca_2_get])
 
-        # Hello World (ACA Backend Pool)
-        api_hwaca_pool_get = GET_APIOperation('This is a GET for Hello World on ACA Backend Pool')
-        api_hwaca_pool = API('hello-world-aca-pool', 'Hello World (ACA Pool)', '/aca-pool', 'This is the ACA API for Backend Pool', policyXml = pol_aca_backend_pool, operations = [api_hwaca_pool_get])
-
-        # APIs Array
-        apis: List[API] = [api_hwroot, api_hwaca_1, api_hwaca_2, api_hwaca_pool]
-    else:
-        apis = custom_apis
-    
-    # 4) Define the Bicep parameters with serialized APIs
-    bicep_parameters = {
-        'apimSku'               : {'value': apim_sku.value},
-        'apis'                  : {'value': [api.to_dict() for api in apis]},
-        'policyFragments'       : {'value': [pf.to_dict() for pf in pfs]},
-        'revealBackendApiInfo'  : {'value': reveal_backend}    
-    }
-    
-    # 5) Change to the infrastructure directory to ensure bicep files are found
-    original_cwd = os.getcwd()
-    infra_dir = Path(__file__).parent
-    
+def create_infrastructure(location: str, index: int, apim_sku: APIM_SKU) -> None:
     try:
-        os.chdir(infra_dir)
-        print(f'📁 Changed working directory to: {infra_dir}')
-        
-        # 6) Prepare deployment parameters and run directly to avoid path detection issues
-        bicep_parameters_format = {
-            '$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#',
-            'contentVersion': '1.0.0.0',
-            'parameters': bicep_parameters
-        }
-        
-        # Write the parameters file
-        params_file_path = infra_dir / 'params.json'
-
-        with open(params_file_path, 'w') as file:            
-            file.write(json.dumps(bicep_parameters_format))
-        
-        print(f"📝 Updated the policy XML in the bicep parameters file 'params.json'")
-        
-        # Create the resource group if it doesn't exist
-        utils.create_resource_group(rg_name, rg_location, rg_tags)
+        # Create custom APIs for APIM-ACA with Container Apps backends
+        custom_apis = _create_aca_specific_apis()
 
-        # Run the deployment directly
-        main_bicep_path = infra_dir / 'main.bicep'
-        output = utils.run(
-            f'az deployment group create --name {deployment.value} --resource-group {rg_name} --template-file "{main_bicep_path}" --parameters "{params_file_path}" --query "properties.outputs"',
-            f"Deployment '{deployment.value}' succeeded", 
-            f"Deployment '{deployment.value}' failed.",
-            print_command_to_run = False
-        )
+        infra = ApimAcaInfrastructure(location, index, apim_sku, infra_apis = custom_apis)
+        result = infra.deploy_infrastructure()
 
-        # 7) Check the deployment results and perform verification
-        if output.success:
-            print('\n✅ Infrastructure creation completed successfully!')
-            if output.json_data:
-                apim_gateway_url = output.get('apimResourceGatewayURL', 'APIM API Gateway URL', suppress_logging = True)
-                aca_url_1 = output.get('acaUrl1', 'ACA Backend 1 URL', suppress_logging = True)
-                aca_url_2 = output.get('acaUrl2', 'ACA Backend 2 URL', suppress_logging = True)
-                apim_apis = output.getJson('apiOutputs', 'APIs', suppress_logging = True)
-                
-                print(f'\n📋 Infrastructure Details:')
-                print(f'   Resource Group   : {rg_name}')
-                print(f'   Location         : {rg_location}')
-                print(f'   APIM SKU         : {apim_sku.value}')
-                print(f'   Reveal Backend   : {reveal_backend}')
-                print(f'   Gateway URL      : {apim_gateway_url}')
-                print(f'   ACA Backend 1    : {aca_url_1}')
-                print(f'   ACA Backend 2    : {aca_url_2}')
-                print(f'   APIs Created     : {len(apim_apis)}')
-                
-                # Perform basic verification
-                _verify_infrastructure(rg_name)
-        else:
-            print('❌ Infrastructure creation failed!')
+        sys.exit(0 if result.success else 1)
 
-        return output
-        
-    finally:
-        # Always restore the original working directory
-        os.chdir(original_cwd)
-        print(f'📁 Restored working directory to: {original_cwd}')
+    except Exception as e:
+        print(f'\n💥 Error: {str(e)}')
+        sys.exit(1)
+
 
-def _verify_infrastructure(rg_name: str) -> bool:
+def _create_aca_specific_apis() -> list[API]:
     """
-    Verify that the infrastructure was created successfully.
+    Create APIM-ACA specific APIs with Container Apps backends.
     
-    Args:
-        rg_name (str): Resource group name.
-        
     Returns:
-        bool: True if verification passed, False otherwise.
+        list[API]: List of ACA-specific APIs.
     """
 
-    print('\n🔍 Verifying infrastructure...')
+    # Define the APIs with Container Apps backends
+    pol_backend          = utils.read_policy_xml(BACKEND_XML_POLICY_PATH)
+    pol_aca_backend_1    = pol_backend.format(backend_id = 'aca-backend-1')
+    pol_aca_backend_2    = pol_backend.format(backend_id = 'aca-backend-2')
+    pol_aca_backend_pool = pol_backend.format(backend_id = 'aca-backend-pool')
+
+    # API 1: Hello World (ACA Backend 1)
+    api_hwaca_1_get      = GET_APIOperation('This is a GET for Hello World on ACA Backend 1')
+    api_hwaca_1          = API('hello-world-aca-1', 'Hello World (ACA 1)', '/aca-1', 'This is the ACA API for Backend 1', pol_aca_backend_1, [api_hwaca_1_get])
+
+    # API 2: Hello World (ACA Backend 2)
+    api_hwaca_2_get      = GET_APIOperation('This is a GET for Hello World on ACA Backend 2')
+    api_hwaca_2          = API('hello-world-aca-2', 'Hello World (ACA 2)', '/aca-2', 'This is the ACA API for Backend 2', pol_aca_backend_2, [api_hwaca_2_get])
+
+    # API 3: Hello World (ACA Backend Pool)
+    api_hwaca_pool_get   = GET_APIOperation('This is a GET for Hello World on ACA Backend Pool')
+    api_hwaca_pool       = API('hello-world-aca-pool', 'Hello World (ACA Pool)', '/aca-pool', 'This is the ACA API for Backend Pool', pol_aca_backend_pool, [api_hwaca_pool_get])
 
-    try:
-        # Check if the resource group exists
-        if not utils.does_resource_group_exist(rg_name):
-            print('❌ Resource group does not exist!')
-            return False
-        
-        print('✅ Resource group verified')
-        
-        # Get APIM service details
-        output = utils.run(f'az apim list -g {rg_name} --query "[0]" -o json', print_command_to_run = False, print_errors = False)
-        
-        if output.success and output.json_data:
-            apim_name = output.json_data.get('name')
-            print(f'✅ APIM Service verified: {apim_name}')
-            
-            # Get Container Apps count
-            aca_output = utils.run(f'az containerapp list -g {rg_name} --query "length(@)"', print_command_to_run = False, print_errors = False)
-            
-            if aca_output.success:
-                aca_count = int(aca_output.text.strip())
-                print(f'✅ Container Apps verified: {aca_count} app(s) created')
-                
-                # Get API count
-                api_output = utils.run(f'az apim api list --service-name {apim_name} -g {rg_name} --query "length(@)"', 
-                                      print_command_to_run = False, print_errors = False)
-                
-                if api_output.success:
-                    api_count = int(api_output.text.strip())
-                    print(f'✅ APIs verified: {api_count} API(s) created')
-                    
-                    # Test basic connectivity (optional)
-                    if api_count > 0:
-                        try:
-                            # Get subscription key for testing
-                            sub_output = utils.run(f'az apim subscription list --service-name {apim_name} -g {rg_name} --query "[0].primaryKey" -o tsv', 
-                                                 print_command_to_run = False, print_errors = False)
-                            
-                            if sub_output.success and sub_output.text.strip():
-                                print('✅ Subscription key available for API testing')
-                        except:
-                            pass
-            
-            print('\n🎉 Infrastructure verification completed successfully!')
-            return True
-            
-        else:
-            print('\n❌ APIM service not found!')
-            return False
-            
-    except Exception as e:
-        print(f'\n⚠️  Verification failed with error: {str(e)}')
-        return False
+    return [api_hwaca_1, api_hwaca_2, api_hwaca_pool]
 
 def main():
     """
     Main entry point for command-line usage.
     """
 
-    parser = argparse.ArgumentParser(description='Create APIM-ACA infrastructure')
-    parser.add_argument('--location', default='eastus2', help='Azure region (default: eastus2)')
-    parser.add_argument('--index', type=int, help='Infrastructure index')
-    parser.add_argument('--sku', choices=['Basicv2', 'Standardv2', 'Premiumv2'], default='Basicv2', help='APIM SKU (default: Basicv2)')
-    parser.add_argument('--no-reveal-backend', action='store_true', help='Do not reveal backend details in API operations')
-    
+    parser = argparse.ArgumentParser(description = 'Create APIM-ACA infrastructure')
+    parser.add_argument('--location', default = 'eastus2', help = 'Azure region (default: eastus2)')
+    parser.add_argument('--index', type = int, help = 'Infrastructure index')
+    parser.add_argument('--sku', choices = ['Basicv2', 'Standardv2', 'Premiumv2'], default = 'Basicv2', help = 'APIM SKU (default: Basicv2)')    
     args = parser.parse_args()
-    
-    # Convert SKU string to enum
-    sku_map = {
-        'Basicv2': APIM_SKU.BASICV2,
-        'Standardv2': APIM_SKU.STANDARDV2,
-        'Premiumv2': APIM_SKU.PREMIUMV2
-    }
-    
+
+    # Convert SKU string to enum using the enum's built-in functionality
     try:
-        result = _create_apim_aca_infrastructure(
-            rg_location = args.location, 
-            index = args.index, 
-            apim_sku = sku_map[args.sku],
-            reveal_backend = not args.no_reveal_backend
-        )
-        
-        if result.success:
-            print('\n🎉 Infrastructure creation completed successfully!')
-            sys.exit(0)
-        else:
-            print('\n💥 Infrastructure creation failed!')
-            sys.exit(1)
-            
-    except Exception as e:
-        print(f'\n💥 Error: {str(e)}')
+        apim_sku = APIM_SKU(args.sku)
+    except ValueError:
+        print(f"Error: Invalid SKU '{args.sku}'. Valid options are: {', '.join([sku.value for sku in APIM_SKU])}")
         sys.exit(1)
 
+    create_infrastructure(args.location, args.index, apim_sku)
 
 if __name__ == '__main__':
     main()

infrastructure/apim-aca/create_infrastructure.py

@@ -20,12 +20,20 @@
     "import utils\n",
     "from apimtypes import *\n",
     "\n",
-    "# User-defined parameters (change these as needed)\n",
+    "# ------------------------------\n",
+    "#    USER CONFIGURATION\n",
+    "# ------------------------------\n",
+    "\n",
     "rg_location = 'eastus2'             # Azure region for deployment\n",
     "index       = 1                     # Infrastructure index (use different numbers for multiple environments)\n",
     "apim_sku    = APIM_SKU.BASICV2      # Options: 'BASICV2', 'STANDARDV2', 'PREMIUMV2'\n",
     "\n",
-    "# Create an instance of the desired infrastructure\n",
+    "\n",
+    "\n",
+    "# ------------------------------\n",
+    "#    SYSTEM CONFIGURATION\n",
+    "# ------------------------------\n",
+    "\n",
     "inb_helper = utils.InfrastructureNotebookHelper(rg_location, INFRASTRUCTURE.SIMPLE_APIM, index, apim_sku) \n",
     "success = inb_helper.create_infrastructure()\n",
     "\n",