Informazioni di riferimento sulle variabili dell'interfaccia della riga di comando dell'ambiente di distribuzione di Azure

Articolo
04/17/2024

Ambienti di distribuzione di Azure (ADE) imposta molte variabili correlate all'ambiente a cui è possibile fare riferimento durante la creazione di immagini personalizzate. È possibile usare le variabili seguenti all'interno degli script dell'operazione (deploy.sh o delete.sh) per rendere le immagini flessibili per l'ambiente con cui interagiscono.

Per i file usati da ADE all'interno del contenitore, tutti sono presenti in una ade sottocartella della directory iniziale.

Ecco l'elenco delle variabili di ambiente disponibili:

ADE_ERROR_LOG

Fa riferimento al file che si trova in /ade/temp/error.log. Il error.log file archivia qualsiasi output di errore standard che popola i dettagli dell'errore di un ambiente in seguito a una distribuzione o a un'eliminazione non riuscita. Il file viene usato con ade execute, che registra qualsiasi output standard e contenuto di errore standard in un file di log gestito da ADE. Quando si usa il comando , reindirizzare la ade execute registrazione degli errori standard a questo percorso di file usando il comando seguente:

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

Usando questo metodo, è possibile visualizzare l'errore di distribuzione o eliminazione all'interno del portale per sviluppatori. Ciò comporta un debug più rapido e più efficace durante la creazione dell'immagine personalizzata e una diagnosi più rapida della causa radice per l'operazione non riuscita.

ADE_OUTPUTS

Fa riferimento al file che si trova in /ade/temp/output.json. Il output.json file archivia tutti gli output della distribuzione di un ambiente in una risorsa di archiviazione permanente, in modo che sia accessibile usando l'interfaccia della riga di comando di Azure in un secondo momento. Quando si archivia l'output in un'immagine personalizzata, assicurarsi che l'output venga caricato nel file specificato, come illustrato nell'esempio seguente:

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

Fa riferimento alla directory che si trova in /ade/storage. Durante il punto di ingresso dell'immagine principale, ADE esegue il pull di un file denominato storage.zip appositamente dal contenitore di archiviazione dell'ambiente e popola questa directory e quindi al completamento dell'operazione, ricarica la directory come file ZIP nel contenitore di archiviazione. Se si dispone di file a cui si vuole fare riferimento all'interno dell'immagine personalizzata nelle ridistribuzioni successive, ad esempio i file di stato, inserirli all'interno di questa directory.

ADE_CLIENT_ID

Fa riferimento all'ID oggetto dell'identità del servizio gestito del tipo di ambiente di progetto dell'ambiente. Questa variabile può essere usata per convalidare l'interfaccia della riga di comando di Azure per le autorizzazioni da usare all'interno del contenitore, ad esempio la distribuzione dell'infrastruttura.

ADE_TENANT_ID

Fa riferimento al GUID tenant dell'ambiente.

ADE_SUBSCRIPTION_ID

Fa riferimento al GUID della sottoscrizione dell'ambiente.

ADE_TEMPLATE_FILE

Fa riferimento al punto in cui il file modello principale specificato nella proprietà 'templatePath' nella definizione dell'ambiente risiede all'interno del contenitore. Questo percorso rispecchia approssimativamente il controllo del codice sorgente in cui il catalogo, a seconda del livello di percorso del file a cui è stato connesso il catalogo. Il file si trova approssimativamente in /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. Questo metodo viene usato principalmente durante il passaggio di distribuzione principale come file a cui si fa riferimento per basare la distribuzione.

Di seguito è riportato un esempio basato sull'uso dell'interfaccia della riga di comando di 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

Eventuali altri file, ad esempio i file IaC di supporto o i file che si desidera usare nell'immagine personalizzata, vengono archiviati nel percorso relativo al file modello all'interno del contenitore così come si trovano all'interno del catalogo. Ad esempio, prendere la directory seguente:

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

In questo caso, $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicep. Inoltre, i file come file1.bicep si trovano all'interno del contenitore in /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.bicepe test2.txt si trovano in /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txt.

ADE_ENVIRONMENT_NAME

Nome dell'ambiente specificato in fase di distribuzione.

ADE_ENVIRONMENT_LOCATION

Percorso in cui viene distribuito l'ambiente. Questa località è l'area del progetto.

ADE_RESOURCE_GROUP_NAME

Nome del gruppo di risorse creato da ADE in cui distribuire le risorse.

ADE_ENVIRONMENT_TYPE

Nome del tipo di ambiente del progetto utilizzato per distribuire questo ambiente.

ADE_OPERATION_PARAMETERS

Oggetto JSON dei parametri forniti per distribuire l'ambiente. Di seguito è riportato un esempio dell'oggetto parameters:

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

ADE_OPERATION_NAME

Tipo di operazione eseguita nell'ambiente. Attualmente, questo valore è "deploy" o "delete".

ADE_HTTP__OPERATIONID

ID operazione assegnato all'operazione eseguita nell'ambiente. L'ID operazione viene usato come convalida per usare l'interfaccia della riga di comando di ADE ed è l'identificatore principale nel recupero dei log dalle operazioni precedenti.

ADE_HTTP__DEVCENTERID

ID dev Center dell'ambiente. L'ID dev Center viene usato anche come convalida per usare l'interfaccia della riga di comando di Ade.

Condividi tramite