Casos de teste para createUiDefinition.json

Artigo
06/20/2024

Este artigo descreve os testes que são executados com o kit de ferramentas de teste do modelo para arquivos createUiDefinition.json. Os exemplos incluem os nomes de teste e exemplos de código que aprovam ou reprovam os testes.

O kit de ferramentas inclui casos de teste para modelos do ARM (modelos do Azure Resource Manager) e os arquivos de modelo principais chamados azuredeploy.json ou maintemplate.json. Quando o diretório contém um arquivo createUiDefinition.json, testes específicos são executados para controles de interface do usuário. Para obter mais informações sobre como executar testes, ou um teste específico, confira Parâmetros de teste.

O arquivo createUiDefinition.json controles personalizados de UI (interface do usuário) usando elementos e funções.

Verificar se o parâmetro de modelo permite valores

Nome do teste: Valores permitidos devem realmente ser permitidos

Este teste verifica se os valores para cada controle no arquivo createUiDefinition.json são permitidos nos parâmetros do modelo principal. Os parâmetros são mapeados por nome entre o modelo principal e o arquivo createUiDefinition.json.

O parâmetro do modelo principal deve aceitar os valores do allowedValues do controle. O teste também verifica se o controle é referenciado no arquivo createUiDefinition.json, seção outputs.

Este teste verifica o modelo principal e o arquivo createUiDefinition.json. Um exemplo do arquivo createUiDefinition.json é mostrado depois dos exemplos do modelo principal.

O exemplo a seguir é reprovado porque o nome do parâmetro combo do modelo principal não corresponde ao nome do parâmetro comboBox do controle.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "combo": {
      "type": "string",
      "defaultValue": "two"
    }
  },
  "resources": [],
  "outputs": {
    "comboBoxOutput": {
      "type": "string",
      "value": "[parameters('combo')]"
    }
  }
}

O exemplo a seguir é reprovado porque o tipo do parâmetro int do modelo principal não aceita o valor string do controle. E se um parâmetro do modelo principal definir defaultValue ele deve ser um value válido no allowedValues do controle.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "comboBox": {
      "type": "int",
      "defaultValue": 4
    }
  },
  "resources": [],
  "outputs": {
    "comboBoxOutput": {
      "type": "string",
      "value": "[parameters('combo')]"
    }
  }
}

O exemplo a seguir é aprovado porque o nome do parâmetro do modelo principal corresponde ao nome do parâmetro do controle. E o tipo de parâmetro do modelo é um string com um defaultValue que é especificado no allowedValues do controle.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "comboBox": {
      "type": "string",
      "defaultValue": "two"
    }
  },
  "resources": [],
  "outputs": {
    "comboBoxOutput": {
      "type": "string",
      "value": "[parameters('comboBox')]"
    }
  }
}

O arquivo createUiDefinition.json para este exemplo:

{
  "$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": [],
    "steps": [
      {
        "name": "demoComboBox",
        "label": "demoComboBoxLabel",
        "elements": [
          {
            "name": "comboBox",
            "type": "Microsoft.Common.DropDown",
            "label": "Example drop down",
            "defaultValue": "Value two",
            "toolTip": "This is a tool tip",
            "constraints": {
              "allowedValues": [
                {
                  "label": "Value one",
                  "description": "The value to select for option 1.",
                  "value": "one"
                },
                {
                  "label": "Value two",
                  "description": "The value to select for option 2.",
                  "value": "two"
                }
              ],
              "required": true
            },
            "visible": true
          }
        ]
      }
    ],
    "outputs": {
      "comboBox": "[steps('demoComboBox').comboBox]"
    }
  }
}

Devem existir controles de saída

Nome do teste: Devem existir controles nas saídas

Os controles usados na seção outputs devem existir em um elemento em outro local no arquivo createUiDefinition.json. O nome referenciado em outputs deve corresponder ao nome usado em basics[] ou steps[].

O exemplo a seguir é reprovado.

{
  "$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": "nameDoesNotMatchOutput",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]"
    }
  }
}

O exemplo a seguir é aprovado.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]"
    }
  }
}

As propriedades devem incluir valores

Nome do teste: CreateUIDefinition não deve estar em branco

As propriedades devem incluir valores. As propriedades obrigatórias devem usar valores válidos. As propriedades opcionais que estão em branco devem ser removidas. O teste permite "basics": [], "steps": [] ou defaultValue em branco.

O exemplo a seguir é reprovado porque label, placeholder e toolTip estão em branco.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "",
        "placeholder": "",
        "defaultValue": "",
        "toolTip": ""
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]"
    }
  }
}

O exemplo a seguir é aprovado porque label e toolTip têm valores e placeholder foi removido.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "defaultValue": "",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]"
    }
  }
}

Usar esquema e versão válidos

Nome do teste: CreateUIDefinition deve ter esquema

O arquivo createUiDefinition.json deve incluir uma propriedade $schema e usar um $schema e um version válidos. Os números de versão $schema e version devem corresponder.

O exemplo a seguir é reprovado.

{
  "$schema": "https://schema.management.azure.com/schemas/0.9.9-preview/CreateUIDefinition.MultiVm.json#",
  "handler": "Microsoft.Azure.CreateUIDef",
  "version": "0.9.9-preview"
}

O exemplo a seguir é aprovado porque usa o $schema e version mais recentes.

{
  "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
  "handler": "Microsoft.Azure.CreateUIDef",
  "version": "0.1.2-preview"
}

Não ocultar confirmação de credencial

Nome do teste: A confirmação de credencial não ddeve ser ocultada

Este teste verifica se as credenciais estão confirmadas para Microsoft.Common.PasswordBox ou Microsoft.Compute.CredentialsCombo. A propriedade hideConfirmation deve ser definida para false para que a confirmação fique visível.

O exemplo a seguir é reprovado porque hideConfirmation é true.

{
  "$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": "credentials",
        "type": "Microsoft.Compute.CredentialsCombo",
        "label": {
          "password": "Password",
          "confirmPassword": "Confirm password"
        },
        "toolTip": {
          "password": "Type your credentials"
        },
        "constraints": {
          "required": true,
          "customPasswordRegex": "^(?=.*[A-Za-z])(?=.*\\d)[A-Za-z\\d]{12,}$",
          "customValidationMessage": "The password must be alphanumeric, contain at least 12 characters, and have at least 1 letter and 1 number."
        },
        "options": {
          "hideConfirmation": true
        },
        "osPlatform": "Windows",
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "credentials": "[basics('credentials')]"
    }
  }
}

O exemplo a seguir é aprovado porque hideConfirmation é false

{
  "$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": "credentials",
        "type": "Microsoft.Compute.CredentialsCombo",
        "label": {
          "password": "Password",
          "confirmPassword": "Confirm password"
        },
        "toolTip": {
          "password": "Type your credentials"
        },
        "constraints": {
          "required": true,
          "customPasswordRegex": "^(?=.*[A-Za-z])(?=.*\\d)[A-Za-z\\d]{12,}$",
          "customValidationMessage": "The password must be alphanumeric, contain at least 12 characters, and have at least 1 letter and 1 number."
        },
        "options": {
          "hideConfirmation": false
        },
        "osPlatform": "Windows",
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "credentials": "[basics('credentials')]"
    }
  }
}

Usar o identificador correto

Nome do teste: O identificador deve estar correto

Use Microsoft.Azure.CreateUIDef ou Microsoft.Compute.MultiVm no arquivo createUiDefinition.json.

O exemplo a seguir é reprovado.

{
  "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
  "handler": "Microsoft.Azure.",
  "version": "0.1.2-preview"
}

O exemplo a seguir é aprovado.

{
  "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
  "handler": "Microsoft.Azure.CreateUIDef",
  "version": "0.1.2-preview"
}

Não ocultar recursos existentes

Nome do teste: HideExisting deve ser corretamente identificado

Se hideExisting estiver definido como false ou omitido, outputs deve conter resourceGroup e newOrExisting. O padrão para hideExisting é false.

Exemplos de tipos de controle que incluem hideExisting são Microsoft.Storage.StorageAccountSelector, Microsoft.Network.PublicIpAddressCombo ou Microsoft.Network.VirtualNetworkCombo.

O exemplo a seguir é reprovado.

{
  "$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": "storage",
        "type": "Microsoft.Storage.StorageAccountSelector",
        "label": "Storage account",
        "toolTip": "This is a demo storage account",
        "defaultValue": {
          "name": "storageaccount01",
          "type": "Premium_LRS"
        },
        "options": {
          "hideExisting": false
        },
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]"
    }
  }
}

O exemplo a seguir é aprovado.

{
  "$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": "storage",
        "type": "Microsoft.Storage.StorageAccountSelector",
        "label": "Storage account",
        "toolTip": "This is a demo storage account",
        "defaultValue": {
          "name": "storageaccount01",
          "type": "Premium_LRS"
        },
        "options": {
          "hideExisting": false
        },
        "visible": false
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "resourceGroup": "[basics('storage').resourceGroup]",
      "newOrExisting": "[basics('storage').newOrExisting]"
    }
  }
}

Usar local em saídas

Nome do teste: O local deve ser em saídas

A seção outputs deve conter um local usando a função local.

O exemplo a seguir é reprovado porque outputs não tem um local.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]"
    }
  }
}

O exemplo a seguir é aprovado.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]",
      "location": "[location()]"
    }
  }
}

Incluir saídas de controle em parâmetros de modelo

Nome do teste: As saídas devem estar presentes nos parâmetros de modelo

O teste verifica se o arquivo createUiDefinition.json inclui uma seção outputs. O teste também verifica se esses outputs estão definidos na seção parameters do modelo principal. Os nomes devem corresponder porque os parâmetros são mapeados por nome entre o modelo principal e o arquivo createUiDefinition.json.

Este teste verifica o modelo principal e o arquivo createUiDefinition.json. Um exemplo do arquivo createUiDefinition.json é mostrado depois dos exemplos do modelo principal.

O exemplo a seguir é reprovado porque o modelo principal não inclui o parâmetro comboBox do arquivo createUiDefinition.json, seção outputs.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "resources": [],
  "outputs": {
    "location": {
      "type": "string",
      "value": "[parameters('location')]"
    }
  }
}

O exemplo a seguir é aprovado porque o modelo principal inclui o parâmetro comboBox.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "comboBox": {
      "type": "string",
      "defaultValue": "two"
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "resources": [],
  "outputs": {
    "comboBox": {
      "type": "string",
      "value": "[parameters('comboBox')]"
    },
    "location": {
      "type": "string",
      "value": "[parameters('location')]"
    }
  }
}

O arquivo createUiDefinition.json para este exemplo:

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]",
      "location": "[location()]"
    }
  }
}

Parâmetros sem padrão devem existir em saídas

Nome do teste:Parâmetros sem padrão devem existir em CreateUIDefinition

Parâmetros no modelo principal sem um valor padrão devem existir no arquivo createUiDefinition.json, seção outputs.

Este teste verifica o modelo principal e o arquivo createUiDefinition.json. Um exemplo do arquivo azuredeploy.json é mostrado depois dos exemplos do controle.

O exemplo a seguir é reprovado porque o outputs do arquivo createUiDefinition.json não inclui o parâmetro comboBox do modelo principal.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]"
    }
  }
}

O exemplo a seguir é aprovado porque o arquivo createUiDefinition.json inclui o comboBox em outputs.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "comboBox": "[basics('comboBox')]",
      "location": "[location()]"
    }
  }
}

O arquivo azuredeploy.json para este exemplo. O parâmetro comboBox não possui um valor padrão.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "comboBox": {
      "type": "string"
    },
    "location": {
      "type": "string"
    }
  },
  "resources": [],
  "outputs": {
    "comboBox": {
      "type": "string",
      "value": "[parameters('comboBox')]"
    },
    "location": {
      "type": "string",
      "value": "[parameters('location')]"
    }
  }
}

Usar um parâmetro seguro com a caixa de senha

Nome do teste: As caixas de texto de senha devem ser usadas para parâmetros de senha

Este teste verifica se o elemento Microsoft.Common.PasswordBox é definido no parameters do modelo principal e no outputs do arquivo createUiDefinition.json. O tipo de parâmetro do modelo principal para uma caixa de senha deve ser secureString ou secureObject.

Este teste verifica o modelo principal e o arquivo createUiDefinition.json. Um exemplo do arquivo createUiDefinition.json é mostrado depois dos exemplos do modelo principal.

O exemplo a seguir é reprovado porque o parâmetro passwordBox do modelo principal é um string.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "passwordBox": {
      "type": "string"
    },
    "location": {
      "type": "string"
    }
  },
  "resources": [],
  "outputs": {
    "location": {
      "type": "string",
      "value": "[parameters('location')]"
    }
  }
}

O exemplo a seguir é aprovado porque o parâmetro passwordBox modelo principal é um secureString.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "passwordBox": {
      "type": "secureString"
    },
    "location": {
      "type": "string"
    }
  },
  "resources": [],
  "outputs": {
    "location": {
      "type": "string",
      "value": "[parameters('location')]"
    }
  }
}

O arquivo createUiDefinition.json para este exemplo:

{
  "$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": "passwordBox",
        "type": "Microsoft.Common.PasswordBox",
        "label": {
          "password": "Password",
          "confirmPassword": "Confirm password"
        },
        "toolTip": "Type a password"
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "passwordBox": "[basics('passwordBox')]"
    }
  }
}

A caixa de senha requer comprimento mínimo

Mome do teste: As caixas de senha devem ter um comprimento mínimo

O teste verifica se o elemento Microsoft.Common.PasswordBox usa constraints com um regex que requeira no mínimo 12 caracteres.

O exemplo a seguir é reprovado porque não há nenhum constraints.

{
  "$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": "passwordBox",
        "type": "Microsoft.Common.PasswordBox",
        "label": {
          "password": "Password",
          "confirmPassword": "Confirm password"
        },
        "toolTip": "Type a password"
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "passwordBox": "[basics('passwordBox')]"
    }
  }
}

O exemplo a seguir é aprovado porque o regex requer no mínimo 12 caracteres.

{
  "$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": "passwordBox",
        "type": "Microsoft.Common.PasswordBox",
        "label": {
          "password": "Password",
          "confirmPassword": "Confirm password"
        },
        "toolTip": "Type a password",
        "constraints": {
          "required": true,
          "regex": "^[a-zA-Z0-9]{12,}$",
          "validationMessage": "Password must be at least 12 characters long, contain only numbers and letters"
        }
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "passwordBox": "[basics('passwordBox')]"
    }
  }
}

A caixa de texto deve usar validação

Nome do teste: As caixas de texto devem ser bem formadas

Use validação com as caixas de texto para verificar se há um constraints que contenha regex e message.

O exemplo a seguir é reprovado.

{
  "$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": "textBox",
        "type": "Microsoft.Common.TextBox",
        "label": "Text box",
        "toolTip": "Type 1-30 alphanumeric characters",
        "placeholder": "Type your text here",
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "textBox": "[basics('textBox')]"
    }
  }
}

O exemplo a seguir é aprovado.

{
  "$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": "textBox",
        "type": "Microsoft.Common.TextBox",
        "label": "Text box",
        "toolTip": "Type 1-30 alphanumeric characters",
        "placeholder": "Type your text here",
        "constraints": {
          "required": true,
          "validations": [
            {
              "regex": "^[a-z0-9A-Z]{1,30}$",
              "message": "Only 1-30 characters alphanumeric characters are allowed."
            }
          ]
        },
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "textBox": "[basics('textBox')]"
    }
  }
}

Nome do teste: As dicas de ferramenta devem estar presentes

Esse teste verifica se a propriedade toolTip existe e contém um valor.

O exemplo a seguir é reprovado.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": ""
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "comboBox": "[basics('comboBox')]"
    }
  }
}

O exemplo a seguir é aprovado.

{
  "$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": "comboBox",
        "type": "Microsoft.Common.DropDown",
        "label": "Example drop down",
        "toolTip": "This is a tool tip"
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "comboBox": "[basics('comboBox')]"
    }
  }
}

Não definir um nome de usuário padrão

Nome do teste: Os nomes de usuário não devem ter um padrão

O teste verifica se há um defaultValue definido como Microsoft.Compute.UserNameTextBox.

O exemplo a seguir é reprovado porque defaultValue é fornecido.

{
  "$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": "userNameBox",
        "type": "Microsoft.Compute.UserNameTextBox",
        "label": "User name",
        "defaultValue": "admin",
        "toolTip": "Enter your user name",
        "osPlatform": "Windows"
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "userNameBox": "[basics('userNameBox')]"
    }
  }
}

O exemplo a seguir é aprovado.

{
  "$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": "userNameBox",
        "type": "Microsoft.Compute.UserNameTextBox",
        "label": "User name",
        "toolTip": "Enter your user name",
        "osPlatform": "Windows"
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "userNameBox": "[basics('userNameBox')]"
    }
  }
}

Usar mensagem com validações

Nome do teste: As validações devem ter mensagem

O teste verifica se algum validations no arquivo createUiDefinition.json inclui um message.

O exemplo a seguir é reprovado porque a validação do regex não tem um message.

{
  "$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": "textBox",
        "type": "Microsoft.Common.TextBox",
        "label": "Text box",
        "toolTip": "Type 1-30 alphanumeric characters",
        "placeholder": "Type your text here",
        "constraints": {
          "required": true,
          "validations": [
            {
              "regex": "^[a-z0-9A-Z]{1,30}$"
            }
          ]
        },
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "textBox": "[basics('textBox')]"
    }
  }
}

O exemplo a seguir é aprovado.

{
  "$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": "textBox",
        "type": "Microsoft.Common.TextBox",
        "label": "Text box",
        "toolTip": "Type 1-30 alphanumeric characters",
        "placeholder": "Type your text here",
        "constraints": {
          "required": true,
          "validations": [
            {
              "regex": "^[a-z0-9A-Z]{1,30}$",
              "message": "Only 1-30 characters alphanumeric characters are allowed."
            }
          ]
        },
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "textBox": "[basics('textBox')]"
    }
  }
}

Os tamanhos das máquinas virtuais devem corresponder

Nome do teste: Os tamanhos das VMs devem corresponder ao modelo

Este teste verifica se o elemento Microsoft.Compute.SizeSelector está no outputs createUiDefinition.json e na seção parameters do modelo principal. Os parâmetros do modelo principal que especificam um defaultValue devem corresponder a um valor no allowedSizes do controle.

Este teste verifica o modelo principal e o arquivo createUiDefinition.json. Um exemplo do arquivo createUiDefinition.json é mostrado depois dos exemplos do modelo principal.

O exemplo a seguir é reprovado porque o defaultValue do modelo principal não corresponde a um valor em allowedSizes.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "location": {
      "type": "string"
    },
    "vmSize": {
      "type": "string",
      "defaultValue": "Standard_D9"
    }
  },
  "resources": [],
  "outputs": {
    "location": {
      "type": "string",
      "value": "[parameters('location')]"
    },
    "vmSize": {
      "type": "string",
      "value": "[parameters('vmSize')]"
    }
  }
}

O exemplo a seguir é aprovado porque o defaultValue do modelo principal corresponde a um valor em allowedSizes.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "location": {
      "type": "string"
    },
    "vmSize": {
      "type": "string",
      "defaultValue": "Standard_D3"
    }
  },
  "resources": [],
  "outputs": {
    "location": {
      "type": "string",
      "value": "[parameters('location')]"
    },
    "vmSize": {
      "type": "string",
      "value": "[parameters('vmSize')]"
    }
  }
}

O arquivo createUiDefinition.json para este exemplo:

{
  "$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": "vmSize",
        "type": "Microsoft.Compute.SizeSelector",
        "label": "VM Size",
        "toolTip": "Select a virtual machine size",
        "recommendedSizes": [
          "Standard_D1"
        ],
        "constraints": {
          "allowedSizes": [
            "Standard_D1",
            "Standard_D2",
            "Standard_D3"
          ]
        },
        "osPlatform": "Windows",
        "visible": true
      }
    ],
    "steps": [],
    "outputs": {
      "location": "[location()]",
      "vmSize": "[basics('vmSize')]"
    }
  }
}

Próximas etapas

Para criar uma interface do usuário no portal do Azure, consulte o arquivo CreateUiDefinition.json para a experiência de criação do aplicativo gerenciado do Azure.
Para usar a Área restrita de definição de interface do usuário, consulte Testar sua interface do portal para Aplicativos Gerenciados do Azure.
Para obter mais informações sobre controles de interface do usuário, consulte Elementos de CreateUiDefinition e Funções de CreateUiDefinition.
Para saber mais sobre os testes de modelo do ARM, consulte Casos de teste para modelos do ARM.

Compartilhar via

Casos de teste para createUiDefinition.json

Verificar se o parâmetro de modelo permite valores

Devem existir controles de saída

As propriedades devem incluir valores

Usar esquema e versão válidos

Não ocultar confirmação de credencial

Usar o identificador correto

Não ocultar recursos existentes

Usar local em saídas

Incluir saídas de controle em parâmetros de modelo

Parâmetros sem padrão devem existir em saídas

Usar um parâmetro seguro com a caixa de senha

A caixa de senha requer comprimento mínimo

A caixa de texto deve usar validação

A dica de ferramenta deve existir com um valor

Não definir um nome de usuário padrão

Usar mensagem com validações

Os tamanhos das máquinas virtuais devem corresponder

Próximas etapas

Comentários

Recursos adicionais