Referens för CLI-variabler för Azure Deployment Environment

Artikel
04/17/2024

Azure Deployment Environments (ADE) anger många variabler som är relaterade till din miljö som du kan referera till när du redigerar anpassade avbildningar. Du kan använda variablerna nedan i åtgärdsskripten (deploy.sh eller delete.sh) för att göra bilderna flexibla för miljön de interagerar med.

För filer som används av ADE i containern finns alla i en ade undermapp utanför den ursprungliga katalogen.

Här är listan över tillgängliga miljövariabler:

ADE_ERROR_LOG

Refererar till filen som finns på /ade/temp/error.log. Filen error.log lagrar alla standardfelutdata som fyller i en miljös felinformation till följd av en misslyckad distribution eller borttagning. Filen används med ade execute, som registrerar standardutdata och standardfelinnehåll i en ADE-hanterad loggfil. När du använder ade execute kommandot omdirigerar du standardfelloggning till den här filplatsen med hjälp av följande kommando:

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

Med den här metoden kan du visa distributions- eller borttagningsfelet i utvecklarportalen. Detta leder till snabbare och mer lyckade felsökning av iterationer när du skapar din anpassade avbildning och snabbare diagnos av rotorsaken till den misslyckade åtgärden.

ADE_OUTPUTS

Refererar till filen som finns på /ade/temp/output.json. Filen output.json lagrar alla utdata från en miljös distribution i beständig lagring, så att den kan nås med hjälp av Azure CLI vid ett senare tillfälle. När du lagrar utdata i en anpassad avbildning kontrollerar du att utdata laddas upp till den angivna filen, enligt följande exempel:

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

Refererar till katalogen som finns på /ade/storage. Under kärnavbildningens startpunkt hämtar ADE en fil med ett särskilt namn storage.zip från miljöns lagringscontainer och fyller i den här katalogen och laddar sedan upp katalogen igen som en zip-fil tillbaka till lagringscontainern när åtgärden har slutförts. Om du har filer som du vill referera till i din anpassade avbildning vid efterföljande omdistributioner, till exempel tillståndsfiler, placerar du dem i den här katalogen.

ADE_CLIENT_ID

Refererar till objekt-ID för den hanterade tjänstidentiteten (MSI) för miljöns projektmiljötyp. Den här variabeln kan användas för att verifiera för Azure CLI för behörigheter att använda i containern, till exempel distribution av infrastruktur.

ADE_TENANT_ID

Refererar till klientorganisationens GUID för miljön.

ADE_SUBSCRIPTION_ID

Refererar till prenumerations-GUID för miljön.

ADE_TEMPLATE_FILE

Refererar till var huvudmallfilen som anges i egenskapen "templatePath" i miljödefinitionen finns i containern. Den här sökvägen speglar ungefär källkontrollen för var katalogen finns, beroende på vilken filsökvägsnivå du anslöt katalogen till. Filen finns ungefär på /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. Den här metoden används främst under huvuddistributionssteget eftersom filen som refereras till för att basera distributionen av.

Här är ett exempel med Hjälp av 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

Alla ytterligare filer, till exempel stöd för IaC-filer eller filer som du vill använda i din anpassade avbildning, lagras på deras relativa plats till mallfilen i containern eftersom de finns i katalogen. Ta till exempel följande katalog:

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

I det här fallet . $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicep Dessutom skulle filer som file1.bicep finnas i containern på /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.bicep, och test2.txt skulle finnas på /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txt.

ADE_ENVIRONMENT_NAME

Namnet på miljön som angavs vid distributionen.

ADE_ENVIRONMENT_LOCATION

Platsen där miljön distribueras. Den här platsen är projektets region.

ADE_RESOURCE_GROUP_NAME

Namnet på resursgruppen som skapats av ADE för att distribuera dina resurser till.

ADE_ENVIRONMENT_TYPE

Namnet på den projektmiljötyp som används för att distribuera den här miljön.

ADE_OPERATION_PARAMETERS

Ett JSON-objekt för de parametrar som tillhandahålls för att distribuera miljön. Ett exempel på parameterobjektet följer:

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

ADE_OPERATION_NAME

Vilken typ av åtgärd som utförs i miljön. I dag är det här värdet antingen "distribuera" eller "ta bort".

ADE_HTTP__OPERATIONID

Åtgärds-ID:t som tilldelats den åtgärd som utförs i miljön. Åtgärds-ID:t används som validering för att använda ADE CLI och är huvudidentifieraren för att hämta loggar från tidigare åtgärder.

ADE_HTTP__DEVCENTERID

Dev Center-ID för miljön. Dev Center-ID:t används också som validering för att använda ADE CLI.

Dela via