Przechowywanie wersji i obsługa

W tym artykule przedstawiono omówienie zasad tworzenia wersji i zmian powodujących niezgodność z różnymi narzędziami do programowania.

Pomoc techniczna i wycofywanie — informacje

W miarę wydawania nowej wersji interfejsu API REST starsze wersje są wycofywanych. Firma Microsoft deklaruje wersję przestarzałą co najmniej 12 miesięcy przed wycofaniem punktu końcowego interfejsu API. Jeśli wersja jest przestarzała, jest obsługiwana as-is. Jeśli wystąpi problem z tą wersją, prosimy o przejście do obecnie stabilnej wersji. Po wycofaniu wersji nie jest obsługiwana i wkrótce zostanie wyłączona.

Zwiększając numer wersji interfejsu API (na przykład z 2021-10-01 do 2022-04-01), Microsoft ogłasza, że poprzednia ogólnie dostępna wersja (w tym przykładzie 2021-10-01) jest natychmiast przestarzała i zostanie wycofana 12 miesięcy po ogłoszeniu. Microsoft może tworzyć wyjątki od tej zasady w przypadku problemów z kondycją i zabezpieczeniami usługi.

Różne narzędzia i zestawy SDK generowane na podstawie interfejsu API platformy Power Platform, takie jak interfejs wiersza polecenia platformy Power Platform, łącznik Admin V2 i program PowerShell, są aktualizowane do nowszych wersji interfejsu API na podstawie akcji i są niewidoczne dla użytkowników końcowych.

Zmiana powodująca niezgodność i kompatybilność

Firma Microsoft udostępnia szczegółowe informacje o zmianach programowych w planach wydania. Jeśli zmiany nie są przełomowe, wersja interfejsu API pozostaje taka sama, a wersja programu PowerShell otrzymuje przyrost wersji pomocniczej. Jeśli zmiany mają charakter powodujący niezgodność, firma Microsoft zwiększa wersję interfejsu API i wersję główną programu PowerShell.

Oto przykłady zmian powodujących niezgodność:

  • Adres URL lub podstawowe żądanie/odpowiedź zostaną zmienione.
  • Właściwość, która uległa zmianie, zostanie usunięta lub zmieniona bądź też zostanie zmieniony jej typ.
  • Parametry interfejsu API lub API są usuwane i zmieniane są ich nazwy.
  • Dodawany jest wymagany parametr.

Oto przykłady przełomowych zmian:

  • Dodawane są właściwości z wartością null lub mają wartość domyślną.
  • Element jest dodawany do wyliczenia.
  • Stronicowanie jest wprowadzane do istniejących zbiorów.
  • Kody błędów zmienione.
  • Kolejność właściwości w żądaniach i odpowiedziach jest zmieniana.

Available versions

Version Typ Reference Deprecation date Decommission date
2024-10-01 Stable Reference N/A N/A
2020-10-01 Generally available 2020-10-01 Ref N/A N/A

Note

Powszechnie dostępna wersja API Power Platform 2020-10-01 jest specyficzna dla zarządzania środowiskiem i jest również powszechnie nazywana API Business Application Platform (BAP). Funkcjonalność tego zestawu punktów końcowych jest dostępna w nowszych wersjach API Power Platform.

Next steps

Po zrozumieniu strategii obsługi i obsługi wersji przejdźmy przez proces uwierzytelniania w programie API Microsoft Power Platform.