Azure Deployment Environment CLI 変数リファレンス

[アーティクル]
04/17/2024

Azure Deployment Environment (ADE) では、カスタムイメージの作成時に参照できる環境に関連する多くの変数が設定されます。操作スクリプト (deploy.sh または delete.sh) 内で次の変数を使用して、対話する環境に合わせてイメージを柔軟にすることができます。

コンテナー内の ADE によって使用されるファイルの場合、すべて初期ディレクトリのサブフォルダーに存在 ade します。

使用可能な環境変数の一覧を次に示します。

ADE_ERROR_LOG

にあるファイル /ade/temp/error.logを参照します。このファイルには error.log 、デプロイまたは削除に失敗した結果として、環境のエラーの詳細を設定する標準エラー出力が格納されます。このファイルは、標準出力と標準エラーの内容を ADE で管理されたログファイルに記録するために使用 ade executeされます。コマンドを使用する場合は、次の ade execute コマンドを使用して、標準エラーログをこのファイルの場所にリダイレクトします。

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

この方法を使用すると、開発者ポータル内でデプロイまたは削除のエラーを表示できます。これにより、カスタムイメージを作成するときのデバッグイテレーションが迅速かつ成功し、失敗した操作の根本原因の診断が迅速になります。

ADE_OUTPUTS

にあるファイル /ade/temp/output.jsonを参照します。このファイルは output.json 、環境のデプロイからの出力を永続ストレージに格納するため、後日 Azure CLI を使用してアクセスできます。カスタムイメージに出力を格納する場合は、次の例に示すように、出力が指定したファイルにアップロードされていることを確認します。

echo "$deploymentOutput" > $ADE_OUTPUTS

ADE_STORAGE

にあるディレクトリ /ade/storageを参照します。コアイメージのエントリポイント中に、ADE は環境のストレージコンテナーから特別な名前 storage.zip のファイルをプルダウンし、このディレクトリにデータを設定し、操作が完了したら、ディレクトリを zip ファイルとしてストレージコンテナーに再アップロードします。状態ファイルなどの後続の再デプロイ時にカスタムイメージ内で参照するファイルがある場合は、このディレクトリ内に配置します。

ADE_CLIENT_ID

環境のプロジェクト環境の種類のマネージドサービス ID (MSI) のオブジェクト ID を参照します。この変数を使用して、インフラストラクチャのデプロイなど、コンテナー内で使用するアクセス許可を Azure CLI に対して検証できます。

ADE_TENANT_ID

環境のテナント GUID を参照します。

ADE_SUBSCRIPTION_ID

環境のサブスクリプション GUID を参照します。

ADE_TEMPLATE_FILE

環境定義の 'templatePath' プロパティで指定されたメインテンプレートファイルがコンテナー内に存在する場所を参照します。このパスは、カタログを接続したファイルパスレベルに応じて、カタログのソース管理をほぼミラーします。ファイルは大まかに位置しています /ade/repository/{CATALOG_NAME}/{PATH_TO_TEMPLATE_FILE}. この方法は、主にメイン展開手順中に、デプロイのベースとなるファイルとして使用されます。

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

カスタムイメージで使用する IaC ファイルやファイルのサポートなど、その他のファイルは、カタログ内のコンテナー内のテンプレートファイルに対する相対位置に格納されます。たとえば、次のディレクトリを使用します。

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

例では、 $ADE_TEMPLATE_FILE=/ade/repository/SampleCatalog/EnvironmentDefinition1/main.bicepが使用されます。さらに、file1.bicep などのファイルはコンテナー /ade/repository/SampleCatalog/EnvironmentDefinition1/file1.bicep内にあり、test2.txtは /ade/repository/SampleCatalog/EnvironmentDefinition1/TestFolder/test2.txt.

ADE_ENVIRONMENT_NAME

デプロイ時に指定された環境の名前。

ADE_ENVIRONMENT_LOCATION

環境がデプロイされている場所。この場所はプロジェクトのリージョンです。

ADE_RESOURCE_GROUP_NAME

リソースをデプロイする ADE によって作成されたリソースグループの名前。

ADE_ENVIRONMENT_TYPE

この環境のデプロイに使用されるプロジェクト環境の種類の名前。

ADE_OPERATION_PARAMETERS

環境をデプロイするために指定されたパラメーターの JSON オブジェクト。 parameters オブジェクトの例を次に示します。

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

ADE_OPERATION_NAME

環境で実行されている操作の種類。現在、この値は 'deploy' または 'delete' です。

ADE_HTTP__OPERATIONID

環境で実行されている操作に割り当てられた操作 ID。操作 ID は、ADE CLI を使用するための検証として使用され、過去の操作からログを取得するメイン識別子です。

ADE_HTTP__DEVCENTERID

環境のデベロッパーセンター ID。デベロッパーセンター ID は、ADE CLI を使用するための検証としても使用されます。

次の方法で共有