CreateUiDefinition-elementen

In dit artikel worden het schema en de eigenschappen voor alle ondersteunde elementen van een CreateUiDefinition beschreven.

Schema

Het schema voor de meeste elementen is als volgt:

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

Eigenschap	Vereist	Beschrijving
naam	Yes	Een interne id die verwijst naar een specifiek exemplaar van een element. Het meest voorkomende gebruik van de elementnaam is in outputs, waar de uitvoerwaarden van de opgegeven elementen worden toegewezen aan de parameters van de sjabloon. U kunt deze ook gebruiken om de uitvoerwaarde van een element te binden aan de defaultValue van een ander element.
type	Yes	Het ui-besturingselement dat moet worden weergegeven voor het element. Zie Elementen voor een lijst met ondersteunde typen.
label	Yes	De weergavetekst van het element. Sommige elementtypen bevatten meerdere labels, dus de waarde kan een object met meerdere tekenreeksen zijn.
standaardwaarde	No	De standaardwaarde van het element. Sommige elementtypen ondersteunen complexe standaardwaarden, zodat de waarde een object kan zijn.
Tooltip	No	De tekst die moet worden weergegeven in de knopinfo van het element. labelNet als bij ondersteunen sommige elementen meerdere tekenreeksen voor knoptips. Inlinekoppelingen kunnen worden ingesloten met de Markdown-syntaxis.
Beperkingen	No	Een of meer eigenschappen die worden gebruikt om het validatiegedrag van het element aan te passen. De ondersteunde eigenschappen voor beperkingen verschillen per elementtype. Sommige elementtypen bieden geen ondersteuning voor het aanpassen van het validatiegedrag en hebben dus geen eigenschap beperkingen.
opties	No	Aanvullende eigenschappen waarmee het gedrag van het element wordt aangepast. constraintsVergelijkbaar met , verschillen de ondersteunde eigenschappen per elementtype.
Zichtbaar	No	Hiermee wordt aangegeven of het element wordt weergegeven. Als true, worden het element en de toepasselijke onderliggende elementen weergegeven. De standaardwaarde is true. Gebruik logische functies om de waarde van deze eigenschap dynamisch te beheren.

Elementen

De documentatie voor elk element bevat een ui-voorbeeld, schema, opmerkingen over het gedrag van het element (meestal met betrekking tot validatie en ondersteunde aanpassingen) en voorbeelduitvoer.

• 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

Volgende stappen

Zie Aan de slag met CreateUiDefinition voor een inleiding tot het maken van UI-definities.