Referenz zu Cli-Variablen der Azure Deployment Environment

Artikel
04/17/2024

Azure Deployment Environments (ADE) legt viele Variablen im Zusammenhang mit Ihrer Umgebung fest, auf die Sie beim Erstellen von benutzerdefinierten Images verweisen können. Sie können die folgenden Variablen in den Vorgangsskripts (deploy.sh oder delete.sh) verwenden, um Ihre Bilder flexibel in der Umgebung zu gestalten, mit der sie interagieren.

Für Dateien, die von ADE im Container verwendet werden, sind alle in einem ade Unterordner aus dem anfänglichen Verzeichnis vorhanden.

Hier ist die Liste der verfügbaren Umgebungsvariablen:

ADE_ERROR_LOG

Bezieht sich auf die Datei, die sich in /ade/temp/error.log. Die error.log Datei speichert alle Standardfehlerausgabe, die die Fehlerdetails einer Umgebung im Ergebnis einer fehlgeschlagenen Bereitstellung oder Löschung auffüllt. Die Datei wird verwendet, mit ade executeder alle Standardausgabe- und Standardfehlerinhalte in einer ADE-verwalteten Protokolldatei aufgezeichnet werden. Wenn Sie den Befehl verwenden, leiten Sie die Standardfehlerprotokollierung mithilfe des ade execute folgenden Befehls an diesen Dateispeicherort um:

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

Mithilfe dieser Methode können Sie den Bereitstellungs- oder Löschfehler im Entwicklerportal anzeigen. Dies führt zu schnelleren und erfolgreicheren Debugging-Iterationen beim Erstellen des benutzerdefinierten Images und zur schnelleren Diagnose der Ursache für den fehlgeschlagenen Vorgang.

ADE_OUTPUTS

Bezieht sich auf die Datei, die sich in /ade/temp/output.json. Die output.json Datei speichert alle Ausgaben aus der Bereitstellung einer Umgebung im beständigen Speicher, sodass sie zu einem späteren Zeitpunkt über die Azure CLI aufgerufen werden kann. Stellen Sie beim Speichern der Ausgabe in einem benutzerdefinierten Bild sicher, dass die Ausgabe in die angegebene Datei hochgeladen wird, wie im folgenden Beispiel gezeigt:

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

Verweist auf das Verzeichnis, das sich unter /ade/storage. Während des Einstiegspunkts des Kernimages ruft ADE eine speziell benannte storage.zip Datei aus dem Speichercontainer der Umgebung ab und füllt dieses Verzeichnis und anschließend nach Abschluss des Vorgangs das Verzeichnis als ZIP-Datei zurück in den Speichercontainer. Wenn Sie dateien haben, auf die Sie in Ihrem benutzerdefinierten Image bei nachfolgenden erneuten Bereitstellungen verweisen möchten, z. B. Zustandsdateien, platzieren Sie sie in diesem Verzeichnis.

ADE_CLIENT_ID

Bezieht sich auf die Objekt-ID der Managed Service Identity (MSI) des Projektumgebungstyps der Umgebung. Diese Variable kann verwendet werden, um die Azure CLI zu überprüfen, um Berechtigungen für die Verwendung innerhalb des Containers zu erhalten, z. B. die Bereitstellung der Infrastruktur.

ADE_TENANT_ID

Verweist auf die Mandanten-GUID der Umgebung.

ADE_SUBSCRIPTION_ID

Bezieht sich auf die Abonnement-GUID der Umgebung.

ADE_TEMPLATE_FILE

Bezieht sich darauf, wo sich die in der Eigenschaft "templatePath" in der Umgebungsdefinition angegebene Standard Vorlagendatei im Container befindet. Dieser Pfad Spiegel die Quellcodeverwaltung des Katalogs, abhängig von der Dateipfadebene, an der Sie den Katalog angeschlossen haben. Die Datei befindet sich in etwa unter /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. Diese Methode wird hauptsächlich während des Standard Bereitstellungsschritts als Datei verwendet, auf die verwiesen wird, um die Bereitstellung zu stützen.

Beispiel für die Verwendung der Azure-Befehlszeilenschnittstelle:

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

Alle weiteren Dateien, z. B. die Unterstützung von IaC-Dateien oder Dateien, die Sie in Ihrem benutzerdefinierten Image verwenden möchten, werden an ihrem relativen Speicherort der Vorlagendatei innerhalb des Containers gespeichert, während sie sich im Katalog befinden. Nehmen Sie beispielsweise das folgende Verzeichnis:

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

In diesem Fall $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicep. Darüber hinaus befinden sich Dateien wie file1.bicep im Container unter /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.bicep, und test2.txt befinden sich unter /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txt.

ADE_ENVIRONMENT_NAME

Der Name der Umgebung, die zur Bereitstellungszeit angegeben wird.

ADE_ENVIRONMENT_LOCATION

Der Speicherort, an dem die Umgebung bereitgestellt wird. Dieser Standort ist die Region des Projekts.

ADE_RESOURCE_GROUP_NAME

Der Name der von ADE erstellten Ressourcengruppe, in der Ihre Ressourcen bereitgestellt werden sollen.

ADE_ENVIRONMENT_TYPE

Der Name des Projektumgebungstyps, der zum Bereitstellen dieser Umgebung verwendet wird.

ADE_OPERATION_PARAMETERS

Ein JSON-Objekt der Parameter, die zum Bereitstellen der Umgebung bereitgestellt werden. Ein Beispiel für das Parameterobjekt folgt:

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

ADE_OPERATION_NAME

Der Typ des Vorgangs, der in der Umgebung ausgeführt wird. Heute ist dieser Wert entweder "deploy" oder "delete".

ADE_HTTP__OPERATIONID

Die Vorgangs-ID, die dem Vorgang zugewiesen ist, der für die Umgebung ausgeführt wird. Die Vorgangs-ID wird als Überprüfung für die Verwendung der ADE CLI verwendet und ist der Standard Bezeichner beim Abrufen von Protokollen aus früheren Vorgängen.

ADE_HTTP__DEVCENTERID

Die Dev Center-ID der Umgebung. Die Dev Center-ID wird auch als Überprüfung für die Verwendung der ADE CLI verwendet.

Freigeben über