Sablon exportálása az Azure CLI használatával

  • Cikk

Az Azure Resource Manager-sablonok létrehozásának elősegítése érdekében exportálhat sablonokat meglévő erőforrásokból. Az exportált sablon segít megérteni az erőforrásokat üzembe helyező JSON-szintaxist és tulajdonságokat. A jövőbeli üzemelő példányok automatizálásához kezdje az exportált sablonnal, és módosítsa a forgatókönyvéhez. Az exportálási sablonfolyamat használható sablont próbál létrehozni. Az exportált sablonok többsége azonban csak bizonyos módosításokat igényel ahhoz, hogy az Azure-erőforrások üzembe helyezhetők legyenek.

Resource Manager lehetővé teszi egy vagy több erőforrás kiválasztását egy sablonba való exportáláshoz. A sablonban pontosan a szükséges erőforrásokra összpontosíthat.

Ez a cikk bemutatja, hogyan exportálhat sablonokat az Azure CLI-vel. További lehetőségekért lásd:

Válassza ki a megfelelő exportálási lehetőséget

Kétféleképpen exportálhat sablont:

  • Exportálás erőforráscsoportból vagy erőforrásból. Ez a beállítás új sablont hoz létre a meglévő erőforrásokból. Az exportált sablon az erőforráscsoport aktuális állapotának pillanatképe. Exportálhat egy teljes erőforráscsoportot vagy adott erőforrásokat az adott erőforráscsoporton belül.

  • Mentés az előzményekből. Ez a beállítás lekéri az üzembe helyezéshez használt sablon pontos másolatát. Az üzembe helyezést az üzembe helyezési előzményekből adhatja meg.

A választott lehetőségtől függően az exportált sablonok különböző tulajdonságokkal rendelkeznek.

Erőforráscsoportból vagy erőforrásból Előzményekből
A sablon automatikusan létre lesz hozva. A kód üzembe helyezése előtt valószínűleg javítania kell a kódot. A sablon a sablon szerzője által létrehozott példány pontos másolata. Készen áll az újbóli üzembe helyezésre módosítások nélkül.
A sablon az erőforrások aktuális állapotának pillanatképe. Az üzembe helyezés után végrehajtott manuális módosításokat is tartalmazza. A sablon csak az erőforrások állapotát jeleníti meg az üzembe helyezéskor. Az üzembe helyezés után végzett manuális módosítások nem szerepelnek a fájlban.
Kiválaszthatja, hogy mely erőforrásokat szeretné exportálni egy erőforráscsoportból. Az adott üzemelő példányhoz tartozó összes erőforrást tartalmazza a rendszer. Nem választhatja ki az erőforrások egy részét, és nem adhat hozzá más időpontban hozzáadott erőforrásokat.
A sablon tartalmazza az erőforrások összes tulajdonságát, beleértve azokat a tulajdonságokat is, amelyek általában nem lennének beállítva az üzembe helyezés során. Előfordulhat, hogy a sablon újbóli használata előtt el szeretné távolítani vagy törölni ezeket a tulajdonságokat. A sablon csak az üzembe helyezéshez szükséges tulajdonságokat tartalmazza. A sablon ritkább és könnyebben olvasható.
A sablon valószínűleg nem tartalmazza az újrafelhasználáshoz szükséges összes paramétert. A legtöbb tulajdonságérték nehezen kódolt a sablonban. A sablon más környezetekben való ismételt üzembe helyezéséhez olyan paramétereket kell hozzáadnia, amelyek növelik az erőforrások konfigurálásának képességét. Megszüntetheti a Paraméterek belefoglalása jelölőnégyzet jelölését, hogy saját paramétereket is létrehozhatjon. A sablon olyan paramétereket tartalmaz, amelyek megkönnyítik a különböző környezetekben való ismételt üzembe helyezést.

Exportálja a sablont egy erőforráscsoportból vagy erőforrásból, ha:

  • Rögzítenie kell az eredeti üzembe helyezés után végrehajtott erőforrások módosításait.
  • Ki szeretné választani, hogy mely erőforrások legyenek exportálva.
  • Az erőforrások nem sablonnal lettek létrehozva.

Exportálja a sablont az előzményekből, amikor:

  • Könnyen újrafelhasználható sablont szeretne.
  • Az eredeti üzembe helyezés után végzett módosításokat nem kell belefoglalnia.

Korlátozások

Az exportálás nem garantáltan sikeres. Az exportálás nem megbízható módja annak, hogy a meglévő erőforrásokat éles környezetben használható sablonokká alakítsuk. Jobb, ha teljesen új erőforrásokat hoz létre kézzel írt Bicep-fájl, ARM-sablon vagy terraform használatával.

Erőforráscsoportból vagy erőforrásból való exportáláskor az exportált sablon az egyes erőforrástípusok közzétett sémáiból jön létre. Időnként előfordulhat, hogy a séma nem rendelkezik az erőforrástípus legújabb verziójával. Ellenőrizze az exportált sablont, hogy tartalmazza-e a szükséges tulajdonságokat. Ha szükséges, szerkessze az exportált sablont a szükséges API-verzió használatához.

Előfordulhat, hogy egyes jelszóparaméterek hiányoznak az exportált sablonokból. Az erőforrások üzembe helyezéséhez ellenőriznie kell a sablonreferenciát, és manuálisan kell hozzáadnia ezeket a paramétereket.

Az exportálási sablon funkció nem támogatja Azure Data Factory erőforrások exportálását. A Data Factory-erőforrások exportálásának módjáról az Adat-előállító másolása vagy klónozása Azure Data Factory című témakörben olvashat.

A klasszikus üzemi modellel létrehozott erőforrások exportálásához migrálnia kell őket a Resource Manager üzemi modellbe.

Ha egy olyan sablon exportálásakor figyelmeztetést kap, amely azt jelzi, hogy egy erőforrástípus nem lett exportálva, akkor is felfedezheti az adott erőforrás tulajdonságait. Az erőforrás-tulajdonságokért lásd a sablonreferenciát. Az erőforrástípushoz tartozó Azure REST API-t is megtekintheti.

Az exportált sablont létrehozó erőforráscsoportban legfeljebb 200 erőforrás lehet. Ha több mint 200 erőforrással rendelkező erőforráscsoportot próbál exportálni, a hibaüzenet Export template is not supported for resource groups more than 200 resources jelenik meg.

Sablon exportálása erőforráscsoportból

Az erőforráscsoport sikeres beállítása után exportálhat egy Azure Resource Manager-sablont az erőforráscsoporthoz.

Egy erőforráscsoport összes erőforrásának exportálásához használja az az group export parancsot, és adja meg az erőforráscsoport nevét.

az group export --name demoGroup

A szkript megjeleníti a sablont a konzolon. Fájlba való mentéshez használja a következőt:

az group export --name demoGroup > exportedtemplate.json

Az erőforráscsoport összes erőforrásának exportálása helyett kiválaszthatja, hogy mely erőforrásokat szeretné exportálni.

Egy erőforrás exportálásához adja meg az erőforrás-azonosítót.

storageAccountID=$(az resource show --resource-group demoGroup --name demostg --resource-type Microsoft.Storage/storageAccounts --query id --output tsv)
az group export --resource-group demoGroup --resource-ids $storageAccountID

Ha egynél több erőforrást szeretne exportálni, adja át a térelválasztó erőforrásazonosítókat. Az összes erőforrás exportálásához ne adja meg ezt az argumentumot, és ne adja meg a "*" értéket.

az group export --resource-group <resource-group-name> --resource-ids $storageAccountID1 $storageAccountID2

A sablon exportálásakor megadhatja, hogy a rendszer paramétereket használ-e a sablonban. Alapértelmezés szerint az erőforrásnevek paraméterei is szerepelnek, de nem rendelkeznek alapértelmezett értékkel.

"parameters": {
  "serverfarms_demoHostPlan_name": {
    "type": "String"
  },
  "sites_webSite3bwt23ktvdo36_name": {
    "type": "String"
  }
}

Ha a paramétert használja --skip-resource-name-params a sablon exportálásakor, az erőforrásnevek paraméterei nem szerepelnek a sablonban. Ehelyett az erőforrás neve közvetlenül az erőforráson van beállítva az aktuális értékre. A név nem szabható testre az üzembe helyezés során.

"resources": [
  {
    "type": "Microsoft.Web/serverfarms",
    "apiVersion": "2022-09-01",
    "name": "demoHostPlan",
    ...
  }
]

Ha a paramétert a --include-parameter-default-value sablon exportálásakor használja, a sablonparaméter tartalmaz egy alapértelmezett értéket, amely az aktuális értékre van állítva. Használhatja ezt az alapértelmezett értéket, vagy felülírhatja az alapértelmezett értéket egy másik érték megadásával.

"parameters": {
  "serverfarms_demoHostPlan_name": {
    "defaultValue": "demoHostPlan",
    "type": "String"
  },
  "sites_webSite3bwt23ktvdo36_name": {
    "defaultValue": "webSite3bwt23ktvdo36",
    "type": "String"
  }
}

Sablon mentése az üzembe helyezési előzményekből

A sablonokat az üzembe helyezési előzményekben mentheti egy üzemelő példányból. A kapott sablon pontosan az üzembe helyezéshez használt sablon.

Ha sablont szeretne lekérni egy erőforráscsoport üzemelő példányából, használja az az deployment group export parancsot. Meg kell adnia a lekérni kívánt üzemelő példány nevét. Az üzembe helyezés nevének lekérésével kapcsolatos segítségért lásd: Üzembehelyezési előzmények megtekintése az Azure Resource Manager.

az deployment group export --resource-group demoGroup --name demoDeployment

A sablon megjelenik a konzolon. A fájl mentéséhez használja a következőt:

az deployment group export --resource-group demoGroup --name demoDeployment > demoDeployment.json

Ha más szinteken szeretné üzembe helyezni a sablonokat, használja a következőt:

Következő lépések