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

Cikk
05/22/2024

Ez a dokumentum bemutatja a createUiDefinition.json fájl alapvető fogalmait. Az 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": [ ]
    }
}

Az A CreateUiDefinition mindig három tulajdonságot tartalmaz:

kezelő
Verzió
parameters

A kezelőnek mindig a következőnek kell lennie, és a legújabb támogatott verziónak kell 0.1.2-previewlennieMicrosoft.Azure.CreateUIDef.

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őkconfig: , basicsstepsés outputs. Csak akkor használja config , ha felül kell bírálnia a lépés alapértelmezett viselkedését basics . Az alap- és lépéstulajdonságok tartalmazzák az Azure Portalon megjelenítendő elemeket ( például szövegdobozokat és legördülő listákat). A kimeneti tulajdonság a megadott elemek kimeneti értékeinek az Azure Resource Manager-sablon paramétereire való leképezésére szolgál.

Ajánlott, $schema de nem kötelező. Ha meg van adva, az értéknek version meg kell egyeznie az $schema URI-on belüli verzióval.

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 tekintse meg a portál felületének tesztelését 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 ezt használja, ez a createUiDefinition.json fájl szakaszának első tulajdonságaparameters. 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 lesz. 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 érvényesíté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, igaz értékre van állítva, az Alapismeretek lap elérhető, és az összes többi lap le van tiltva. Ha a Tovább gomb van kiválasztva, a lap ikonja jelzi, hogy egy lap ellenőrzése sikeres volt-e vagy nem sikerült. A tabulátor kötelező mezőinek befejezé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óval testre szabhatja az alapszintű lépéseket.

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

Az subscription elemek lehetővé resourceGroup teszik további érvényesítések megadását. Az érvényesítések megadásának szintaxisa megegyezik a szövegmező egyéni érvényesítésével. Az előfizetésen vagy az erőforráscsoporton is megadhat permission érvényesítési értékeket.

Az előfizetés-vezérlő elfogadja az erőforrás-szolgáltató névtereinek 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ónak nincs engedélye az erőforrás-szolgáltató regisztrálására.

Az erőforráscsoport-vezérlőnek lehetősége van a következőre allowExisting: . Amikor 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 ki kell választaniuk egy új vagy üres erőforráscsoportot. A legtöbb más forgatókönyvben nem szükséges megadni ezt a tulajdonságot.

Itt locationadhatja 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ékekre vannak beállítva. resourceTypes Teljes erőforrástípus-neveket tartalmazó karakterlánctö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 régiósztringek tömbjének elfogadása. Csak ezek a régiók jelennek meg a legördülő listában. Beállíthatja mindkettőt allowedValues és resourceTypes. Az eredmény mindkét lista metszete. Végül a visible tulajdonság használható a hely legördülő listájának feltételes vagy teljes letiltására. 

Alapvető beállítások

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

Alapismeretek 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 lépések tulajdonság nulla vagy több, az alapszintű lépések után megjelenítendő lépést tartalmaz. Minden lépés egy vagy több elemet tartalmaz. Fontolja meg az üzembe helyezett alkalmazás szerepköre vagy szintje szerinti lépések hozzáadását. Például adjon hozzá egy lépést az elsődleges csomópont bemeneteihez, és egy lépést a fürt feldolgozó csomópontjaihoz.

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

Kimenetek

Az Azure Portal a tulajdonságot használja az outputs Azure Resource Manager üzembehelyezési sablon elemeinek basicssteps és paramétereinek leképezésére. 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 tartalmaznia kell egy, a kimenetek tulajdonságban elnevezett applicationResourceName értéket. Ha nem állítja be ezt az értéket, az alkalmazás 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 opcionális.

{
    "$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 az olyan funkcióknak, mint a feltételes elemek használata. Ezek a függvények szintaxisban és funkciókban is hasonlóak az Azure Resource Manager-sablonfüggvényekhez.

Következő lépések

Maga a createUiDefinition.json fájl 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.

Például a felhasználói felület fájlja: createUiDefinition.json.

Share via