Introduzione a CreateUiDefinition

Questo documento illustra i concetti di base di CreateUiDefinition, che consente al portale di Azure di generare l'interfaccia utente per la creazione di un'applicazione gestita.

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

CreateUiDefinition contiene sempre tre proprietà:

  • handler
  • version
  • Parametri

Per le applicazioni gestite la proprietà handler deve essere sempre Microsoft.Compute.MultiVm e la versione supportata più recente è 0.1.2-preview.

Lo schema della proprietà parameters dipende dalla combinazione delle proprietà handler e version specificate. Per le applicazioni gestite sono supportate le proprietà basics, steps e outputs. Le proprietà basics e steps contengono elementi, ad esempio caselle di testo ed elenchi a discesa, da visualizzare nel portale di Azure. La proprietà outputs viene usata per il mapping dei valori di output degli elementi specificati ai parametri del modello di distribuzione Azure Resource Manager.

L'inclusione di $schema è consigliata ma facoltativa. Se specificato, il valore per la proprietà version deve corrispondere alla versione nell'URI di $schema.

Nozioni di base

Il passaggio relativo alle informazioni di base è sempre il primo passaggio della procedura guidata generata quando il portale di Azure analizza CreateUiDefinition. Oltre a visualizzare gli elementi specificati in basics, il portale inserisce elementi che consentono agli utenti di scegliere la sottoscrizione, il gruppo di risorse e la posizione della distribuzione. In genere gli elementi che eseguono query per parametri a livello di distribuzione, ad esempio il nome di un cluster o le credenziali dell'amministratore, devono essere inseriti in questo passaggio.

Se il comportamento di un elemento dipende dalla sottoscrizione, dal gruppo di risorse o dalla posizione dell'utente, non è possibile usare tale elemento per le proprietà basics. Ad esempio, Microsoft.Compute.SizeSelector dipende dalla sottoscrizione e dalla posizione dell'utente per la determinazione dell'elenco delle dimensioni disponibili. È quindi possibile usare Microsoft.Compute.SizeSelector solo nelle proprietà steps. In genere è possibile usare nelle proprietà basics solo gli elementi disponibili nello spazio dei nomi Microsoft.Common. Sono tuttavia consentiti alcuni elementi disponibili in altri spazi dei nomi, ad esempio Microsoft.Compute.Credentials, che non dipendono dal contesto dell'utente.

Passi

La proprietà steps può contenere zero o più passaggi aggiuntivi da visualizzare dopo la proprietà basics, ognuna delle quali contiene uno o più elementi. Prendere in considerazione l'aggiunta di passaggi per ogni ruolo o livello dell'applicazione in fase di distribuzione. Aggiungere ad esempio un passaggio per gli input dei nodi master e un passaggio per i nodi di lavoro in un cluster.

Output

Il portale di Azure usa la proprietà outputs per il mapping di elementi da basics e steps ai parametri del modello di distribuzione Azure Resource Manager. Le chiavi di questo dizionario sono i nomi dei parametri del modello e i valori sono le proprietà degli oggetti di output dagli elementi a cui si fa riferimento.

Funzioni

Analogamente alle funzioni del modello in Azure Resource Manager, a livello di sintassi e di funzionalità, CreateUiDefinition offre funzioni per l'uso di input e output degli elementi, oltre a funzionalità quali le istruzioni condizionali.

Passaggi successivi

CreateUiDefinition ha uno schema semplice, ma supporta numerosi elementi e funzioni, illustrati in modo dettagliato nei documenti seguenti:

Per uno schema JSON corrente per CreateUiDefinition, vedere qui: https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json.

Le versioni più aggiornate verranno rese disponibili nello stesso percorso. Sostituire la parte 0.1.2-preview dell'URL e il valore version con l'identificatore della versione da usare. Gli identificatori attualmente supportati per la versione sono 0.0.1-preview, 0.1.0-preview, 0.1.1-preview e 0.1.2-preview.