Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Template Specs ignore UI definition? #58

Closed
JustinGrote opened this issue Jul 15, 2021 · 24 comments
Closed

Template Specs ignore UI definition? #58

JustinGrote opened this issue Jul 15, 2021 · 24 comments

Comments

@JustinGrote
Copy link

@alex-frankel not sure if I'm missing something here:

Published a template spec using set-aztemplatespec and the uidefinitionfile parameter. Debug shows it loaded fine:

Body:
{
  "location": "westus2",
  "tags": {},
  "properties": {
    "uiFormDefinition": {
      "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
      "handler": "Microsoft.Azure.CreateUIDef",
      "version": "0.1.2-preview",
      "parameters": {
        "resourceTypes": [

etc...

However when I go to deploy the template spec, it completely ignores it, it seems.
image

Am I missing something? This is supported right?

@JustinGrote
Copy link
Author

I should also note that the UI definition is still present too in Get-TemplateSpec
image

@JustinGrote
Copy link
Author

I tried it with the traefik azure quickstart UI definition which I know works and still no joy, the "deploy to azure" button works fine tho.
image

@alex-frankel
Copy link
Contributor

This was answered on twitter, but want to close the loop here. We built support for this into the templateSpec API, but have not finished the portal support to read this UiDefinition if it is provided. Our current ETA is that this will be completed in about a month. cc @apclouds

@peter-bertok
Copy link
Collaborator

This was answered on twitter, but want to close the loop here. We built support for this into the templateSpec API, but have not finished the portal support to read this UiDefinition if it is provided. Our current ETA is that this will be completed in about a month. cc @apclouds

I'm eagerly awaiting the release of this. It's the #1 most requested feature among our customers. Most administrators prefer to have a nice GUI they can click through, and as a consultant I haven't been able to deliver anything for them because this was missing.

@Bad-Rog
Copy link

Bad-Rog commented Jul 30, 2021

I'd like to second peter-bertoks comment...
This will be a great feature, please update us here, once it is implemented.

@peter-bertok
Copy link
Collaborator

Our current ETA is that this will be completed in about a month

Is there any update on the progress of this feature?

@Bad-Rog
Copy link

Bad-Rog commented Aug 31, 2021

This was answered on twitter, but want to close the loop here. We built support for this into the templateSpec API, but have not finished the portal support to read this UiDefinition if it is provided. Our current ETA is that this will be completed in about a month. cc @apclouds

Guys, can we get an updated on this Issue?

@alex-frankel
Copy link
Contributor

Just received an ETA that portal support for custom UiDefinition will be available at the end of September.

@JustinGrote
Copy link
Author

@alex-frankel later than hoped but thanks for the update all the same!

@peter-bertok
Copy link
Collaborator

portal support for custom UiDefinition will be available at the end of September

@alex-frankel will it be available in the preview portal before then for testing?

@alex-frankel
Copy link
Contributor

More than likely, but I don't know for sure at this point. As soon as it's publicly available for use, we will let this thread know.

@peter-bertok
Copy link
Collaborator

It appears to be enabled in the Preview portal now, but I get a generic error:

image

Is this because the feature is not ready, or because there's a new schema for the UI definitions used by Template Specs?

@alex-frankel
Copy link
Contributor

Yes, the schema is being tweaked slightly. The docs are not yet available, but if you are very eager you can take a look at the PR for what the schema will be:
Azure/azure-resource-manager-schemas#1906

@Bad-Rog
Copy link

Bad-Rog commented Sep 17, 2021

The feature seems to be implemented into Production Portal now, however i still get the above mentioned error...
By when will there be a documentation to know what to amend?

thanks a lot

@alex-frankel
Copy link
Contributor

The goal is to have docs available by the end of the month

@peter-bertok
Copy link
Collaborator

I managed to get it working:

image

One thing I noticed is that it still shows the "Azure Marketplace Terms" acceptance form, which shouldn't be there for Template Specs.

Some other features I'd love to see are:

  • Previews of what resources will be deployed, vaguely like "-WhatIf", but ideally with a GUI look and feel. E.g.: the correct icons, etc...
  • The ability to customise the icon of the template spec. In this example I would like it to have the Azure DNS Zone icon instead of the generic template icon.

@alex-frankel
Copy link
Contributor

One thing I noticed is that it still shows the "Azure Marketplace Terms" acceptance form, which shouldn't be there for Template Specs.

My understanding is this is shown for all custom template deployments. It should also be there if you click a "Deploy to Azure" button in GitHub for example.

Definitely would be great to add What-if output (nicely visualized) to this experience.

Custom icons for TemplateSpecs is also an interesting idea. Do you mind making a separate issue to keep track of that?

@Bad-Rog
Copy link

Bad-Rog commented Oct 12, 2021

any update on this?

@alex-frankel
Copy link
Contributor

Docs are still not done. In the meantime, you can try going to https://aka.ms/form/sandbox which has both a UiForm generator and a converter for an existing createUiDefiniton.

@alex-frankel
Copy link
Contributor

Docs on Template Spec integration with Ui Forms will be published Nov. 2nd.

One additional note for those who want to try things early, be sure to switch the "Package Type" dropdown in the sandbox to "Custom Template" otherwise your generated Form will not be valid.

image

@alex-frankel
Copy link
Contributor

Adding this here for internal tracking of general documentation for UiForm: https://msazure.visualstudio.com/DefaultCollection/One/_workitems/edit/8654127

@alex-frankel
Copy link
Contributor

Here is the doc:
https://docs.microsoft.com/azure/azure-resource-manager/templates/template-specs-create-portal-forms

Going to close this for now. Let us know if you run into any issues.

@RiverHeart
Copy link

Hey guys, sorry for the necro but can someone comment on whether the ARM syntax that populates in the form actually resolves correctly when applied? So, if we have a resource group in "Central US" the following will resolve properly.

Location: [resourceGroup().location]

@alex-frankel
Copy link
Contributor

If you have a question specific to UI Form Definition, I would open an issue here:
https://github.com/Azure/portaldocs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants