Elements supported in Form view

This article is the element support list for Form view (uiFormDefinition.json), which is used by template spec portal forms. For Azure Managed Applications, use createUiDefinition.json elements instead.

Form view reuses the same baseline element contract as CreateUiDefinition: properties such as name, type, label, defaultValue, toolTip, constraints, options, and visible have the same meaning unless a Form view-specific article says otherwise. To avoid repeating shared schemas, the Reference column links to existing CreateUiDefinition element pages for controls that behave the same in both formats. Availability is determined by the support list on this page, not by the physical folder of the linked article.

Supported elements

The element types listed below are supported in Form view.

Differences from CreateUiDefinition elements

The two formats overlap, but aren't interchangeable:

• Form view has its own support list. Don't assume an element is valid in uiFormDefinition.json just because it appears in the CreateUiDefinition reference, or valid in createUiDefinition.json just because it appears on this page.

• No basics() function in Form view. Form view has no implicit Basics step; the subscription, resource group, and location pickers are explicit elements (Microsoft.Common.SubscriptionSelector, Microsoft.Common.ResourceGroupSelector, Microsoft.Common.LocationSelector) placed in whichever step you choose, and their outputs are referenced via steps(...) like any other control.

• Form view has explicit scope selector elements. Microsoft.Common.ResourceScope, Microsoft.Common.SubscriptionSelector, Microsoft.Common.ResourceGroupSelector, Microsoft.Common.LocationSelector, Microsoft.Common.ManagementGroupSelector, and Microsoft.Common.TenantSelector are documented for Form view. In CreateUiDefinition, subscription, resource group, and location are provided by the implicit Basics step instead.

• Microsoft.Compute.CredentialsCombo requires an osPlatform discriminator. The type value is always the string "Microsoft.Compute.CredentialsCombo"; the Linux versus Windows variant is selected by setting "osPlatform": "Linux" or "osPlatform": "Windows" on the element. The two variants do not have identical schemas:

  • The Linux variant must include label.authenticationType, label.password, label.confirmPassword, and label.sshPublicKey, and supports the SSH-key authentication mode and an options.hidePassword flag.
  • The Windows variant only requires label.password and label.confirmPassword; it does not accept the SSH-related label, toolTip, or options fields.

  The internal schema definitions named Microsoft.Compute.CredentialsCombo-Linux and Microsoft.Compute.CredentialsCombo-Windows are JSON Schema definition names used to enforce these per-platform shapes — they're not values you place in type.

Next steps

• Form view overview
• Create portal forms for template specs
• CreateUiDefinition functions