Dokumentacja zmiennych interfejsu wiersza polecenia środowiska wdrażania platformy Azure

Artykuł
04/17/2024

Środowiska wdrażania platformy Azure (ADE) ustawia wiele zmiennych związanych ze środowiskiem, do których można się odwoływać podczas tworzenia obrazów niestandardowych. Poniższe zmienne można używać w skryptach operacji (deploy.sh lub delete.sh), aby obrazy były elastyczne w środowisku, z którym korzystają.

W przypadku plików używanych przez program ADE w kontenerze wszystkie istnieją w ade podfolderze poza katalogiem początkowym.

Oto lista dostępnych zmiennych środowiskowych:

ADE_ERROR_LOG

Odwołuje się do pliku znajdującego się w lokalizacji /ade/temp/error.log. Plik error.log przechowuje wszystkie standardowe dane wyjściowe błędów, które wypełniają szczegóły błędu środowiska w wyniku nieudanego wdrożenia lub usunięcia. Plik jest używany z ade executeprogramem , który rejestruje wszystkie standardowe dane wyjściowe i standardową zawartość błędu do pliku dziennika zarządzanego przez program ADE. W przypadku korzystania z polecenia przekieruj ade execute standardowe rejestrowanie błędów do tej lokalizacji pliku przy użyciu następującego polecenia:

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

Za pomocą tej metody można wyświetlić błąd wdrożenia lub usunięcia w portalu deweloperów. Prowadzi to do szybszego i pomyślnego debugowania iteracji podczas tworzenia obrazu niestandardowego i szybszej diagnostyki głównej przyczyny nieudanej operacji.

ADE_OUTPUTS

Odwołuje się do pliku znajdującego się w lokalizacji /ade/temp/output.json. Plik output.json przechowuje wszystkie dane wyjściowe z wdrożenia środowiska w magazynie trwałym, aby można było uzyskać do niego dostęp przy użyciu interfejsu wiersza polecenia platformy Azure w późniejszym terminie. Podczas przechowywania danych wyjściowych w obrazie niestandardowym upewnij się, że dane wyjściowe są przekazywane do określonego pliku, jak pokazano w poniższym przykładzie:

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

Odwołuje się do katalogu znajdującego się w lokalizacji /ade/storage. Podczas punktu wejścia obrazu podstawowego program ADE ściąga specjalnie nazwany storage.zip plik z kontenera magazynu środowiska i wypełnia ten katalog, a następnie po zakończeniu operacji ponownie ładuje katalog jako plik zip z powrotem do kontenera magazynu. Jeśli masz pliki, do których chcesz się odwołać w obrazie niestandardowym w kolejnych ponownych wdrożeniach, takich jak pliki stanu, umieść je w tym katalogu.

ADE_CLIENT_ID

Odwołuje się do identyfikatora obiektu tożsamości usługi zarządzanej (MSI) typu środowiska projektu. Ta zmienna może służyć do weryfikowania interfejsu wiersza polecenia platformy Azure pod kątem uprawnień do korzystania z kontenera, takich jak wdrażanie infrastruktury.

ADE_TENANT_ID

Odwołuje się do identyfikatora GUID dzierżawy środowiska.

ADE_SUBSCRIPTION_ID

Odwołuje się do identyfikatora GUID subskrypcji środowiska.

ADE_TEMPLATE_FILE

Odwołuje się do miejsca, w którym główny plik szablonu określony we właściwości "templatePath" w definicji środowiska znajduje się w kontenerze. Ta ścieżka z grubsza odzwierciedla kontrolę źródła, gdzie wykaz, w zależności od poziomu ścieżki pliku połączonego z wykazem. Plik znajduje się w przybliżeniu w lokalizacji /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. Ta metoda jest używana głównie podczas głównego kroku wdrażania, ponieważ plik, do którego odwołuje się plik, do którego odwołuje się wdrożenie.

Oto przykład użycia interfejsu wiersza polecenia platformy Azure:

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

Wszelkie dodatkowe pliki, takie jak obsługa plików IaC lub plików, które mają być używane w obrazie niestandardowym, są przechowywane w ich względnej lokalizacji do pliku szablonu wewnątrz kontenera, ponieważ znajdują się one w katalogu. Na przykład skorzystaj z następującego katalogu:

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

W tym przypadku . $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicep Ponadto pliki, takie jak file1.bicep, znajdują się w kontenerze w /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.biceplokalizacji , a test2.txt znajdują się w /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txtlokalizacji .

ADE_ENVIRONMENT_NAME

Nazwa środowiska podanego w czasie wdrażania.

ADE_ENVIRONMENT_LOCATION

Lokalizacja, w której jest wdrażane środowisko. Ta lokalizacja jest regionem projektu.

ADE_RESOURCE_GROUP_NAME

Nazwa grupy zasobów utworzonej przez program ADE w celu wdrożenia zasobów.

ADE_ENVIRONMENT_TYPE

Nazwa typu środowiska projektu używanego do wdrożenia tego środowiska.

ADE_OPERATION_PARAMETERS

Obiekt JSON parametrów dostarczonych do wdrożenia środowiska. Przykład obiektu parameters jest następujący:

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

ADE_OPERATION_NAME

Typ operacji wykonywanej w środowisku. Obecnie ta wartość to "deploy" lub "delete".

ADE_HTTP__OPERATIONID

Identyfikator operacji przypisany do operacji wykonywanej w środowisku. Identyfikator operacji jest używany jako walidacja do korzystania z interfejsu wiersza polecenia usługi ADE i jest głównym identyfikatorem pobierania dzienników z poprzednich operacji.

ADE_HTTP__DEVCENTERID

Identyfikator Centrum deweloperów środowiska. Identyfikator Centrum deweloperów jest również używany jako walidacja do korzystania z interfejsu wiersza polecenia usługi ADE.

Udostępnij za pośrednictwem