Referenční informace k proměnným rozhraní příkazového řádku azure deployment environment

Článek
04/17/2024

Prostředí nasazení Azure (ADE) nastavuje mnoho proměnných souvisejících s vaším prostředím, na které můžete při vytváření vlastních imagí odkazovat. Následující proměnné můžete použít ve skriptech operací (deploy.sh nebo delete.sh), aby byly vaše image flexibilní pro prostředí, se kterým pracují.

Pro soubory používané službou ADE v rámci kontejneru existují všechny v ade podsložce mimo počáteční adresář.

Tady je seznam dostupných proměnných prostředí:

ADE_ERROR_LOG

Odkazuje na soubor umístěný na /ade/temp/error.logadrese . Soubor error.log ukládá standardní výstup chyby, který naplní podrobnosti o chybě prostředí ve výsledku neúspěšného nasazení nebo odstranění. Tento soubor se používá se záznamem ade executestandardního výstupu a standardního obsahu chyb do souboru protokolu spravovaného službou ADE. Při použití ade execute příkazu přesměrujte standardní protokolování chyb do tohoto umístění souboru pomocí následujícího příkazu:

ade execute --operation $ADE_OPERATION_NAME --command "{YOUR_COMMAND}" 2> >(tee -a $ADE_ERROR_LOG)

Pomocí této metody můžete zobrazit chybu nasazení nebo odstranění na portálu pro vývojáře. To vede k rychlejšímu a úspěšnějšímu ladění iterací při vytváření vlastní image a rychlejší diagnostice původní příčiny neúspěšné operace.

ADE_OUTPUTS

Odkazuje na soubor umístěný na /ade/temp/output.jsonadrese . Soubor output.json ukládá všechny výstupy z nasazení prostředí do trvalého úložiště, aby k němu bylo možné přistupovat pomocí Azure CLI později. Při ukládání výstupu do vlastní image se ujistěte, že se výstup nahraje do zadaného souboru, jak je znázorněno v následujícím příkladu:

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

Odkazuje na adresář umístěný na /ade/storageadrese . Během vstupního bodu základní image ADE stáhne speciálně pojmenovaný storage.zip soubor z kontejneru úložiště prostředí a naplní tento adresář a pak při dokončení operace znovu načte adresář jako soubor ZIP zpět do kontejneru úložiště. Pokud máte soubory, na které chcete odkazovat ve vlastní imagi při následných opětovném nasazení, například stavových souborů, umístěte je do tohoto adresáře.

ADE_CLIENT_ID

Odkazuje na ID objektu identity spravované služby (MSI) typu prostředí projektu prostředí. Tuto proměnnou můžete použít k ověření v Azure CLI pro oprávnění k využití v rámci kontejneru, jako je nasazení infrastruktury.

ADE_TENANT_ID

Odkazuje na identifikátor GUID tenanta prostředí.

ADE_SUBSCRIPTION_ID

Odkazuje na identifikátor GUID předplatného prostředí.

ADE_TEMPLATE_FILE

Odkazuje na to, kde se nachází hlavní soubor šablony zadaný ve vlastnosti templatePath v definici prostředí v kontejneru. Tato cesta přibližně zrcadlí správu zdrojového kódu umístění katalogu v závislosti na úrovni cesty k souboru, na které jste katalog připojili. Soubor je zhruba umístěn v /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. Tato metoda se používá primárně během hlavního kroku nasazení jako soubor odkazovaný na základ nasazení.

Tady je příklad použití Azure CLI:

az deployment group create --subscription $ADE_SUBSCRIPTION_ID \
    --resource-group "$ADE_RESOURCE_GROUP_NAME" \
    --name "$deploymentName" \
    --no-prompt true --no-wait \
    --template-file "$ADE_TEMPLATE_FILE" \
    --parameters "$deploymentParameters" \
    --only-show-errors

Všechny další soubory, jako je podpora souborů IaC nebo souborů, které chcete použít ve vlastní imagi, se ukládají v relativním umístění k souboru šablony uvnitř kontejneru, protože jsou v katalogu. Například použijte následující adresář:

├───SampleCatalog
   ├───EnvironmentDefinition1
      │   file1.bicep
      │   main.bicep
      │   environment.yaml
      │
      └───TestFolder
              test1.txt
              test2.txt

V tomto případě . $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicep Soubory jako file1.bicep by se navíc nacházely v kontejneru at /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.bicepa test2.txt by se nacházely v /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txtumístění .

ADE_ENVIRONMENT_NAME

Název prostředí zadaného v době nasazení.

ADE_ENVIRONMENT_LOCATION

Umístění, kam se prostředí nasazuje. Toto umístění je oblast projektu.

ADE_RESOURCE_GROUP_NAME

Název skupiny prostředků vytvořené službou ADE pro nasazení prostředků do.

ADE_ENVIRONMENT_TYPE

Název typu prostředí projektu, který se používá k nasazení tohoto prostředí.

ADE_OPERATION_PARAMETERS

Objekt JSON parametrů zadaných k nasazení prostředí. Příklad objektu parametrů:

{
    "location": "locationInput",
    "name": "nameInput",
    "sampleObject": {
        "sampleProperty": "sampleValue"
    },
    "sampleArray": [
        "sampleArrayValue1",
        "sampleArrayValue2"
    ]
}

ADE_OPERATION_NAME

Typ operace prováděné v prostředí. Dnes je tato hodnota buď "deploy", nebo "delete".

ADE_HTTP__OPERATIONID

ID operace přiřazené operaci prováděné v prostředí. ID operace se používá jako ověřování pro použití rozhraní příkazového řádku ADE a je hlavním identifikátorem při načítání protokolů z minulých operací.

ADE_HTTP__DEVCENTERID

ID vývojového centra prostředí. ID Dev Center se také používá jako ověřování pro použití rozhraní příkazového řádku ADE.

Sdílet prostřednictvím