foundry-sample-env-config

name	foundry-sample-env-config
description	Microsoft Foundry サンプルで endpoint、deployment、認証値を扱うときに使う。ハードコードや endpoint 形状の取り違えを防ぐ。

Microsoft Foundry サンプル環境設定

目的

Microsoft Foundry を使うサンプルで、実 endpoint、deployment 名、資格情報をリポジトリに入れず、クライアント API が期待する endpoint 形状と環境変数名を明確にする。

使う場面

• Microsoft Foundry または Azure OpenAI compatible endpoint を使うサンプルを追加・変更するとき。
• FoundryChatClient、OpenAIChatClient、Responses API、Azure CLI 認証を扱うとき。
• ユーザー固有の endpoint、deployment 名、API key、resource 名が会話やローカル設定に出てきたとき。

手順

1. クライアント API が期待する endpoint 形状を公式ドキュメントまたは実装で確認する。
2. ユーザー固有の実値は .env や環境変数で読み込み、コード、README、テストには書かない。
3. .env.example にはプレースホルダーだけを書く。
4. 環境変数名は値の意味が分かる名前にする。例: FOUNDRY_OPENAI_BASE_URL、FOUNDRY_MODEL_DEPLOYMENT_NAME。
5. サンプル README に、必要な環境変数、認証方法、endpoint 形状を簡潔に書く。
6. テストでは実値が混入していないことと、設定を環境変数から読むことを確認する。

注意点

• Microsoft Foundry project endpoint、OpenAI-compatible base URL、Responses endpoint は同じではない。使うクライアントに合わせて必要な形を確認する。
• OpenAI Responses client の base_url には .../openai/v1 を渡し、末尾の /responses は含めない。
• az login による AzureCliCredential を使うサンプルでは、対象リソースへの権限が必要なことを明記する。
• 実 endpoint、deployment 名、resource 名、API key をコミットしてはいけない。