Azure API Management: Harnessing Bicep for Effortless User and Subscription Creation

@description('Name of Api Management')
param apimName string

@description('Name of the product')
param apimProductId string

@description('Array of users to create')
param users array

// Resource to add users to API Management
resource apimUser 'Microsoft.ApiManagement/service/users@2019-12-01' = [
  for user in users: {
    name: '${apimName}/${user}'
    properties: {
      firstName: '${user}'
      lastName: '${user}'
      email: '${user}@mail.be'
      password: 'myUserPassword'
      state: 'active'
    }
  }
]

// Resource to add subscriptions to API Management
resource apimSubscription 'Microsoft.ApiManagement/service/subscriptions@2019-12-01' = [
   for user in users: {
    name: '${apimName}/ProductAPIService'
    properties: {
      displayName: 'Product API Service' 
      state: 'active'
      scope: '/products/${apimProductId}'
      allowTracing: false
      ownerId: '/users/${user}'  
    }
  dependsOn: [
      apimUser
    ]
  }
]

// Output the name of the API Management instance
output addInApiName string = apimName

// Output the ID of the product in API Management
output addInProduct string = apimProductId

// Output the subscription keys for the created users
output souscriptionKey array = [for i in range(0, length(users)):  {
  user: last(split(apimSubscription[i].properties.ownerId, '/'))
  key: apimSubscription[i].listSecrets().primaryKey
}]

using 'main.bicep'

param apimName = 'myApimName'
param apimProductId = 'myProductID'
param users = [
  'user1'
  'user2'
]

param(
    # Azure APIM Environment to deploy
    [string]$env
)

$date = Get-Date -Format "dd/MM/yyyy"
$logFolderPath = Join-Path -Path $PSScriptRoot -ChildPath "$env\logs"
$credentialsFolderPath = Join-Path -Path $PSScriptRoot -ChildPath "$env\$date\credentials"

# Function to create a directory if it doesn't exist
function Ensure-DirectoryExists {
    param (
        [string]$path
    )
    if (!(Test-Path -Path $path)) {
        New-Item -ItemType Directory -Path $path | Out-Null
        Write-Host "New folder $path created successfully!" -ForegroundColor Green
    } else {
        Write-Host "Folder $path already exists!"
    }
}

# Ensure necessary directories exist
Ensure-DirectoryExists -path $logFolderPath
Ensure-DirectoryExists -path $credentialsFolderPath

# Function to format validation output
function Format-ValidationOutput {
    param (
        $ValidationOutput, 
        [int]$Depth = 0
    )
    Set-StrictMode -Off
    $ValidationOutput | Where-Object { $_ -ne $null } | ForEach-Object {
        @('  ' * $Depth + ': ' + $_.Message) + @(Format-ValidationOutput -ValidationOutput $_.Details -Depth ($Depth + 1))
    }
}

# Function to return full environment name
function Return-FullEnvironmentName {
    param (
        [string]$environment
    )

    switch ($environment) {
        'dev' { 'Development' }
        'acc' { 'Acceptance' }
        'prd' { 'Production' }
        default { 'Unknown' }
    }
}

# Test Deployment
$ErrorMessages = Format-ValidationOutput (Test-AzResourceGroupDeployment -Verbose -ResourceGroupName "apim-$env-rg" -TemplateFile "main.bicep" -TemplateParameterFile "main.$env.bicepparam")

if ($ErrorMessages) {
    $errorMessage = 'Validation returned the following errors:' + [System.Environment]::NewLine + ($ErrorMessages -join [System.Environment]::NewLine) + [System.Environment]::NewLine + 'Template is invalid.'
    Write-Host $errorMessage
    Write-Output $errorMessage >> "$logFolderPath/logs.txt"
} else { 
    Write-Host "Start users and subscriptions creation on $env environment"

    $deploymentResult = New-AzResourceGroupDeployment `
        -Name "apiUserAndSubscriptionDeployment" `
        -Verbose `
        -ResourceGroupName "apim-$env-rg" `
        -TemplateFile "main.bicep" `
        -TemplateParameterFile "main.$env.bicepparam"

    $deploymentResult | Out-File -FilePath "$logFolderPath/logs.txt" -Append

    $apimName = $deploymentResult.Outputs.addInApiName.Value
    Add-Content -Path "$credentialsFolderPath/credentials.txt" -Value "Api Management : $apimName"

    $environmentFullName = Return-FullEnvironmentName -environment $env
    Add-Content -Path "$credentialsFolderPath/credentials.txt" -Value "Environment : $environmentFullName"

    $productName = $deploymentResult.Outputs.addInProduct.Value
    Add-Content -Path "$credentialsFolderPath/credentials.txt" -Value "Product : $productName"

    $subscriptionKeys = $deploymentResult.Outputs.subscriptionKey[0].Value | Select-Object
    Add-Content -Path "$credentialsFolderPath/credentials.txt" -Value "Subscriptions : $subscriptionKeys"
}