CreateUIDefinition.json

{
  "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
  "handler": "Microsoft.Azure.CreateUIDef",
  "version": "0.1.2-preview",
  "parameters": {
    "basics": [
      {
        "name": "location",
        "type": "Microsoft.Common.TextBox",
        "label": "Location",
        "defaultValue": "global",
        "toolTip": "Resources location",
        "visible": false
      }
    ],
    "steps": [
      {
        "name": "integrationConfig",
        "type": "Microsoft.Common.Section",
        "label": "Integration Configuration",
        "elements": [
          {
            "name": "fireflySite",
            "type": "Microsoft.Common.DropDown",
            "label": "Firefly Site",
            "defaultValue": "US",
            "toolTip": "The Firefly site for your organization. Choose EU if your Firefly account is hosted in the European region.",
            "constraints": {
              "allowedValues": [
                {
                  "label": "US",
                  "value": "firefly.ai"
                },
                {
                  "label": "EU",
                  "value": "eu.firefly.ai"
                }
              ],
              "required": true
            },
            "visible": true
          },
          {
            "name": "directoryDomain",
            "type": "Microsoft.Common.TextBox",
            "label": "Directory Domain",
            "toolTip": "Enter the directory domain for Firefly integration (e.g., yourcompany.com).",
            "placeholder": "yourcompany.com",
            "constraints": {
              "required": true,
              "regex": "^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$",
              "validationMessage": "Please enter a valid domain name (e.g., example.com)"
            },
            "visible": true
          },
          {
            "name": "isProd",
            "type": "Microsoft.Common.CheckBox",
            "label": "Production Environment",
            "toolTip": "Check if this is a production environment.",
            "constraints": {
              "required": false
            },
            "visible": true
          },
          {
            "name": "enforceStorageNetworkRules",
            "type": "Microsoft.Common.CheckBox",
            "label": "Enforce Storage Network Rules",
            "toolTip": "Restrict storage account access to Firefly IP addresses only. When enabled, the storage account will only allow access from predefined Firefly IP addresses.",
            "constraints": {
              "required": false
            },
            "visible": true
          },
          {
            "name": "tags",
            "type": "Microsoft.Common.EditableGrid",
            "ariaLabel": "Custom tags for resources",
            "label": "Tags",
            "toolTip": "Add custom tags for your resources. A 'firefly: true' tag will be automatically added.",
            "constraints": {
              "width": "Full",
              "rows": {
                "count": {
                  "min": 0,
                  "max": 20
                }
              },
              "columns": [
                {
                  "id": "tagName",
                  "header": "Tag Name",
                  "width": "1fr",
                  "element": {
                    "type": "Microsoft.Common.TextBox",
                    "placeholder": "Environment",
                    "constraints": {
                      "required": true,
                      "regex": "^[a-zA-Z0-9_-]+$",
                      "validationMessage": "Tag name must contain only letters, numbers, underscores, and hyphens"
                    }
                  }
                },
                {
                  "id": "tagValue",
                  "header": "Tag Value",
                  "width": "1fr",
                  "element": {
                    "type": "Microsoft.Common.TextBox",
                    "placeholder": "Production",
                    "constraints": {
                      "required": true,
                      "regex": "^[\\w\\s\\-./:@()]+$",
                      "validationMessage": "Tag value may include letters, numbers, spaces, underscore (_), hyphen (-), dot (.), slash (/), colon (:), at (@), and parentheses"
                    }
                  }
                }
              ]
            },
            "visible": true
          },
          {
            "name": "targetSubscriptions",
            "type": "Microsoft.Common.DropDown",
            "label": "Target Subscriptions",
            "placeholder": "Select subscriptions to monitor",
            "toolTip": "Select the subscriptions where you want to deploy Firefly monitoring infrastructure. Multi-subscription deployment will create the same monitoring infrastructure (storage account, event grid, diagnostic settings) in each selected subscription.",
            "constraints": {
              "allowedValues": "[map(steps('integrationConfig').subscriptionApi.value, (item) => parse(concat('{\"label\":\"', item.displayName, ' (', item.subscriptionId, ')\",\"value\":\"', item.subscriptionId, '\"}')))]",
              "required": true
            },
            "visible": true,
            "multiselect": true
          },
          {
            "name": "subscriptionApi",
            "type": "Microsoft.Solutions.ArmApiControl",
            "request": {
              "method": "GET",
              "path": "/subscriptions?api-version=2020-01-01"
            },
            "visible": false
          }
        ]
      },
      {
        "name": "servicePrincipal",
        "label": "Service Principal",
        "elements": [
          {
            "name": "createAppReg",
            "type": "Microsoft.Common.Section",
            "label": "Create Firefly Azure Integration",
            "elements": [
              {
                "name": "infoBox",
                "type": "Microsoft.Common.InfoBox",
                "visible": true,
                "options": {
                  "icon": "Info",
                  "text": "The following steps involve creating or selecting a service principal for Firefly to access your Azure subscription. Please read them carefully before continuing.\n\n1. Select the option to create a new app registration, and click 'Change Selection'.\n2. Give it a name (e.g., 'Firefly-Integration') and select any account type.\n3. Click 'Register'. This will open a new page to create a client secret.\n4. Click '+ New Client Secret' to add a Client Secret.\n5. Copy the Value of the Client Secret.\n6. Click the close (X) button in the top-right corner to return to this template screen.\n7. Paste the value of the Client Secret in the corresponding field on this template.\n\nAfter deployment, this service principal will be granted the following permissions on the selected subscription:\n• Reader\n• Billing Reader\n• App Configuration Data Reader\n• Security Reader"
                }
              },
              {
                "name": "ServicePrincipal",
                "type": "Microsoft.Common.ServicePrincipalSelector",
                "label": {
                  "servicePrincipalId": "Service Principal Id",
                  "password": "Client Secret",
                  "sectionHeader": "Service Principal"
                },
                "toolTip": {
                  "servicePrincipalId": "Service Principal for Firefly integration"
                },
                "defaultValue": {
                  "principalId": "<default guid>",
                  "name": "(New) default App Id"
                },
                "constraints": {
                  "required": true,
                  "validationMessage": "Must be a valid client secret"
                },
                "options": {
                  "hideCertificate": true
                },
                "visible": true
              }
            ],
            "visible": true
          }
        ]
      },
      {
        "name": "fireflyCredentials",
        "label": "Firefly Credentials",
        "elements": [
          {
            "name": "ffAccessKey",
            "type": "Microsoft.Common.PasswordBox",
            "label": {
              "password": "Firefly Access Key",
              "confirmPassword": "Re-enter Firefly Access Key"
            },
            "toolTip": "Enter your Firefly Access Key.",
            "constraints": {
              "required": true,
              "regex": "^.+$",
              "validationMessage": "Firefly Access Key is required"
            },
            "options": {
              "hideConfirmation": true
            }
          },
          {
            "name": "ffSecretKey",
            "type": "Microsoft.Common.PasswordBox",
            "label": {
              "password": "Firefly Secret Key",
              "confirmPassword": "Re-enter Firefly Secret Key"
            },
            "toolTip": "Enter your Firefly Secret Key.",
            "constraints": {
              "required": true,
              "regex": "^.+$",
              "validationMessage": "Firefly Secret Key is required"
            },
            "options": {
              "hideConfirmation": true
            }
          }
        ]
      }
    ],
    "outputs": {
      "location": "[location()]",
      "servicePrincipalClientId": "[steps('servicePrincipal').createAppReg.ServicePrincipal.appId]",
      "servicePrincipalObjectId": "[first(steps('servicePrincipal').createAppReg.ServicePrincipal.objectId)]",
      "servicePrincipalClientSecret": "[steps('servicePrincipal').createAppReg.ServicePrincipal.password]",
      "fireflyAccessKey": "[steps('fireflyCredentials').ffAccessKey]",
      "fireflySecretKey": "[steps('fireflyCredentials').ffSecretKey]",
      "fireflySite": "[steps('integrationConfig').fireflySite]",
      "directoryDomain": "[steps('integrationConfig').directoryDomain]",
      "isProd": "[steps('integrationConfig').isProd]",
      "targetSubscriptions": "[steps('integrationConfig').targetSubscriptions]",
      "enforceStorageNetworkRules": "[steps('integrationConfig').enforceStorageNetworkRules]",
      "tags": "[steps('integrationConfig').tags]"
    }
  }
}