Självstudie: Skapa Azure Portal formulär för en mallspecifikation
Du kan skapa ett formulär som visas i Azure Portal för att hjälpa användare att distribuera en mallspecifikation. Formuläret gör det möjligt för användare att ange värden som skickas som parametrar till mallspecifikationen.
När du skapar mallspecifikationen paketera du formuläret och Azure Resource Manager-mallen (ARM-mall) tillsammans. När du distribuerar mallspecifikationen via portalen startas formuläret automatiskt.
Följande skärmbild visar ett formulär som öppnas i Azure Portal.
Förutsättningar
Ett Azure-konto med en aktiv prenumeration. Skapa ett konto utan kostnad.
Använd version 6.0.0 eller senare för Azure PowerShell. För Azure CLI använder du version 2.24.0 eller senare.
Skapa mallen
Om du vill visa de olika portalelementen som är tillgängliga i ett formulär använder du en ARM-mall med flera parametrar. Följande mall skapar ett nyckelvalv, konfigurerar behörigheter för nyckelvalv för en användare och lägger till en hemlighet.
Kopiera den här filen och spara den lokalt. Den här självstudien förutsätter att du har döpt den till keyvault.json , men du kan ge den valfritt namn.
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"keyVaultName": {
"type": "string",
"metadata": {
"description": "Specifies the name of the key vault."
}
},
"location": {
"type": "string",
"defaultValue": "[resourceGroup().location]",
"metadata": {
"description": "Specifies the Azure location where the key vault should be created."
}
},
"enabledForDeployment": {
"type": "bool",
"defaultValue": false,
"allowedValues": [
true,
false
],
"metadata": {
"description": "Specifies whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault."
}
},
"enabledForDiskEncryption": {
"type": "bool",
"defaultValue": false,
"allowedValues": [
true,
false
],
"metadata": {
"description": "Specifies whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys."
}
},
"enabledForTemplateDeployment": {
"type": "bool",
"defaultValue": false,
"allowedValues": [
true,
false
],
"metadata": {
"description": "Specifies whether Azure Resource Manager is permitted to retrieve secrets from the key vault."
}
},
"tenantId": {
"type": "string",
"defaultValue": "[subscription().tenantId]",
"metadata": {
"description": "Specifies the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. Get it by using Get-AzSubscription cmdlet."
}
},
"objectId": {
"type": "string",
"metadata": {
"description": "Specifies the object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies. Get it by using Get-AzADUser or Get-AzADServicePrincipal cmdlets."
}
},
"keysPermissions": {
"type": "array",
"defaultValue": [
"list"
],
"metadata": {
"description": "Specifies the permissions to keys in the vault. Valid values are: all, encrypt, decrypt, wrapKey, unwrapKey, sign, verify, get, list, create, update, import, delete, backup, restore, recover, and purge."
}
},
"secretsPermissions": {
"type": "array",
"defaultValue": [
"list"
],
"metadata": {
"description": "Specifies the permissions to secrets in the vault. Valid values are: all, get, list, set, delete, backup, restore, recover, and purge."
}
},
"skuName": {
"type": "string",
"defaultValue": "standard",
"allowedValues": [
"standard",
"premium"
],
"metadata": {
"description": "Specifies whether the key vault is a standard vault or a premium vault."
}
},
"secretName": {
"type": "string",
"metadata": {
"description": "Specifies the name of the secret that you want to create."
}
},
"secretValue": {
"type": "secureString",
"metadata": {
"description": "Specifies the value of the secret that you want to create."
}
}
},
"resources": [
{
"type": "Microsoft.KeyVault/vaults",
"apiVersion": "2022-07-01",
"name": "[parameters('keyVaultName')]",
"location": "[parameters('location')]",
"properties": {
"enabledForDeployment": "[parameters('enabledForDeployment')]",
"enabledForDiskEncryption": "[parameters('enabledForDiskEncryption')]",
"enabledForTemplateDeployment": "[parameters('enabledForTemplateDeployment')]",
"tenantId": "[parameters('tenantId')]",
"accessPolicies": [
{
"objectId": "[parameters('objectId')]",
"tenantId": "[parameters('tenantId')]",
"permissions": {
"keys": "[parameters('keysPermissions')]",
"secrets": "[parameters('secretsPermissions')]"
}
}
],
"sku": {
"name": "[parameters('skuName')]",
"family": "A"
},
"networkAcls": {
"defaultAction": "Allow",
"bypass": "AzureServices"
}
}
},
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2022-07-01",
"name": "[format('{0}/{1}', parameters('keyVaultName'), parameters('secretName'))]",
"dependsOn": [
"[resourceId('Microsoft.KeyVault/vaults', parameters('keyVaultName'))]"
],
"properties": {
"value": "[parameters('secretValue')]"
}
}
]
}
Skapa standardformulär
Azure Portal tillhandahåller en sandbox-miljö för att skapa och förhandsgranska formulär. Den här sandbox-miljön kan återge ett formulär från en befintlig ARM-mall. Du använder det här standardformuläret för att komma igång med att skapa ett formulär för mallspecifikationen. Mer information om formulärstrukturen finns i FormViewType.
Öppna sandbox-miljön för formulärvyn.
I Pakettyp väljer du CustomTemplate. Se till att du väljer pakettypen innan du anger distributionsmallen.
I Distributionsmall (valfritt) väljer du den nyckelvalvsmall som du sparade lokalt. När du tillfrågas om du vill skriva över aktuella ändringar väljer du Ja. Det automatiskt genererade formuläret visas i kodfönstret. Formuläret kan redigeras från portalen. Information om hur du anpassar formuläret finns i Anpassa formulär. Om du tittar närmare på det autogenererade formuläret kallas standardrubriken Testformulärvy och det finns bara ett steg som kallas grundläggande.
{ "$schema": "https://schema.management.azure.com/schemas/2021-09-09/uiFormDefinition.schema.json", "view": { "kind": "Form", "properties": { "title": "Test Form View", "steps": [ { "name": "basics", "label": "Basics", "elements": [ ... ] } ] }, "outputs": { ... } } }Om du vill se att det fungerar utan några ändringar väljer du Förhandsversion.
Sandbox-miljön visar formuläret. Den har fält för att välja en prenumeration, resursgrupp och region. Den innehåller även fält för alla parametrar från mallen.
De flesta fälten är textrutor, men vissa fält är specifika för parametertypen. När mallen innehåller tillåtna värden för en parameter använder det automatiskt genererade formuläret ett listruteelement. Listruteelementet fylls i i förväg med de tillåtna värdena.
Mellan rubriken och projektinformationen finns det inga flikar eftersom standardformuläret bara har ett definierat steg. I avsnittet Anpassa formulär delar du upp parametrarna i flera flikar.
Varning
Välj inte Skapa eftersom det startar en verklig distribution. Du får chansen att distribuera mallspecifikationen senare i den här självstudien.
Om du vill avsluta förhandsversionen väljer du Avbryt.
Anpassa formulär
Standardformuläret är en bra utgångspunkt för att förstå formulär, men vanligtvis vill du anpassa det. Du kan redigera den i sandbox-miljön eller i Visual Studio Code. Förhandsgranskningsalternativet är bara tillgängligt i sandbox-miljön.
Ge formuläret en rubrik som beskriver dess användning.
{ "$schema": "https://schema.management.azure.com/schemas/2021-09-09/uiFormDefinition.schema.json#", "view": { "kind": "Form", "properties": { "title": "Key Vault and secret",Standardformuläret hade alla fält för mallen kombinerade i ett steg med namnet Grundläggande. Dela upp formuläret i steg för att hjälpa användarna att förstå de värden de tillhandahåller. Varje steg innehåller fält som är relaterade till en logisk del av lösningen som ska distribueras.
Leta reda på steget Grundläggande. Du behåller det här steget men lägger till steg under det. De nya stegen fokuserar på att konfigurera nyckelvalvet, ange användarbehörigheter och ange hemligheten. Se till att du lägger till ett kommatecken efter grundsteget.
{ "$schema": "https://schema.management.azure.com/schemas/2021-09-09/uiFormDefinition.schema.json#", "view": { "kind": "Form", "properties": { "title": "Key Vault and secret", "steps": [ { "name": "basics", "label": "Basics", "elements": [ ... ] }, { "name": "keyvault", "label": "Key Vault", "elements": [ ] }, { "name": "permissions", "label": "Permissions", "elements": [ ] }, { "name": "secret", "label": "Secret", "elements": [ ] } ] }, "outputs": { ... } } }Viktigt
Egenskaper i formuläret är skiftlägeskänsliga. Se till att du använder höljet som visas i exemplen.
Välj Förhandsversion. Du ser stegen, men de flesta av dem har inga element.
Flytta nu elementen till lämpliga steg. Börja med elementen hemligt namn och hemligt värde. Ta bort de här elementen från steget Grundläggande och lägg till dem i steget Hemlighet .
{ "name": "secret", "label": "Secret", "elements": [ { "name": "secretName", "type": "Microsoft.Common.TextBox", "label": "Secret Name", "defaultValue": "", "toolTip": "Specifies the name of the secret that you want to create.", "constraints": { "required": true, "regex": "", "validationMessage": "" }, "visible": true }, { "name": "secretValue", "type": "Microsoft.Common.PasswordBox", "label": { "password": "Secret Value", "confirmPassword": "Confirm password" }, "toolTip": "Specifies the value of the secret that you want to create.", "constraints": { "required": true, "regex": "", "validationMessage": "" }, "options": { "hideConfirmation": true }, "visible": true } ] }När du flyttar element måste du åtgärda avsnittet
outputs. För närvarande refererar utdataavsnittet till dessa element som om de fortfarande var i grundsteget. Korrigera syntaxen så att den refererar till elementensecreti steget."outputs": { "parameters": { ... "secretName": "[steps('secret').secretName]", "secretValue": "[steps('secret').secretValue]" }Fortsätt att flytta element till lämpliga steg. I stället för att gå igenom var och en tar du en titt på det uppdaterade formuläret.
{ "$schema": "https://schema.management.azure.com/schemas/2021-09-09/uiFormDefinition.schema.json#", "view": { "kind": "Form", "properties": { "title": "Key Vault and secret", "steps": [ { "name": "basics", "label": "Basics", "elements": [ { "name": "resourceScope", "type": "Microsoft.Common.ResourceScope", "location": { "resourceTypes": [ "microsoft.resources/resourcegroups" ] } } ] }, { "name": "keyvault", "label": "Key Vault", "elements": [ { "name": "keyVaultName", "type": "Microsoft.Common.TextBox", "label": "Key Vault Name", "defaultValue": "", "toolTip": "Specifies the name of the key vault.", "constraints": { "required": true, "regex": "", "validationMessage": "" }, "visible": true }, { "name": "skuName", "type": "Microsoft.Common.DropDown", "label": "Sku Name", "defaultValue": "Standard", "toolTip": "Specifies whether the key vault is a standard vault or a premium vault.", "constraints": { "required": false, "allowedValues": [ { "label": "Standard", "value": "Standard" }, { "label": "Premium", "value": "Premium" } ] }, "visible": true }, { "name": "location", "type": "Microsoft.Common.TextBox", "label": "Location", "defaultValue": "[[resourceGroup().location]", "toolTip": "Specifies the Azure location where the key vault should be created.", "constraints": { "required": false, "regex": "", "validationMessage": "" }, "visible": true }, { "name": "enabledForDeployment", "type": "Microsoft.Common.DropDown", "label": "Enabled For Deployment", "defaultValue": "false", "toolTip": "Specifies whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.", "constraints": { "required": false, "allowedValues": [ { "label": "true", "value": true }, { "label": "false", "value": false } ] }, "visible": true }, { "name": "enabledForDiskEncryption", "type": "Microsoft.Common.DropDown", "label": "Enabled For Disk Encryption", "defaultValue": "false", "toolTip": "Specifies whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.", "constraints": { "required": false, "allowedValues": [ { "label": "true", "value": true }, { "label": "false", "value": false } ] }, "visible": true }, { "name": "enabledForTemplateDeployment", "type": "Microsoft.Common.DropDown", "label": "Enabled For Template Deployment", "defaultValue": "false", "toolTip": "Specifies whether Azure Resource Manager is permitted to retrieve secrets from the key vault.", "constraints": { "required": false, "allowedValues": [ { "label": "true", "value": true }, { "label": "false", "value": false } ] }, "visible": true } ] }, { "name": "permissions", "label": "Permissions", "elements": [ { "name": "tenantId", "type": "Microsoft.Common.TextBox", "label": "Tenant Id", "defaultValue": "[[subscription().tenantId]", "toolTip": "Specifies the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. Get it by using Get-AzSubscription cmdlet.", "constraints": { "required": false, "regex": "", "validationMessage": "" }, "visible": true }, { "name": "objectId", "type": "Microsoft.Common.TextBox", "label": "Object Id", "defaultValue": "", "toolTip": "Specifies the object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies. Get it by using Get-AzADUser or Get-AzADServicePrincipal cmdlets.", "constraints": { "required": true, "regex": "", "validationMessage": "" }, "visible": true }, { "name": "keysPermissions", "type": "Microsoft.Common.TextBox", "label": "Keys Permissions", "defaultValue": "[[\"list\"]", "toolTip": "Specifies the permissions to keys in the vault. Valid values are: all, encrypt, decrypt, wrapKey, unwrapKey, sign, verify, get, list, create, update, import, delete, backup, restore, recover, and purge.", "constraints": { "required": false, "regex": "", "validationMessage": "" }, "visible": true }, { "name": "secretsPermissions", "type": "Microsoft.Common.TextBox", "label": "Secrets Permissions", "defaultValue": "[[\"list\"]", "toolTip": "Specifies the permissions to secrets in the vault. Valid values are: all, get, list, set, delete, backup, restore, recover, and purge.", "constraints": { "required": false, "regex": "", "validationMessage": "" }, "visible": true } ] }, { "name": "secret", "label": "Secret", "elements": [ { "name": "secretName", "type": "Microsoft.Common.TextBox", "label": "Secret Name", "defaultValue": "", "toolTip": "Specifies the name of the secret that you want to create.", "constraints": { "required": true, "regex": "", "validationMessage": "" }, "visible": true }, { "name": "secretValue", "type": "Microsoft.Common.PasswordBox", "label": { "password": "Secret Value", "confirmPassword": "Confirm password" }, "toolTip": "Specifies the value of the secret that you want to create.", "constraints": { "required": true, "regex": "", "validationMessage": "" }, "options": { "hideConfirmation": true }, "visible": true } ] } ] }, "outputs": { "parameters": { "keyVaultName": "[steps('keyvault').keyVaultName]", "location": "[steps('keyvault').location]", "enabledForDeployment": "[steps('keyvault').enabledForDeployment]", "enabledForDiskEncryption": "[steps('keyvault').enabledForDiskEncryption]", "enabledForTemplateDeployment": "[steps('keyvault').enabledForTemplateDeployment]", "tenantId": "[steps('permissions').tenantId]", "objectId": "[steps('permissions').objectId]", "keysPermissions": "[steps('permissions').keysPermissions]", "secretsPermissions": "[steps('permissions').secretsPermissions]", "skuName": "[steps('keyvault').skuName]", "secretName": "[steps('secret').secretName]", "secretValue": "[steps('secret').secretValue]" }, "kind": "ResourceGroup", "location": "[steps('basics').resourceScope.location.name]", "resourceGroupId": "[steps('basics').resourceScope.resourceGroup.id]" } } }Spara filen lokalt med namnet keyvaultform.json.
Skapa mallspecifikation
När du skapar mallspecifikationen anger du båda filerna.
För PowerShell använder du New-AzTemplateSpec och anger formuläret i parametern -UIFormDefinitionFile .
New-AzTemplateSpec `
-name keyvaultspec `
-version 1 `
-ResourceGroupName templateSpecRG `
-location westus2 `
-templatefile keyvault.json `
-UIFormDefinitionFile keyvaultform.json
För Azure CLI använder du az ts create och anger formuläret i parametern --ui-form-definition .
az ts create \
--name keyvaultspec \
--version 1 \
--resource-group templatespecRG \
--location westus2 \
--template-file keyvault.json \
--ui-form-definition keyvaultform.json
Distribuera via portalen
Om du vill testa formuläret går du till portalen och navigerar till mallspecifikationen. Välj Distribuera.
Du ser formuläret som du skapade. Gå igenom stegen och ange värden för fälten.
I steget Grundläggande visas ett fält för Region. Det här fältet används för platsen för resursgruppen. I det Key Vault steget visas ett fält för Plats. Det här fältet används för platsen för nyckelvalvet.
I steget Behörigheter kan du ange ditt eget användar-ID för objekt-ID:t. Använd standardvärdet (["list"]) för nyckel- och hemliga behörigheter. Du kommer att förbättra det alternativet i nästa avsnitt.
När du har angett värden väljer du Skapa för att distribuera mallspecifikationen.
Förbättra formuläret
I föregående avsnitt lade du till steg och flyttade element, men du ändrade inte något av standardbeteendena. I det här avsnittet gör du ändringar som förbättrar upplevelsen för användare av mallspecifikationen.
Tidigare var de två behörighetsfälten textrutor. Nu ska du använda en listruta. Ange typen till Microsoft.Common.DropDown.
Uppdatering keysPermissions:
{
"name": "keysPermissions",
"type": "Microsoft.Common.DropDown",
Och secretsPermissions:
{
"name": "secretsPermissions",
"type": "Microsoft.Common.DropDown",
De här fälten måste skicka en matris till mallen. En vanlig listruta fungerar inte eftersom du bara kan välja ett värde. Om du vill välja fler än ett värde och skicka dem som en matris lägger du till fältet multiselect och anger till true.
{
"name": "keysPermissions",
"type": "Microsoft.Common.DropDown",
"label": "Keys Permissions",
"multiselect": true,
{
"name": "secretsPermissions",
"type": "Microsoft.Common.DropDown",
"label": "Secrets Permissions",
"multiselect": true,
Slutligen måste du ange de tillåtna värdena för listrutan och ett standardvärde.
{
"name": "keysPermissions",
"type": "Microsoft.Common.DropDown",
"label": "Keys Permissions",
"multiselect": true,
"defaultValue":{
"value": "list"
},
"toolTip": "Specifies the permissions to keys in the vault. Valid values are: all, encrypt, decrypt, wrapKey, unwrapKey, sign, verify, get, list, create, update, import, delete, backup, restore, recover, and purge.",
"constraints": {
"required": false,
"allowedValues":[
{
"label": "all",
"value": "all"
},
{
"label": "encrypt",
"value": "encrypt"
},
{
"label": "decrypt",
"value": "decrypt"
},
{
"label": "list",
"value": "list"
},
{
"label": "delete",
"value": "delete"
},
{
"label": "backup",
"value": "backup"
},
{
"label": "restore",
"value": "restore"
},
{
"label": "recover",
"value": "recover"
},
{
"label": "purge",
"value": "purge"
},
{
"label": "wrapKey",
"value": "wrapKey"
},
{
"label": "unwrapKey",
"value": "unwrapKey"
},
{
"label": "sign",
"value": "sign"
},
{
"label": "verify",
"value": "verify"
},
{
"label": "get",
"value": "get"
},
{
"label": "create",
"value": "create"
},
{
"label": "update",
"value": "update"
},
{
"label": "import",
"value": "import"
}
]
},
"visible": true
},
{
"name": "secretsPermissions",
"type": "Microsoft.Common.DropDown",
"label": "Secrets Permissions",
"multiselect": true,
"defaultValue":{
"value": "list"
},
"toolTip": "Specifies the permissions to secrets in the vault. Valid values are: all, get, list, set, delete, backup, restore, recover, and purge.",
"constraints": {
"required": false,
"allowedValues":[
{
"label": "all",
"value": "all"
},
{
"label": "get",
"value": "get"
},
{
"label": "list",
"value": "list"
},
{
"label": "set",
"value": "set"
},
{
"label": "delete",
"value": "delete"
},
{
"label": "backup",
"value": "backup"
},
{
"label": "restore",
"value": "restore"
},
{
"label": "recover",
"value": "recover"
},
{
"label": "purge",
"value": "purge"
}
]
},
"visible": true
}
Skapa en ny version av mallspecifikationen.
Med PowerShell:
New-AzTemplateSpec `
-name keyvaultspec `
-version 2 `
-ResourceGroupName templateSpecRG `
-location westus2 `
-templatefile keyvault.json `
-UIFormDefinitionFile keyvaultform.json
Eller Azure CLI:
az ts create \
--name keyvaultspec \
--version 2 \
--resource-group templatespecRG \
--location westus2 \
--template-file keyvault.json \
--ui-form-definition keyvaultform.json
Distribuera om mallspecifikationen med det förbättrade portalformuläret.
Observera att dina behörighetsfält nu är nedrullningsbara och tillåter flera värden.
Nästa steg
Mer information om hur du distribuerar en mallspecifikation som en länkad mall finns i Självstudie: Distribuera en mallspecifikation som en länkad mall.