CreateUiDefinition-Elemente

In diesem Artikel werden das Schema und die Eigenschaften für alle unterstützten Elemente einer createUiDefinition.json Datei beschrieben.

Schema

Das Schema für die meisten Elemente ist wie folgt:

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

Eigenschaft	Erforderlich	Beschreibung
name	Ja	Ein interner Bezeichner für den Verweis auf eine bestimmte Instanz eines Elements. Am häufigsten wird der Elementname in outputs verwendet. Dabei werden die Ausgabewerte der angegebenen Elemente den Parametern der Vorlage zugeordnet. Sie können mit ihm auch den Ausgabewert eines Elements an defaultValue eines anderen Elements binden.
type	Ja	Das Benutzeroberflächensteuerelement, das für das Element gerendert werden soll. Eine Liste der unterstützten Typen finden Sie unter Elemente.
label	Ja	Der Anzeigetext des Elements. Einige Elementtypen enthalten mehrere Bezeichnungen. Der Wert kann also ein Objekt sein, das mehrere Zeichenfolgen enthält.
defaultValue	No	Der Standardwert des Elements. Einige Elementtypen unterstützen komplexe Standardwerte. Der Wert kann also ein Objekt sein.
toolTip	No	Der Text, der in der QuickInfo des Elements angezeigt werden soll. Ähnlich wie bei label unterstützen einige Elemente mehrere QuickInfo-Zeichenfolgen. Inlinelinks können mithilfe von Markdownsyntax eingebettet werden.
constraints	No	Eigenschaften, die zum Anpassen des Überprüfungsverhaltens des Elements verwendet werden. Die unterstützten Eigenschaften für Einschränkungen variieren je nach Elementtyp. Einige Elementtypen unterstützen keine Anpassung des Überprüfungsverhaltens und weisen daher keine Einschränkungseigenschaft auf.
options	No	Weitere Eigenschaften, die das Verhalten des Elements anpassen. Ähnlich wie bei constraints variieren die unterstützten Eigenschaften je nach Elementtyp.
visible	No	Gibt an, ob das Element angezeigt wird. Ist true angegeben, werden das Element und entsprechende untergeordnete Elemente angezeigt. Standardwert: true. Verwenden Sie logische Funktionen, um den Wert dieser Eigenschaft dynamisch zu steuern.

Elemente

Die Dokumentation für die einzelnen Elemente enthält ein Benutzeroberflächenbeispiel, ein Schema, Hinweise zum Verhalten des Elements (in der Regel in Bezug auf Überprüfung und unterstützte Anpassung) und eine Beispielausgabe.

• 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ächste Schritte

Eine Einführung zum Erstellen von Benutzeroberflächendefinitionen finden Sie unter Erste Schritte mit „CreateUiDefinition“.