Azure Deployment Environments CLI-referencia

Ez a cikk az Egyéni rendszerképek Azure Deployment Environments (ADE) alaprendszerképek használatával történő létrehozásához elérhető parancsokat ismerteti.

Az ADE CLI használatával kezelheti a környezettel kapcsolatos információkat, valamint a környezet meghatározott definícióját, feltöltését és elérését, a környezethez kapcsolódó korábban feltöltött fájlok elérését, több naplózást rögzíthet a végrehajtási művelettel kapcsolatban, valamint feltöltheti és elérheti a környezet központi telepítésének kimeneteit.

Milyen parancsokat használhatok?

Az ADE CLI jelenleg a következő parancsokat támogatja:

Az ADE CLI-parancsok meghívásáról a csatolt dokumentációban talál további információt.

ade definíciók parancskészlete

A ade definitions parancs lehetővé teszi a felhasználó számára, hogy megtekintse a környezethez választott definícióval kapcsolatos információkat, és letöltse a kapcsolódó fájlokat, például az elsődleges és a csatolt IaC-sablonokat egy megadott fájlhelyre.

A következő parancsok a parancskészleten belül találhatók:

ade definíciók listája

A listaparancs a következőképpen lesz meghívva:

definitionValue=$(ade definitions list)

Ez a parancs a környezetdefiníció különböző tulajdonságait leíró adatobjektumot ad vissza.

Visszatérési típus

Ez a parancs egy, a környezetdefiníciót leíró JSON-objektumot ad vissza. Íme egy példa a visszatérési objektumra az egyik mintakörnyezet-definíciónk alapján:

{
    "id": "/projects/PROJECT_NAME/catalogs/CATALOG_NAME/environmentDefinitions/appconfig",
    "name": "AppConfig",
    "catalogName": "CATALOG_NAME",
    "description": "Deploys an App Config.",
    "parameters": [
        {
            "id": "name",
            "name": "name",
            "description": "Name of the App Config",
            "type": "string",
            "readOnly": false,
            "required": true,
            "allowed": []
        },
        {
            "id": "location",
            "name": "location",
            "description": "Location to deploy the environment resources",
            "default": "westus3",
            "type": "string",
            "readOnly": false,
            "required": false,
            "allowed": []
        }
    ],
    "parametersSchema": "{\"type\":\"object\",\"properties\":{\"name\":{\"title\":\"name\",\"description\":\"Name of the App Config\"},\"location\":{\"title\":\"location\",\"description\":\"Location to deploy the environment resources\",\"default\":\"westus3\"}},\"required\":[\"name\"]}",
    "templatePath": "CATALOG_NAME/AppConfig/appconfig.bicep",
    "contentSourcePath": "CATALOG_NAME/AppConfig"
}

Visszaadott tulajdonságértékek használata

A visszaadott definíciós JSON-objektum bizonyos tulajdonságaihoz környezeti változókat rendelhet a JQ-kódtár használatával (az ADE által létrehozott képeken előre telepítve) a következő formátummal:
environment_name=$(echo $definitionValue | jq -r ".name")

A speciális szűrésről és a JQ-kódtár egyéb felhasználási módjairól itt olvashat bővebben.

ade definíciók letöltése

Ezt a parancsot a következő módon hívjuk meg:
ade definitions download --folder-path EnvironmentDefinition

Ez a parancs letölti a fő és csatolt IaC-sablonokat, valamint a megadott sablonnal társított egyéb fájlokat.

Beállítások

--folder-path: A környezetdefiníciós fájlok letöltésének elérési útja. Ha nincs megadva, a parancs egy EnvironmentDefinition nevű mappában tárolja a fájlokat az aktuális könyvtár szintjén a végrehajtáskor.

Milyen fájlokhoz van hozzáférésem?

A parancs meghívásakor a katalógustárban a környezetdefiníció jegyzékfájljának (environment.yaml vagy manifest.yaml) szintjén vagy alatt tárolt fájlok elérhetők.

A környezetdefiníciók és a katalógus adattárszerkezetének megismeréséről az alábbi hivatkozásokon tudhat meg többet:

Emellett a fájlok a tárolóban is elérhetők lesznek a következő címen /ade/repository/{YOUR_CATALOG_NAME}/{RELATIVE_DIRECTORY_TO_MANIFEST}: . Ha például a Katalógus1 nevű katalógusként csatlakoztatott adattárban a jegyzékfájl a Folder1/Folder2/environment.yaml mappában lesz tárolva, a fájlok a következő tárolóban /ade/repository/Catalog1/Folder1/Folder2lesznek jelen: . Az ADE automatikusan hozzáadja ezeket a fájlokat ehhez a fájlhelyhez, mivel az üzembe helyezés vagy törlés sikeres végrehajtásához szükséges.

ade environment command

A ade environment parancs lehetővé teszi a felhasználó számára a környezettel kapcsolatos információk megtekintését, amelyen a műveletet végrehajtják.

A parancs a következőképpen lesz meghívva:

environmentValue=$(ade environment)

Ez a parancs a környezet különböző tulajdonságait leíró adatobjektumot ad vissza.

Visszatérési típus

Ez a parancs egy, a környezetet leíró JSON-objektumot ad vissza. Íme egy példa a visszatérési objektumra:

{
    "uri": "https://TENANT_ID-DEVCENTER_NAME.DEVCENTER_REGION.devcenter.azure.com/projects/PROJECT_NAME/users/USER_ID/environments/ENVIRONMENT_NAME",
    "name": "ENVIRONMENT_NAME",
    "environmentType": "ENVIRONMENT_TYPE",
    "user": "USER_ID",
    "provisioningState": "PROVISIONING_STATE",
    "resourceGroupId": "/subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP_NAME",
    "catalogName": "CATALOG_NAME",
    "environmentDefinitionName": "ENVIRONMENT_DEFINITION_NAME",
    "parameters": {
        "location": "locationInput",
        "name": "nameInput"
    },
    "location": "regionForDeployment"
}

Visszaadott tulajdonságértékek használata

A visszaadott definíciós JSON-objektum bizonyos tulajdonságaihoz környezeti változókat rendelhet a JQ-kódtár használatával (az ADE által létrehozott képeken előre telepítve) a következő formátummal:
environment_name=$(echo $environment | jq -r ".name")

A speciális szűrésről és a JQ-kódtár egyéb felhasználási módjairól itt olvashat bővebben.

ade execute command

A ade execute parancs implicit naplózást biztosít a tárolóban végrehajtott szkriptekhez. Ily módon a parancs során létrehozott szabványos kimeneti vagy szabványos hibatartalmak naplózva lesznek a művelet naplófájljában a környezet számára, és az Azure CLI használatával érhetők el.

A parancs minden szabványos hibáját a $ADE_ERROR_LOG környezeti változóban megadott hibanapló-fájlba kell beszűkítenie, hogy a környezeti hiba részletei könnyen kitölthetőek és felszínre kerüljenek a fejlesztői portálon.

Beállítások

--operation: Sztringbemenet, amely megadja a paranccsal végrehajtott műveletet. Ezt az információt általában a $ADE_OPERATION_NAME környezeti változóval adja meg.

--command: A végrehajtásra és a naplózás rögzítésére szolgáló parancs.

Példák

Ez a parancs a következő deploy.sh hajtja végre:

ade execute --operation $ADE_OPERATION_NAME --command "./deploy.sh" 2> >(tee -a $ADE_ERROR_LOG)

ade files parancskészlet

A ade files parancskészlet lehetővé teszi az ügyfél számára, hogy fájlokat töltsön fel és töltsön le a végrehajtó műveleti tárolóban, hogy egy adott környezet később használhassa a tárolóban vagy a későbbi műveletek végrehajtásában. Ez a parancskészlet az egyes IaC-szolgáltatókhoz létrehozott állapotfájlok feltöltésére is használható.

A következő parancsok a parancskészleten belül találhatók:

ade fájlok listája

Ez a parancs felsorolja a letölthető fájlokat a környezeti tárolóban.

Visszatérési típus

Ez a parancs sztringek tömbjeként visszaadja a letölthető fájlokat. Íme egy példa:

[
    "file1.txt",
    "file2.sh",
    "file3.zip"
]

ade fájlok letöltése

Ez a parancs letölt egy kijelölt fájlt egy megadott fájlhelyre a végrehajtó tárolón belül.

Beállítások

--file-name: A letölteni kívánt fájl neve. Ennek a fájlnévnek szerepelnie kell a parancsból visszaadott elérhető fájlok listájában ade files list . Ez a beállítás kötelező.

--folder-path: A fájl tárolón belüli letöltésének elérési útja. Ez az elérési út nem kötelező, és a parancssori felület alapértelmezés szerint letölti a fájlt az aktuális könyvtárba a parancs végrehajtásakor.

--unzip: Állítsa be ezt a jelzőt, ha le szeretne tölteni egy zip-fájlt az elérhető fájlok listájából, és azt szeretné, hogy a tartalom kibontva legyen a megadott mappahelyre.

Példák

A következő parancs letölt egy fájlt az aktuális könyvtárba:

ade files download --file-name file1.txt

Az alábbi parancs letölt egy fájlt egy alacsonyabb szintű mappába, a mappa1 mappába.

ade files download --file-name file1.txt --folder-path folder1

Az utolsó parancs letölt egy zip-fájlt, és kibontja a fájl tartalmát az aktuális könyvtárba:

ade files download --file-name file3.zip --unzip

ade fájlok feltöltése

Ez a parancs feltölt egy megadott egyedi fájlt, vagy egy mappaelérési útvonalként megadott zip mappát a környezet számára elérhető fájlok listájára.

Beállítások

--file-path: Annak az elérési útja, ahol a fájl létezik az aktuális könyvtárból a feltöltéshez. Ez a beállítás vagy a --folder-path parancs végrehajtásához szükséges.

--folder-path: Annak az elérési útja, ahol a mappa létezik az aktuális könyvtárból zip-fájlként való feltöltéshez. Az eredményként kapott akadálymentes fájl a legalacsonyabb mappa neve alatt érhető el. Ez a beállítás vagy a --file-path parancs végrehajtásához szükséges.

Jótanács

Ha a parancs környezetének meglévő akadálymentes fájljával azonos nevű fájlt vagy mappát ad meg, felülírja a korábban mentett fájlt (vagyis ha file1.txt egy meglévő akadálymentes fájl, a ade files --file-path file1.txt végrehajtás felülírja a korábban mentett fájlt).

Példák

Az alábbi parancs feltölt egy fájlt az aktuálisfile1.txtnevű könyvtárból:

ade files upload --file-path "file1.txt"

Ez a fájl később elérhető a következő futtatásával:

ade files download --file-name "file1.txt"

Az alábbi parancs az aktuális mappa1 könyvtárnál egy szinttel alacsonyabb mappát tölt fel egyfolder1.zipnevű zip-fájlként:

ade files upload --folder-path "folder1"

Végül a következő parancs feltölt egy mappát az aktuális könyvtárnál két szinttel alacsonyabb mappába1/mappa2 mappába egy folder2.zipnevű zip-fájlként:

ade files upload --folder-path "folder1/folder2"

ade init parancs

A ade init parancs az ADE tárolójának inicializálására szolgál a szükséges környezeti változók beállításával és az üzembe helyezéshez megadott környezetdefiníció letöltésével. Maga a parancs a rendszerhéjparancsokat nyomtatja ki, amelyeket a rendszer a következő paranccsal értékel ki az alapvető belépési ponton:

eval $(ade init)

Ezt a parancsot csak egyszer kell futtatni. Ha az egyéni rendszerképet az ADE által létrehozott képek bármelyikére alapozja, nem kell újrafuttatnia ezt a parancsot.

ade log command set

A ade log parancsok a művelet végrehajtásával kapcsolatos részletek rögzítésére szolgálnak a környezetben, a tárolón belül. Ez a parancs számos különböző naplózási szintet kínál, amelyek azután érhetők el, hogy a művelet befejeződik az elemzéshez, és az ügyfél különböző fájlokat adhat meg a különböző naplózási forgatókönyvek naplózásához.

Az ADE naplózza az összes olyan utasítást, amely a tárolón belül szabványos kimenetre vagy standard hibastreamekre ad ki kimenetet. Ezzel a funkcióval naplókat tölthet fel az ügyfél által megadott fájlokba, amelyek a fő műveleti naplóktól elkülönítve tekinthetők meg.

Beállítások

--content: A naplózni kívánt adatokat tartalmazó karakterlánc-bemenet. Ehhez a parancshoz ez a beállítás szükséges.

--type: A napló szintje (részletes, napló vagy hiba) a tartalom naplózásához. Ha nincs megadva, a parancssori felület naplózza a tartalmat a napló szintjén.

--file: Az a fájl, amelybe a tartalmat naplózni szeretné. Ha nincs megadva, a parancssori felület egy .log fájlba naplóz, amelyet a végrehajtó művelet egyedi műveleti azonosítója határoz meg.

Példák

Ez a parancs egy sztringet naplóz az alapértelmezett naplófájlba:

ade log --content "This is a log"

Ez a parancs hibát naplóz az alapértelmezett naplófájlban:

ade log --type error --content "This is an error."

Ez a parancs naplóz egy sztringet egy megadott,specialLogFile.txtnevű fájlba:

ade log --content "This is a special log." --file "specialLogFile.txt"

ade operation-result parancs

A ade operation-result parancs lehetővé teszi a hiba részleteinek hozzáadását a művelet meghiúsulása esetén üzemeltetett környezethez, és frissíti a folyamatban lévő műveletet.

A parancs a következőképpen lesz meghívva:

ade operation-result --code "ExitCode" --message "The operation failed!"

Beállítások

--code: A kilépési kódot részletező sztring, amely a művelet meghiúsulását okozza

--message: A művelethiba hibaüzenetét részletező sztring.

Fontos

Ezt a műveletet csak a tárolóból való kilépés előtt szabad használni, mivel a művelet sikertelen állapotban való beállítása nem teszi lehetővé más parancssori felületi parancsok sikeres végrehajtását.

ade outputs command set

A ade outputs parancs lehetővé teszi, hogy az ügyfél egy IaC-sablon üzembe helyezéséből származó kimeneteket töltsön fel az ADE-hez készült Outputs API-ból.

ade kimenetek feltöltése

Ez a parancs feltölti egy ADE EnvironmentOutput formátumban megadott JSON-fájl tartalmát a környezetbe, amelyet később az Outputs API for ADE használatával érhet el.

Beállítások

--file: A feltöltendő JSON-objektumot tartalmazó fájlhely.

Példák

Ez a parancs feltölt egy .jsonoutputs.json nevű fájlt a környezetbe, amely a sikeres üzembe helyezés kimeneteként szolgál:

ade outputs upload --file outputs.json

EnvironmentOutputs formátum

Ahhoz, hogy a bejövő JSON-fájl megfelelően szerializálható legyen, és a környezetek üzembehelyezési kimeneteként elfogadható legyen, a beküldött objektumnak az alábbi struktúrát kell követnie:

{
    "outputs": {
        "output1": {
            "type": "string",
            "value": "This is output 1!",
            "sensitive": false
        },
        "output2": {
            "type": "int",
            "value": 22,
            "sensitive": false
        },
        "output3": {
            "type": "string",
            "value": "This is a sensitive output",
            "sensitive": true
        }
    }
}

Ez a formátum az ARM-sablon üzembe helyezésének jelentéskimenetéből, valamint egy bizalmas tulajdonságból van kialakítva. A bizalmas tulajdonság nem kötelező, de korlátozza a kimenet megtekintését a kiemelt hozzáféréssel rendelkező felhasználók, például a környezet létrehozója számára.

A kimenetek elfogadható típusai a következők: "sztring", "int", "logikai", "tömb" és "objektum".

Kimenetek elérése

A kimenetek tárolón belüli vagy végrehajtás utáni eléréséhez az ügyfél használhatja az Outputs API for ADE-t, amely az API-végpont meghívásával vagy az AZ CLI használatával érhető el.

A tárolón belüli kimenetek eléréséhez az ügyfélnek telepítenie kell az Azure CLI-t a rendszerképére (előre telepítve az ADE által létrehozott képeken), és futtatnia kell a következő parancsokat:

az login
az devcenter dev environment show-outputs --dev-center-name DEV_CENTER_NAME --project-name PROJECT_NAME --environment-name ENVIRONMENT_NAME

Támogatás

Jelentse be a problémát.

Az ADE dokumentációja

Kapcsolódó tartalom

  • Last updated on