CreateUiDefinition-element

Den här artikeln beskriver schemat och egenskaperna för alla element som stöds i en createUiDefinition.json fil.

Schema

Schemat för de flesta element är följande:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}

Property	Obligatoriskt	Beskrivning
name	Ja	En intern identifierare som refererar till en specifik instans av ett element. Den vanligaste användningen av elementnamnet är i outputs, där utdatavärdena för de angivna elementen mappas till mallens parametrar. Du kan också använda det för att binda utdatavärdet för ett element till defaultValue ett annat element.
type	Ja	UI-kontrollen som ska återges för elementet. En lista över typer som stöds finns i Element.
label	Ja	Elementets visningstext. Vissa elementtyper innehåller flera etiketter, så värdet kan vara ett objekt som innehåller flera strängar.
defaultValue	Nej	Standardvärdet för elementet. Vissa elementtyper stöder komplexa standardvärden, så värdet kan vara ett objekt.
toolTip	Nej	Texten som ska visas i elementets verktygsspets. labelPå liknande sätt stöder vissa element flera verktygsspetssträngar. Infogade länkar kan bäddas in med Markdown-syntax.
constraints	Nej	En eller flera egenskaper som används för att anpassa verifieringsbeteendet för elementet. Egenskaperna för begränsningar som stöds varierar beroende på elementtyp. Vissa elementtyper stöder inte anpassning av valideringsbeteendet och har därför ingen egenskap för begränsningar.
options	Nej	Fler egenskaper som anpassar elementets beteende. constraintsPå liknande sätt varierar egenskaperna som stöds efter elementtyp.
visible	Nej	Anger om elementet visas. Om truevisas elementet och tillämpliga underordnade element. Standardvärdet är true. Använd logiska funktioner för att dynamiskt kontrollera den här egenskapens värde.

Element

Dokumentationen för varje element innehåller ett gränssnittsexempel, schema, kommentarer om elementets beteende (vanligtvis gällande validering och anpassning som stöds) och exempelutdata.

• Microsoft.Common.CheckBox
• Microsoft.Common.DropDown
• Microsoft.Common.EditableGrid
• Microsoft.Common.FileUpload
• Microsoft.Common.InfoBox
• Microsoft.Common.OptionsGroup
• Microsoft.Common.PasswordBox
• Microsoft.Common.Section
• Microsoft.Common.ServicePrincipalSelector
• Microsoft.Common.Slider
• Microsoft.Common.TagsByResource
• Microsoft.Common.TextBlock
• Microsoft.Common.TextBox
• Microsoft.Compute.CredentialsCombo
• Microsoft.Compute.SizeSelector
• Microsoft.Compute.UserNameTextBox
• Microsoft.KeyVault.KeyVaultCertificateSelector
• Microsoft.ManagedIdentity.IdentitySelector
• Microsoft.Network.PublicIpAddressCombo
• Microsoft.Network.VirtualNetworkCombo
• Microsoft.Solutions.ArmApiControl
• Microsoft.Solutions.ResourceSelector
• Microsoft.Storage.MultiStorageAccountCombo
• Microsoft.Storage.StorageAccountSelector
• Microsoft.Storage.StorageBlobSelector

Nästa steg

En introduktion till hur du skapar användargränssnittsdefinitioner finns i Komma igång med CreateUiDefinition.