CreateUiDefinition. json voor het maken van beheerde Azure-toepassingenCreateUiDefinition.json for Azure managed application's create experience

Dit document introduceert de kernconcepten van het createUiDefinition.json-bestand dat Azure-portal gebruikt om de gebruikersinterface te definiëren bij het maken van een beheerde toepassing.This document introduces the core concepts of the createUiDefinition.json file which Azure portal uses to define the user interface when creating a managed application.

De sjabloon is als volgtThe template is as follows

{
   "$schema": "https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json#",
   "handler": "Microsoft.Azure.CreateUIDef",
   "version": "0.1.2-preview",
   "parameters": {
      "basics": [ ],
      "steps": [ ],
      "outputs": { },
      "resourceTypes": [ ]
   }
}

Een CreateUiDefinition bevat altijd drie eigenschappen:A CreateUiDefinition always contains three properties:

  • Handlerhandler
  • versieversion
  • parametersparameters

De handler moet Microsoft.Azure.CreateUIDefaltijd zijn, en 0.1.2-previewde nieuwste ondersteunde versie is .The handler should always be Microsoft.Azure.CreateUIDef, and the latest supported version is 0.1.2-preview.

Het schema van de eigenschap parameters is afhankelijk van de combinatie van de opgegeven handler en versie.The schema of the parameters property depends on the combination of the specified handler and version. Voor beheerde toepassingen worden basicsde stepsondersteunde outputseigenschappen , en .For managed applications, the supported properties are basics, steps, and outputs. De eigenschappen basis- en stappen bevatten de elementen - zoals tekstvakken en vervolgkeuzelijsten - die in de Azure-portal worden weergegeven.The basics and steps properties contain the elements - like textboxes and dropdowns - to be displayed in the Azure portal. De eigenschap uitvoer wordt gebruikt om de uitvoerwaarden van de opgegeven elementen toe te passen aan de parameters van de azure resource manager-implementatiesjabloon.The outputs property is used to map the output values of the specified elements to the parameters of the Azure Resource Manager deployment template.

Inclusief $schema is aanbevolen, maar optioneel.Including $schema is recommended, but optional. Indien opgegeven, moet version de waarde voor $schema de versie binnen de URI overeenkomen.If specified, the value for version must match the version within the $schema URI.

U een JSON-editor gebruiken om uw createUiDefinition te maken en deze vervolgens te testen in de createUiDefinition Sandbox om deze te bekijken.You can use a JSON editor to create your createUiDefinition then test it in the createUiDefinition Sandbox to preview it. Zie Uw portalinterface voor Azure Managed Applications testen voormeer informatie over de sandbox.For more information about the sandbox, see Test your portal interface for Azure Managed Applications.

BasisbeginselenBasics

Basisbeginselen is de eerste stap die wordt gegenereerd wanneer de Azure-portal het bestand ontleden.Basics is the first step generated when the Azure portal parses the file. Naast het weergeven van basicsde elementen die zijn opgegeven in , injecteert de portal elementen voor gebruikers om het abonnement, de brongroep en de locatie voor de implementatie te kiezen.In addition to displaying the elements specified in basics, the portal injects elements for users to choose the subscription, resource group, and location for the deployment. Indien mogelijk moeten elementen die parameters voor de implementatie van de implementatie opvragen, zoals de naam van een cluster of beheerdersreferenties, in deze stap worden gebruikt.When possible, elements that query deployment-wide parameters, like the name of a cluster or administrator credentials, should go in this step.

StappenSteps

De eigenschap stappen kan nul of meer extra stappen bevatten om na basisbeginselen weer te geven, die elk een of meer elementen bevatten.The steps property can contain zero or more additional steps to display after basics, each of which contains one or more elements. Overweeg stappen toe te voegen per rol of laag van de toepassing die wordt geïmplementeerd.Consider adding steps per role or tier of the application being deployed. Voeg bijvoorbeeld een stap toe voor hoofdknooppuntingangen en een stap voor de werknemersknooppunten in een cluster.For example, add a step for master node inputs, and a step for the worker nodes in a cluster.

UitvoerOutputs

De Azure-portal outputs gebruikt de basics eigenschap steps om elementen van en naar de parameters van de azure resource manager-implementatiesjabloon in kaart te brengen.The Azure portal uses the outputs property to map elements from basics and steps to the parameters of the Azure Resource Manager deployment template. De sleutels van dit woordenboek zijn de namen van de sjabloonparameters en de waarden zijn eigenschappen van de uitvoerobjecten van de naar de verwijzing genoemde elementen verwezen.The keys of this dictionary are the names of the template parameters, and the values are properties of the output objects from the referenced elements.

Als u de naam van de beheerde applicationResourceName toepassingsbron wilt instellen, moet u een waarde opnemen die is vernoemd in de eigenschap uitvoer.To set the managed application resource name, you must include a value named applicationResourceName in the outputs property. Als u deze waarde niet instelt, wijst de toepassing een GUID toe voor de naam.If you don't set this value, the application assigns a GUID for the name. U een tekstvak opnemen in de gebruikersinterface waarin een naam van de gebruiker wordt opgevraagd.You can include a textbox in the user interface that requests a name from the user.

"outputs": {
    "vmName": "[steps('appSettings').vmName]",
    "trialOrProduction": "[steps('appSettings').trialOrProd]",
    "userName": "[steps('vmCredentials').adminUsername]",
    "pwd": "[steps('vmCredentials').vmPwd.password]",
    "applicationResourceName": "[steps('appSettings').vmName]"
}

ResourcetypenResource types

Als u de beschikbare locaties wilt filteren op alleen de locaties die de te implementeren resourcetypen ondersteunen, geeft u een array van de resourcetypen.To filter the available locations to only those locations that support the resource types to deploy, provide an array of the resource types. Als u meer dan één resourcetype opgeeft, worden alleen de locaties die alle resourcetypen ondersteunen, geretourneerd.If you provide more than one resource type, only those locations that support all of the resource types are returned. Deze eigenschap is optioneel.This property is optional.

{
    "$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": ["Microsoft.Compute/disks"],
      "basics": [
        ...

FunctionsFunctions

CreateUiDefinition biedt functies voor het werken met de ingangen en uitgangen van elementen en functies zoals conditionalen.CreateUiDefinition provides functions for working with elements' inputs and outputs, and features such as conditionals. Deze functies zijn qua syntaxis en functionaliteit vergelijkbaar met sjabloonfuncties van Azure Resource Manager.These functions are similar in both syntax and functionality to Azure Resource Manager template functions.

Volgende stappenNext steps

Het bestand createUiDefinition.json zelf heeft een eenvoudig schema.The createUiDefinition.json file itself has a simple schema. De echte diepte van het komt van alle ondersteunde elementen en functies.The real depth of it comes from all the supported elements and functions. Deze items worden nader beschreven op:Those items are described in greater detail at:

Een actueel JSON-schema voor createUiDefinition is hier beschikbaar: https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json.A current JSON schema for createUiDefinition is available here: https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json.

Zie createUiDefinition.jsonvoor een voorbeeldvan user interface bestand .For an example user interface file, see createUiDefinition.json.