快速入門: 使用 Azure 應用程式組態建立 .NET Framework 應用程式

有兩種將 Azure 應用程式組態併入 .NET Framework 型應用程式的方式。

  • 應用程式組態的設定建立器可讓應用程式組態的資料載入至應用程式設定。 您的應用程式如往常一樣透過 ConfigurationManager 存取設定。 您不需要對 app.configweb.config 檔案進行更新以外的任何程式碼變更。 本快速入門將逐步引導您完成此選項。
  • 如同 .NET Framework 所設計,應用程式設定只能在應用程式重新開機時重新整理。 應用程式組態 .NET 提供者為 .NET Standard 程式庫。 其支援動態快取和重新整理設定,而不需重新開機應用程式。 如果動態設定對您而言是必要項目,而且您願意進行程式碼變更,請參閱如何在 .NET Framework 主控台應用程式ASP.NET Web 應用程式中實作動態設定更新的教學課程。

在本快速入門中,會將 .NET Framework 主控台應用程式作為範例使用,但是相同的技術適用於 ASP.NET Web Forms/MVC 應用程式。

必要條件

新增金鑰值

將下列金鑰值新增至應用程式組態存放區,並保留標籤內容類型的預設值。 如需如何使用 Azure 入口網站或 CLI 將金鑰值新增至存放區的詳細資訊,請移至建立金鑰值

機碼
TestApp:Settings:Message Azure 應用程式組態的資料

建立 .NET Framework 主控台應用程式

  1. 啟動 Visual Studio 並選取 [建立新專案]

  2. 在 [建立新專案] 中,篩選 [主控台] 專案類型,然後從專案範本清單中選取 [主控台應用程式 (.NET Framework)] 與 C#。 按 [下一步]

  3. 在 [設定您的新專案] 中,輸入專案名稱。 在 [架構] 下,選取 [.NET Framework 4.7.2] 或更新版本。 按下 [建立]

連線至應用程式組態存放區

  1. 以滑鼠右鍵按一下專案,然後選取 [管理 NuGet 套件]。 在 [瀏覽] 索引標籤上,搜尋下列 NuGet 套件並新增至您的專案。

    • Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration 1.0.0 版本或更新版本
    • Microsoft.Configuration.ConfigurationBuilders.Environment 2.0.0 版本或更新版本
    • System.Configuration.ConfigurationManager 4.6.0 版本或更新版本
  2. 更新您專案的 App.config 檔案,如下所示:

    <configSections>
        <section name="configBuilders" type="System.Configuration.ConfigurationBuildersSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" restartOnExternalChanges="false" requirePermission="false" />
    </configSections>
    
    <configBuilders>
        <builders>
            <add name="MyConfigStore" mode="Greedy" connectionString="${ConnectionString}" type="Microsoft.Configuration.ConfigurationBuilders.AzureAppConfigurationBuilder, Microsoft.Configuration.ConfigurationBuilders.AzureAppConfiguration" />
            <add name="Environment" mode="Greedy" type="Microsoft.Configuration.ConfigurationBuilders.EnvironmentConfigBuilder, Microsoft.Configuration.ConfigurationBuilders.Environment" />
        </builders>
    </configBuilders>
    
    <appSettings configBuilders="Environment,MyConfigStore">
        <add key="AppName" value="Console App Demo" />
        <add key="ConnectionString" value ="Set via an environment variable - for example, dev, test, staging, or production connection string." />
    </appSettings>
    

    從環境變數 ConnectionString 中讀取應用程式組態存放區的連接字串。 在 appSettings 區段的 configBuilders 屬性中,於 MyConfigStore 之前新增 Environment 設定建立器。

  3. 開啟 Program.cs,並藉由呼叫 ConfigurationManagerMain 方法更新為使用應用程式設定。

    static void Main(string[] args)
    {
        string message = System.Configuration.ConfigurationManager.AppSettings["TestApp:Settings:Message"];
    
        Console.WriteLine(message);
        Console.ReadKey();
    }
    

建置並執行應用程式

  1. 將名為 ConnectionString 的環境變數設定為在您建立應用程式組態存放區時取得的唯讀金鑰連接字串。

    如果您使用 Windows 命令提示字元,請執行下列命令:

    setx ConnectionString "connection-string-of-your-app-configuration-store"
    

    如果您使用 Windows PowerShell,請執行下列命令:

    $Env:ConnectionString = "connection-string-of-your-app-configuration-store"
    
  2. 重新啟動 Visual Studio,以讓變更生效。

  3. 按 Ctrl + F5 以建置並執行主控台應用程式。 您應該會在主控台中看到來自應用程式組態輸出的訊息。

清除資源

如果您不想繼續使用本文中建立的資源,請刪除在此處建立的資源群組,以避免產生費用。

重要

刪除資源群組是無法回復的動作。 資源群組和其中的所有資源都將被永久刪除。 請確定您不會誤刪錯誤的資源群組或資源。 如果您是在包含需保留其他資源的資源群組內部,建立本文的資源,則可以從每個資源各自的窗格中個別刪除每個資源,而不必刪除整個資源群組。

  1. 登入 Azure 入口網站,然後選取 [資源群組]
  2. 在 [依名稱篩選] 方塊中,輸入您資源群組的名稱。
  3. 在結果清單中,選取資源群組名稱以查看概觀。
  4. 選取 [刪除資源群組]
  5. 系統將會要求您確認是否刪除資源群組。 輸入您資源群組的名稱以進行確認,然後選取 [刪除]

不久後,系統便會刪除該資源群組及其所有的資源。

下一步

在本快速入門中,您已建立新的應用程式組態存放區,並將其與 .NET Framework 主控台應用程式搭配使用。 若要了解如何讓 .NET Framework 應用程式動態重新整理組態設定,請繼續進行下一個教學課程。