管理 Azure Stack Hub 中的 API 版本設定檔

  • 發行項

API 設定檔會指定 Azure 資源提供者和 Azure REST 端點的 API 版本。 您可以使用 API 設定檔建立不同語言的自訂用戶端。 每個用戶端都會使用 API 設定檔來連絡 Azure Stack Hub 的正確資源提供者和 API 版本。

您可以建立應用程式來與 Azure 資源提供者搭配運作，而不需要清楚知道每個資源提供者 API 可與 Azure Stack Hub 相容的是哪個版本。 只要將應用程式對到設定檔，SDK 就會還原為正確的 API 版本。

本主題可協助您：

  • 了解 Azure Stack Hub 的 API 設定檔。
  • 了解如何使用 API 設定檔來開發解決方案。
  • 了解要到哪裡尋找程式碼專屬的指引。

API 設定檔的摘要

  • API 設定檔可用來代表一組 Azure 資源提供者和其 API 版本。
  • API 設定檔是為了讓您建立跨多個 Azure 雲端之範本而建立的。 設定檔可提供相容且穩定的介面。
  • 設定檔每年會發行四次。
  • 所使用的設定檔命名慣例有三個：
    • 最新
      包含全域 Azure 中所發行的最新 API 版本。
    • yyyy-mm-dd-hybrid
      每兩年發行一次，此發行著重於跨多個雲端的一致性和穩定性。 此設定檔的目標是最佳 Azure Stack Hub 相容性。
    • yyyy-mm-dd-profile
      平衡最佳穩定性和最新功能。

Azure API 設定檔和 Azure Stack Hub 相容性

最新的 Azure API 設定檔與 Azure Stack Hub 不相容。 使用下列命名慣例來識別要在 Azure Stack Hub 解決方案中使用的設定檔：

最新
此設定檔具有全域 Azure 中最新的 API 版本，它不適用於 Azure Stack Hub。 最新具有最大數目的重大變更。 設定檔不考慮其他雲端的穩定性與相容性。 如果您正在嘗試使用最新 API 版本，最新便是應該使用的設定檔。

yyyy-mm-dd-hybrid
此設定檔會在每年 3 月和 9 月發行。 其具有各種雲端的最佳穩定性和相容性，且設計訴求為以全域 Azure 和 Azure Stack Hub 為目標。 此設定檔中列出的 Azure API 版本將與 Azure Stack Hub 中列出的版本相同。 使用此設定檔開發混合式雲端方案的程式碼。

yyyy-mm-dd-profile
此設定檔將在 6 月和 12 月發行給全域 Azure。 其不適用於 Azure Stack Hub，而且通常會有許多中斷性變更。 雖然其可平衡最佳穩定性與最新功能，但最新與此設定檔之間的差異在於最新一律由最新的 API 版本組成，而不論 API 何時發行。 例如，如果明天為 Compute API 建立新的 API 版本，則該 API 版本會在最新中列出，但不會在 yyyy-mm-dd-profile 設定檔中列出，因為此設定檔已存在。 yyyy-mm-dd-profile 涵蓋了 6 月或 12 月之前發行的最新版本。

Azure Resource Manager API 設定檔

Azure Stack Hub 不會使用全域 Azure 中所找到的最新版 API。 當您建立解決方案時，您必須尋找每個 Azure 資源提供者可與 Azure Stack Hub 相容的 API 版本。

您可以使用 API 設定檔，而不必研究每個資源提供者和 Azure Stack Hub 所支援的特定版本。 設定檔會指定一組資源提供者和 API 版本。 SDK 或是使用 SDK 所建置的工具，將會還原為設定檔中所指定的目標 api-version。 透過 API 設定檔，您可以指定套用至整個範本的設定檔版本。 在執行階段上，Azure Resource Manager 會選取正確的資源版本。

API 設定檔可與使用 Azure Resource Manager 的工具搭配運作，例如 PowerShell、Azure CLI、SDK 所提供的程式碼，以及 Microsoft Visual Studio。 工具和 SDK 可使用設定檔來讀取建置應用程式時所納入的模組和程式庫版本。

例如，如果使用 PowerShell 以支援 api-version 2016-03-30 的 Microsoft.Storage 資源提供者建立儲存體帳戶，並使用 api-version 為 2015-12-01 的 Microsoft.Compute 資源提供者建立 VM，您就必須查看哪個 PowerShell 模組支援使用 2016-03-30 來進行儲存，以及哪個模組支援使用 2015-02-01 來進行計算，然後安裝這兩個模組。 但您也可以改為使用設定檔。 使用 Cmdlet Install-Profile <profilename>，然後 PowerShell 就會載入正確的模組版本。

同樣地，在使用 Python SDK 來建置以 Python 為基礎的應用程式時，您也可以指定設定檔。 SDK 會為指令碼所指定的資源提供者載入正確模組。

身為開發人員，這代表您可以專注於撰寫解決方案。 您可以使用設定檔，並清楚程式碼可跨所有支援該設定檔的雲端來運作，而不必研究哪個 API 版本、資源提供者和雲端可一起運作。

API 設定檔程式碼範例

您可以找到程式碼範例，來協助您使用設定檔整合解決方案與您在 Azure Stack Hub 慣用的語言。 目前，您可以找到下列語言的指引和範例：

後續步驟