Soubor createUiDefinition.json pro prostředí pro vytváření spravovaných aplikací Azure

Tento dokument představuje základní koncepty createUiDefinition.jsv souboru. Azure Portal používá tento soubor k definování uživatelského rozhraní při vytváření spravované aplikace.

Tato šablona je následující:

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

CreateUiDefinitionVždy obsahuje tři vlastnosti:

• popisovač
• verze
• parameters

Obslužná rutina by měla být vždycky Microsoft.Azure.CreateUIDef a nejnovější podporovaná verze je 0.1.2-preview .

Schéma vlastnosti Parameters závisí na kombinaci zadané obslužné rutiny a verze. U spravovaných aplikací jsou podporované vlastnosti config , basics , a steps outputs . Použijete config pouze v případě, že potřebujete přepsat výchozí chování basics kroku. Základní a postupové vlastnosti obsahují prvky , jako jsou textová pole a rozevírací seznamy, které se mají zobrazit v Azure Portal. Vlastnost Outputs slouží k mapování výstupních hodnot určených prvků na parametry šablony Azure Resource Manager.

Zahrnutí $schema je doporučeno, ale volitelné. Je-li tento parametr zadán, musí hodnota pro version odpovídat verzi v $schema identifikátoru URI.

Pomocí editoru JSON můžete vytvořit createUiDefinition a potom ho otestovat v izolovaném prostoru createUiDefinition a zobrazit jeho náhled. Další informace o izolovaném prostoru naleznete v tématu Test rozhraní portálu pro Azure Managed Applications.

Config

configVlastnost je nepovinná. Použijte ji k přepsání výchozího chování kroku základy nebo k nastavení rozhraní jako podrobného průvodce. Pokud config se použije, je to první vlastnost v oddílu createUiDefinition.jsv souboru parameters . Následující příklad ukazuje dostupné vlastnosti.

"config": {
    "isWizard": false,
    "basics": {
        "description": "Customized description with **markdown**, see [more](https://www.microsoft.com).",
        "subscription": {
            "constraints": {
                "validations": [
                    {
                        "isValid": "[not(contains(subscription().displayName, 'Test'))]",
                        "message": "Can't use test subscription."
                    },
                    {
                        "permission": "Microsoft.Compute/virtualmachines/write",
                        "message": "Must have write permission for the virtual machine."
                    },
                    {
                        "permission": "Microsoft.Compute/virtualMachines/extensions/write",
                        "message": "Must have write permission for the extension."
                    }
                ]
            },
            "resourceProviders": [
                "Microsoft.Compute"
            ]
        },
        "resourceGroup": {
            "constraints": {
                "validations": [
                    {
                        "isValid": "[not(contains(resourceGroup().name, 'test'))]",
                        "message": "Resource group name can't contain 'test'."
                    }
                ]
            },
            "allowExisting": true
        },
        "location": {
            "label": "Custom label for location",
            "toolTip": "provide a useful tooltip",
            "resourceTypes": [
                "Microsoft.Compute/virtualMachines"
            ],
            "allowedValues": [
                "eastus",
                "westus2"
            ],
            "visible": true
        }
    }
},

Pro isValid vlastnost napište výraz, který se přeloží na hodnotu true nebo false. U permission Vlastnosti zadejte jednu z akcí poskytovatele prostředků.

Tip

Tato isWizard vlastnost vám umožní před pokračováním na další krok vyžadovat úspěšné ověření každého kroku. Pokud isWizard vlastnost není zadána, výchozí hodnota je false a podrobné ověřování není vyžadováno.

Pokud isWizard je povoleno, nastavte na hodnotu true, karta základy je k dispozici a všechny ostatní karty jsou zakázané. Když je vybráno tlačítko Další , ikona karty indikuje, zda bylo ověření karty úspěšné nebo selhalo. Po dokončení a ověření povinných polí karty bude tlačítko Další umožňovat navigaci na další kartu. Když všechny karty projdou ověřením, můžete přejít na stránku Kontrola a vytvoření a kliknutím na tlačítko vytvořit zahájit nasazení.

Základní informace o potlačení

Základní konfigurace umožňuje přizpůsobit krok základy.

Pro description Zadejte řetězec s podporou Markdownu, který popisuje váš prostředek. Podporují se víceřádkové formáty a odkazy.

subscriptionPrvky a resourceGroup umožňují zadat více ověření. Syntaxe pro určení platnosti je shodná s vlastním ověřením pro textové pole. Můžete také zadat permission ověřování pro předplatné nebo skupinu prostředků.

Řízení předplatného přijímá seznam oborů názvů poskytovatele prostředků. Můžete například zadat Microsoft. COMPUTE. Pokud uživatel vybere předplatné, které nepodporují poskytovatele prostředků, zobrazí se chybová zpráva. K této chybě dojde, pokud poskytovatel prostředků není v tomto předplatném zaregistrován a uživatel nemá oprávnění k registraci poskytovatele prostředků.

Ovládací prvek skupina prostředků má možnost pro allowExisting . Když true Uživatelé můžou vybrat skupiny prostředků, které už mají prostředky. Tento příznak je nejvhodnější pro šablony řešení, kde výchozí chování vyžaduje, aby uživatelé vybrali novou nebo prázdnou skupinu prostředků. Ve většině dalších scénářů je zadání této vlastnosti nepotřebné.

Pro location Zadejte vlastnosti ovládacího prvku umístění, který chcete přepsat. Všechny vlastnosti, které nejsou přepsány, jsou nastaveny na výchozí hodnoty. resourceTypes přijímá pole řetězců obsahující plně kvalifikované názvy typů prostředků. Možnosti umístění jsou omezené jenom na oblasti, které podporují typy prostředků.  allowedValues   přijímá pole řetězců oblastí. V rozevíracím seznamu se zobrazí pouze tyto oblasti.Můžete nastavit i allowedValues    resourceTypes . Výsledkem je průnik obou seznamů. Nakonec visible lze vlastnost použít k podmíněnému nebo úplnému vypnutí rozevíracího seznamu umístění. 

Základy

Základní krok je prvním krokem vygenerovaným při analýze souboru Azure Portal. Ve výchozím nastavení umožňuje krok základy uživatelům zvolit předplatné, skupinu prostředků a umístění pro nasazení.

V této části můžete přidat další prvky. Pokud je to možné, přidejte prvky, které dotazují parametry pro nasazení na úrovni, jako je název clusteru nebo přihlašovací údaje správce.

Následující příklad ukazuje textové pole, které bylo přidáno do výchozích prvků.

"basics": [
    {
        "name": "textBox1",
        "type": "Microsoft.Common.TextBox",
        "label": "Textbox on basics",
        "defaultValue": "my text value",
        "toolTip": "",
        "visible": true
    }
]

Postup

Vlastnost kroky obsahuje nula nebo více kroků, které se zobrazí po základech. Každý krok obsahuje jeden nebo více prvků. Zvažte přidání kroků na roli nebo vrstvu nasazené aplikace. Přidejte například krok pro vstupy primárního uzlu a krok pro pracovní uzly v clusteru.

"steps": [
    {
        "name": "demoConfig",
        "label": "Configuration settings",
        "elements": [
          ui-elements-needed-to-create-the-instance
        ]
    }
]

Výstupy

Azure Portal používá outputs vlastnost k mapování prvků z basics a steps na parametry šablony nasazení Azure Resource Manager. Klíče tohoto slovníku jsou názvy parametrů šablony a hodnoty jsou vlastnosti výstupních objektů z odkazovaných prvků.

Chcete-li nastavit název prostředku spravované aplikace, je nutné zahrnout hodnotu s názvem applicationResourceName ve vlastnosti výstupy. Pokud tuto hodnotu nenastavíte, aplikace přiřadí identifikátor GUID pro název. Do uživatelského rozhraní můžete zahrnout textové pole, které požádá o jméno od uživatele.

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

Typy prostředků

Chcete-li filtrovat dostupná umístění pouze do těch umístění, která podporují typy prostředků, které mají být nasazeny, zadejte pole typů prostředků. Pokud zadáte více než jeden typ prostředku, vrátí se pouze ta umístění, která podporují všechny typy prostředků. Tato vlastnost je nepovinná.

{
    "$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": [
          ...

Functions

CreateUiDefinition poskytuje funkce pro práci s vstupy a výstupy prvků a funkcemi, jako jsou podmíněné. Tyto funkce jsou podobné v syntaxi a funkcích pro Azure Resource Manager funkcí šablon.

Další kroky

createUiDefinition.jsv samotném souboru má jednoduché schéma. Skutečná hloubka se nachází ze všech podporovaných elementů a funkcí. Tyto položky jsou popsány podrobněji na adrese:

• Elements
• Functions

Aktuální schéma JSON pro createUiDefinition je k dispozici zde: https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json .

Příklad souboru uživatelského rozhraní naleznete v tématu createUiDefinition.json.