本文概述了各種程式設計工具的版本設定和中斷性變更原則。
支援和取代資訊
Power Platform API 是第一個在 PowerShell、管理連接器和 Power Platform CLI 等其他 SDK 之前接收新版本和功能的程式設計性工具。 隨著新版本 REST API 推出,早期版本將被取代。 Microsoft 將在停用 API 端點之前至少 12 個月聲明已棄用的版本。 當某個版本被取代時,系統仍會依原樣支援它。 如果您在使用該版本時發生問題,我們將要求您移轉到目前正式推出的版本。 當版本被淘汰時,系統就不會支援且很快就會關閉它。
通過遞增 API 的版本號 (例如,從 2021-10-01 到 2022-04-01), Microsoft 宣佈以前的正式發佈版本 (在本例中為 2021-10-01) 將立即棄用,並將在公告 12 個月後停用。 公開預覽版也適用相同的處理方法。 Microsoft 可能會因服務運行狀況和安全問題而對此策略進行例外處理。
對於 PowerShell cmdlet,將提供增量版本來解決較小的錯誤修復。 主要版本將增加以符合出現的新 API 版本。
相容性和中斷性變更
Microsoft 將在發佈計劃中提供可程式設計性更改 的詳細資訊。 如果變更本質上非中斷性變更,則 API 版本將保持不變,而 PowerShell 版本將獲得次要版本增量。 如果更改本質上是中斷性的, Microsoft 將遞增 API 版本和 PowerShell 主要版本。
以下是一些中斷性變更的範例:
- URL 或基本要求/回應已變更。
- 聲明屬性將被刪除或重新命名,或者其類型已更改。
- API 或 API參數會被刪除或重新命名。
- 已新增必要的要求參數。
以下是一些非中斷性變更的範例:
- 新增屬性可以為空或具有預設值。
- 一名成員已新增至列舉。
- 分頁已引入到現有集合物件中。
- 錯誤代碼已變更。
- 要求或回應中的屬性順序已變更。
可用版本
| 版本 | 類型 | 參考資料 | 取代日期 | 解除日期 |
|---|---|---|---|---|
| 2022-03-01-preview | 公開預覽版 | 2022-03-01-preview 參考 | 無法使用 | 無法使用 |
| 2020-10-01 | 通用 | 2020-10-01 參考文獻 | 無法使用 | 無法使用 |
注意
2020-10-01 Power Platform API 的正式推出版本專用於環境管理,通常也稱為商務應用程式平台 (BAP) API。 這組端點的功能將在較新版本的 Power Platform API 中提供,版本 2022-03-01-preview 之後還有許多附加功能。
後續步驟
現在,您已經了解版本控制和支援策略,接下來讓我們逐步介紹如何使用 Microsoft Power Platform API 驗證。