CreateUiDefinition.json az Azure-beli felügyelt példány létrehozási felületéhez

Cikk
06/01/2023

Ez a dokumentum bemutatja a createUiDefinition.json fájl alapvető fogalmait . A Azure Portal ezzel a fájllal határozza meg a felhasználói felületet egy felügyelt alkalmazás létrehozásakor.

A sablon a következő:

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

A CreateUiDefinition mindig három tulajdonságot tartalmaz:

Kezelő
version
parameters

A kezelőnek mindig a -nek kell lennie, és a legújabb támogatott verziónak kell lennieMicrosoft.Azure.CreateUIDef0.1.2-preview.

A paraméterek tulajdonság sémája a megadott kezelő és verzió kombinációjától függ. Felügyelt alkalmazások esetén a támogatott tulajdonságok a következők config: , basics, stepsés outputs. Csak akkor használja config , ha felül kell bírálnia a basics lépés alapértelmezett viselkedését. Az alap- és lépéstulajdonságok tartalmazzák a Azure Portal megjelenítendő elemeket , például a szövegdobozokat és a legördülő listákat. A outputs tulajdonság a megadott elemek kimeneti értékeinek az Azure Resource Manager-sablon paramétereire való leképezésére szolgál.

A beleértés $schema ajánlott, de nem kötelező. Ha meg van adva, a értékének version meg kell egyeznie az URI verziójával $schema .

JSON-szerkesztővel létrehozhatja a createUiDefinition parancsot, majd tesztelheti a createUiDefinition tesztkörnyezetben az előnézet megtekintéséhez. A tesztkörnyezettel kapcsolatos további információkért lásd : A portál felületének tesztelése az Azure Managed Applicationshez.

Konfigurálás

A config tulajdonság megadása nem kötelező. Ezzel felülbírálhatja az alapszintű lépés alapértelmezett viselkedését, vagy beállíthatja a felületet lépésenkénti varázslóként. Ha config használatban van, ez az első tulajdonság a createUiDefinition.json fájl szakaszában parameters . Az alábbi példa az elérhető tulajdonságokat mutatja be.

"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
        }
    }
},

isValid A tulajdonsághoz írjon egy kifejezést, amely igaz vagy hamis értéket ad vissza. permission A tulajdonsághoz adja meg az erőforrás-szolgáltatói műveletek egyikét.

Varázsló

A isWizard tulajdonság lehetővé teszi az egyes lépések sikeres ellenőrzését, mielőtt továbblép a következő lépésre. Ha a isWizard tulajdonság nincs megadva, az alapértelmezett érték hamis, és nincs szükség részletes ellenőrzésre.

Ha isWizard engedélyezve van, állítsa true (igaz) értékre, az Alapbeállítások lap elérhető, és az összes többi lap le van tiltva. Ha a Tovább gomb van kijelölve, a lap ikonja jelzi, hogy egy lap érvényesítése sikeres vagy sikertelen volt-e. A lap kötelező mezőinek kitöltése és ellenőrzése után a Tovább gomb lehetővé teszi a következő lapra való navigálást. Ha az összes lap megfelel az ellenőrzésnek, lépjen a Véleményezés és létrehozás lapra, és válassza a Létrehozás gombot az üzembe helyezés megkezdéséhez.

Tab varázsló

Alapismeretek felülbírálása

Az alapszintű konfiguráció lehetővé teszi az alapszintű lépések testreszabását.

A esetében descriptionadjon meg egy markdown-kompatibilis sztringet, amely leírja az erőforrást. A többsoros formátum és a hivatkozások támogatottak.

A subscription és resourceGroup az elem lehetővé teszi további ellenőrzések megadását. Az érvényesítések megadásának szintaxisa megegyezik a szövegmező egyéni érvényesítésének szintaxisával. Az előfizetésben vagy az erőforráscsoportban is megadhatja permission az érvényesítéseket.

Az előfizetés-vezérlő elfogadja az erőforrás-szolgáltatói névterek listáját. Megadhatja például a Microsoft.Compute értéket. Hibaüzenet jelenik meg, amikor a felhasználó olyan előfizetést választ ki, amely nem támogatja az erőforrás-szolgáltatót. A hiba akkor fordul elő, ha az erőforrás-szolgáltató nincs regisztrálva az előfizetésben, és a felhasználó nem rendelkezik engedéllyel az erőforrás-szolgáltató regisztrálásához.

Az erőforráscsoport-vezérlőnek van egy lehetősége a következőre: allowExisting. A használatakor truea felhasználók kiválaszthatják azokat az erőforráscsoportokat, amelyek már rendelkeznek erőforrásokkal. Ez a jelző leginkább a megoldássablonokra vonatkozik, ahol az alapértelmezett viselkedés azt írja elő, hogy a felhasználóknak új vagy üres erőforráscsoportot kell választaniuk. A legtöbb más forgatókönyvben nincs szükség a tulajdonság megadására.

A esetében locationadja meg a felülbírálni kívánt helyvezérlő tulajdonságait. A felül nem bírált tulajdonságok az alapértelmezett értékükre vannak beállítva. resourceTypes a teljes erőforrástípusneveket tartalmazó sztringtömböt fogad el. A helybeállítások csak az erőforrástípusokat támogató régiókra korlátozódnak. allowedValues A a régiósztringek tömböt fogadja el. A legördülő menüben csak ezek a régiók jelennek meg. A és resourceTypesa értékét is allowedValues beállíthatja. Az eredmény mindkét lista metszete. Végül a visible tulajdonság használatával feltételesen vagy teljesen letilthatja a hely legördülő menüjét. 

Alapvető beállítások

Az Alapszintű lépés az első lépés, amely akkor jön létre, amikor a Azure Portal elemzi a fájlt. Alapértelmezés szerint az alapszintű lépéssel a felhasználók kiválaszthatják az előfizetést, az erőforráscsoportot és az üzembe helyezés helyét.

Alapszintű beállítások alapértelmezett

Ebben a szakaszban további elemeket is hozzáadhat. Ha lehetséges, adjon hozzá olyan elemeket, amelyek az üzembe helyezés egészére kiterjedő paramétereket kérdeznek le, például a fürt nevét vagy a rendszergazdai hitelesítő adatokat.

Az alábbi példa egy szövegdobozt mutat be, amely hozzá lett adva az alapértelmezett elemekhez.

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

Lépések

A steps tulajdonság nulla vagy több, az alapismeretek után megjelenítendő lépést tartalmaz. Minden lépés egy vagy több elemet tartalmaz. Fontolja meg a lépések hozzáadását az üzembe helyezett alkalmazás szerepköre vagy szintje szerint. Például adjon hozzá egy lépést az elsődleges csomópont bemeneteihez, és egy lépést a fürt munkavégző csomópontjaihoz.

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

Kimenetek

A Azure Portal a tulajdonságot használja az outputs azure Resource Manager üzembehelyezési sablon elemeinek basicssteps és paramétereinek leképezéséhez. A szótár kulcsai a sablonparaméterek nevei, az értékek pedig a hivatkozott elemek kimeneti objektumainak tulajdonságai.

A felügyelt alkalmazás erőforrásnevének beállításához meg kell adnia egy nevű applicationResourceName értéket a outputs tulajdonságban. Ha nem állítja be ezt az értéket, az alkalmazás egy GUID azonosítót rendel a névhez. Felvehet egy szövegdobozt a felhasználói felületre, amely nevet kér a felhasználótól.

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

Erőforrástípusok

Ha az elérhető helyeket csak azokra a helyekre szeretné szűrni, amelyek támogatják az üzembe helyezendő erőforrástípusokat, adja meg az erőforrástípusok tömbét. Ha egynél több erőforrástípust ad meg, csak azokat a helyeket adja vissza, amelyek támogatják az összes erőforrástípust. Ez a tulajdonság nem kötelező.

{
    "$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

A CreateUiDefinition függvényeket biztosít az elemek bemeneteinek és kimeneteinek, valamint olyan funkcióknak a használatához, mint a feltételes beállítások. Ezek a függvények a szintaxisban és a funkciókban is hasonlítanak az Azure Resource Manager-sablonfüggvényekhez.

Következő lépések

Maga a createUiDefinition.json fájl egy egyszerű sémával rendelkezik. A valódi mélysége az összes támogatott elemből és funkcióból származik. Ezeket az elemeket részletesebben a következő helyen ismertetjük:

A createUiDefinition aktuális JSON-sémája itt érhető el: https://schema.management.azure.com/schemas/0.1.2-preview/CreateUIDefinition.MultiVm.json.

Egy példa felhasználói felületi fájlra: createUiDefinition.json.