管理 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 中運作。 latest 有最大的中斷性變更數目。 配置檔會擱置與其他雲端的穩定性和相容性。 如果您嘗試使用最新的 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 版本。 例如，如果明天為計算 API 建立新的 API 版本，該 API 版本會列在最新版中，但未列在 yyyy-mm-dd-profile 配置檔中，因為此配置檔已經存在。 yyyy-mm-dd-profile 涵蓋 6 月之前或 12 月之前發行的最新版本。

Azure Resource Manager API 配置檔

Azure Stack Hub 不會使用全域 Azure 中找到的最新版 API 版本。 當您建立解決方案時，您必須找到與 Azure Stack Hub 相容的每個 Azure 資源提供者的 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來使用 Microsoft.Storage 資源提供者建立記憶體帳戶， 其支援 api-version 2016-03-30，以及使用 Microsoft.Compute 資源提供者搭配 api-version 2015-12-01 的 VM，您必須查閱哪些 PowerShell 模組支援 2016-03-30 for Storage，以及哪一個模組支援 2015-02-01 for Compute，然後加以安裝。 相反地，您可以使用配置檔。 使用 Cmdlet Install-Profile <profilename>，而 PowerShell 會載入正確的模組版本。

同樣地，使用 Python SDK 建置以 Python 為基礎的應用程式時，您可以指定設定檔。 SDK 會針對您在文稿中指定的資源提供者載入正確的模組。

身為開發人員，這表示您可以專注於撰寫解決方案。 您可以使用配置檔，並知道您的程式代碼可在支援該配置檔的所有雲端上運作，而不是研究哪些 API 版本、資源提供者和雲端共同運作。

API 設定檔程式代碼範例

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

• .NET
  使用 .NET API 配置檔來取得資源提供者套件中每個資源類型的最新、最穩定版本。 如需詳細資訊，請參閱 在 Azure Stack Hub 中搭配 .NET 使用 API 版本配置檔。
• PowerShell
  使用透過 PowerShell 資源庫 提供的 Az.Bootstrapper 模組，取得使用 API 版本配置檔所需的 PowerShell Cmdlet。 如需詳細資訊，請參閱 使用PowerShell的API版本配置檔。 使用透過 PowerShell 資源庫 提供的 AzureRM.Bootstrapper 模組，取得使用 API 版本配置檔所需的 PowerShell Cmdlet。 如需詳細資訊，請參閱 使用PowerShell的API版本配置檔。
• Azure CLI
  更新您的環境設定，以使用 Azure Stack Hub 特定的 API 版本設定檔。 如需詳細資訊，請參閱 使用 Azure CLI 的 API 版本設定檔。
• Go
  在 Go SDK 中，配置檔是不同資源類型與不同服務的不同版本的組合。 配置檔可在配置檔/路徑下使用其版本 YYYY-MM-DD 格式。 如需詳細資訊，請參閱 使用適用於 Go 的 API 版本設定檔。
• Python
  Python SDK 支援 API 版本設定檔，以不同的雲端平臺為目標，例如 Azure Stack Hub 和全域 Azure。 使用 API 設定檔來建立混合式雲端的解決方案。 如需詳細資訊，請參閱 搭配 Python 使用 API 版本設定檔。
• Node.js
  適用於 Azure Stack Hub Resource Manager 的Node.js SDK 提供工具來協助您建置和管理基礎結構。 如需詳細資訊，請參閱 搭配Node.js使用 API 版本配置檔。

下一步

• 安裝適用於 Azure Stack Hub 的 PowerShell
• 設定 Azure Stack Hub 使用者的 PowerShell 環境
• 檢閱配置檔所支援之資源提供者 API 版本的詳細數據。