CreateUiDefinition, elementy
W tym artykule opisano schemat i właściwości wszystkich obsługiwanych elementów elementu CreateUiDefinition.
Schemat
Schemat większości elementów jest następujący:
{
"name": "element1",
"type": "Microsoft.Common.TextBox",
"label": "Some text box",
"defaultValue": "my value",
"toolTip": "Provide a descriptive name.",
"constraints": {},
"options": {},
"visible": true
}
Właściwość | Wymagane | Opis |
---|---|---|
name | Tak | Wewnętrzny identyfikator odwołujące się do określonego wystąpienia elementu. Najbardziej typowym użyciem nazwy elementu jest w outputs pliku , gdzie wartości wyjściowe określonych elementów są mapowane na parametry szablonu. Można go również użyć do powiązania wartości wyjściowej elementu z defaultValue innym elementem. |
typ | Tak | Kontrolka interfejsu użytkownika do renderowania elementu. Aby uzyskać listę obsługiwanych typów, zobacz Elementy. |
label | Tak | Tekst wyświetlany elementu. Niektóre typy elementów zawierają wiele etykiet, więc wartość może być obiektem zawierającym wiele ciągów. |
Defaultvalue | Nie | Wartość domyślna elementu. Niektóre typy elementów obsługują złożone wartości domyślne, więc wartość może być obiektem. |
Etykietka narzędzia | Nie | Tekst do wyświetlenia w napiwku narzędzia elementu. Podobnie jak label w systemie niektóre elementy obsługują wiele ciągów porad narzędzia. Linki wbudowane można osadzać przy użyciu składni języka Markdown. |
Ograniczenia | Nie | Co najmniej jedna właściwości używana do dostosowywania zachowania walidacji elementu. Obsługiwane właściwości ograniczeń różnią się w zależności od typu elementu. Niektóre typy elementów nie obsługują dostosowywania zachowania walidacji i dlatego nie mają właściwości ograniczeń. |
opcje | Nie | Dodatkowe właściwości, które dostosowują zachowanie elementu. Podobnie jak constraints w przypadku , obsługiwane właściwości różnią się w zależności od typu elementu. |
Widoczne | Nie | Wskazuje, czy element jest wyświetlany. Jeśli true element i odpowiednie elementy podrzędne zostaną wyświetlone. Wartość domyślna to true . Użyj funkcji logicznych , aby dynamicznie kontrolować wartość tej właściwości. |
Elementy
Dokumentacja każdego elementu zawiera przykładowy interfejs użytkownika, schemat, uwagi dotyczące zachowania elementu (zwykle dotyczące walidacji i obsługiwanego dostosowywania) oraz przykładowe dane wyjściowe.
- 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
Następne kroki
Aby zapoznać się z wprowadzeniem do tworzenia definicji interfejsu użytkownika, zobacz Wprowadzenie do metody CreateUiDefinition.