|
1 | | ---- |
2 | | -title: Azure Spring Apps API breaking changes |
3 | | -description: Describes the breaking changes introduced by the latest Azure Spring Apps stable API version. |
4 | | -author: KarlErickson |
5 | | -ms.author: yuwzho |
6 | | -ms.service: azure-spring-apps |
7 | | -ms.topic: how-to |
8 | | -ms.date: 06/27/2024 |
9 | | -ms.custom: devx-track-java, devx-track-azurecli |
10 | | ---- |
11 | | - |
12 | | -# Azure Spring Apps API breaking changes |
13 | | - |
14 | | -[!INCLUDE [deprecation-note](../includes/deprecation-note.md)] |
15 | | - |
16 | | -**This article applies to:** ✔️ Basic/Standard ✔️ Enterprise |
17 | | - |
18 | | -This article describes breaking changes introduced into the Azure Spring Apps API. |
19 | | - |
20 | | -The Azure Spring Apps service releases the new stable API version 2022-04-01. The new API version introduces breaking changes based on the previous stable API version 2020-07-01. We suggest that you update your API calls to the new API version. |
21 | | - |
22 | | -## Previous API deprecation date |
23 | | - |
24 | | -The previous API version 2020-07-01 will not be supported starting April, 2025. |
25 | | - |
26 | | -## API breaking changes from 2020-07-01 to 2022-04-01 |
27 | | - |
28 | | -### Deprecate number value CPU and MemoryInGB in Deployments |
29 | | - |
30 | | -Deprecate field `properties.deploymentSettings.cpu` and `properties.deploymentSettings.memoryInGB` in the `Spring/Apps/Deployments` resource. Use `properties.deploymentSettings.resourceRequests.cpu` and `properties.deploymentSettings.resourceRequests.memory` instead. |
31 | | - |
32 | | -### RBAC role change for blue-green deployment |
33 | | - |
34 | | -Deprecate field `properties.activeDeploymentName` in the `Spring/Apps` resource. Use `POST/SUBSCRIPTIONS/RESOURCEGROUPS/PROVIDERS/MICROSOFT.APPPLATFORM/SPRING/APPS/SETACTIVEDEPLOYMENTS` for blue-green deployment. This action needs a separate RBAC role `spring/apps/setActiveDeployments/action` to perform. |
35 | | - |
36 | | -### Move options from different property bags for the Spring/Apps/Deployments resource |
37 | | - |
38 | | -- Deprecate `properties.createdTime`. Use `systemData.createdAt`. |
39 | | -- Deprecate `properties.deploymentSettings.jvmOptions`. Use `properties.source.jvmOptions`. |
40 | | -- Deprecate `properties.deploymentSettings.jvmOptions`. Use `properties.source.runtimeVersion`. |
41 | | -- Deprecate `properties.deploymentSettings.netCoreMainEntryPath`. Use `properties.source.netCoreMainEntryPath`. |
42 | | -- Deprecate `properties.appName`, which you can extract from `id`. |
43 | | - |
44 | | -## Updates in the Azure CLI extension |
45 | | - |
46 | | -### Add new RBAC role for blue-green deployment |
47 | | - |
48 | | -You need to add RBAC role `spring/apps/setActiveDeployments/action` to perform the following Azure CLI commands: |
49 | | - |
50 | | -```azurecli |
51 | | -az spring app set-deployment \ |
52 | | - --resource-group <resource-group-name> \ |
53 | | - --service <service-instance-name> \ |
54 | | - --name <app-name> \ |
55 | | - --deployment <deployment-name> |
56 | | -az spring app unset-deployment \ |
57 | | - --resource-group <resource-group-name> \ |
58 | | - --service <service-instance-name> \ |
59 | | - --name <app-name> |
60 | | -``` |
61 | | - |
62 | | -### Output updates |
63 | | - |
64 | | -If you're using the Azure CLI `spring-cloud` extension with a version lower than 3.0.0, and you want to upgrade the extension version or migrate to the `spring` extension, then you should take care of the following output updates. |
65 | | - |
66 | | -- `az spring app` command output: Remove `properties.activeDeploymentName`. Use `properties.activeDeployment.name` instead. |
67 | | -- `az spring app` command output: Remove `properties.createdTime`. Use `systemData.createdAt` instead. |
68 | | -- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.cpu`. Use `properties.activeDeployment.properties.deploymentSettings.resourceRequests.cpu` instead. |
69 | | -- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.memoryInGB`. Use `properties.activeDeployment.properties.deploymentSettings.resourceRequests.memory` instead. |
70 | | -- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.jvmOptions`. Use `properties.activeDeployment.properties.source.jvmOptions` instead. |
71 | | -- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.runtimeVersion`. Use `properties.activeDeployment.properties.source.runtimeVersion` instead. |
72 | | -- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.netCoreMainEntryPath`. Use `properties.activeDeployment.properties.source.netCoreMainEntryPath` instead. |
| 1 | +--- |
| 2 | +title: Azure Spring Apps API breaking changes |
| 3 | +description: Describes the breaking changes introduced by the latest Azure Spring Apps stable API version. |
| 4 | +author: KarlErickson |
| 5 | +ms.author: yuwzho |
| 6 | +ms.service: azure-spring-apps |
| 7 | +ms.topic: how-to |
| 8 | +ms.date: 06/27/2024 |
| 9 | +ms.custom: devx-track-java, devx-track-azurecli |
| 10 | +--- |
| 11 | + |
| 12 | +# Azure Spring Apps API breaking changes |
| 13 | + |
| 14 | +[!INCLUDE [deprecation-note](../includes/deprecation-note.md)] |
| 15 | + |
| 16 | +**This article applies to:** ✔️ Basic/Standard ✔️ Enterprise |
| 17 | + |
| 18 | +This article describes breaking changes introduced into the Azure Spring Apps API. |
| 19 | + |
| 20 | +The Azure Spring Apps service releases the new stable API version 2022-04-01. The new API version introduces breaking changes based on the previous stable API version 2020-07-01. We suggest that you update your API calls to the new API version. |
| 21 | + |
| 22 | +## Previous API deprecation date |
| 23 | + |
| 24 | +The previous API version 2020-07-01 will not be supported starting April, 2025. |
| 25 | + |
| 26 | +## API breaking changes from 2020-07-01 to 2022-04-01 |
| 27 | + |
| 28 | +### Deprecate number value CPU and MemoryInGB in Deployments |
| 29 | + |
| 30 | +Deprecate field `properties.deploymentSettings.cpu` and `properties.deploymentSettings.memoryInGB` in the `Spring/Apps/Deployments` resource. Use `properties.deploymentSettings.resourceRequests.cpu` and `properties.deploymentSettings.resourceRequests.memory` instead. |
| 31 | + |
| 32 | +### RBAC role change for blue-green deployment |
| 33 | + |
| 34 | +Deprecate field `properties.activeDeploymentName` in the `Spring/Apps` resource. Use `POST/SUBSCRIPTIONS/RESOURCEGROUPS/PROVIDERS/MICROSOFT.APPPLATFORM/SPRING/APPS/SETACTIVEDEPLOYMENTS` for blue-green deployment. This action needs a separate RBAC role `spring/apps/setActiveDeployments/action` to perform. |
| 35 | + |
| 36 | +### Move options from different property bags for the Spring/Apps/Deployments resource |
| 37 | + |
| 38 | +- Deprecate `properties.createdTime`. Use `systemData.createdAt`. |
| 39 | +- Deprecate `properties.deploymentSettings.jvmOptions`. Use `properties.source.jvmOptions`. |
| 40 | +- Deprecate `properties.deploymentSettings.jvmOptions`. Use `properties.source.runtimeVersion`. |
| 41 | +- Deprecate `properties.deploymentSettings.netCoreMainEntryPath`. Use `properties.source.netCoreMainEntryPath`. |
| 42 | +- Deprecate `properties.appName`, which you can extract from `id`. |
| 43 | + |
| 44 | +## Updates in the Azure CLI extension |
| 45 | + |
| 46 | +### Add new RBAC role for blue-green deployment |
| 47 | + |
| 48 | +You need to add RBAC role `spring/apps/setActiveDeployments/action` to perform the following Azure CLI commands: |
| 49 | + |
| 50 | +```azurecli |
| 51 | +az spring app set-deployment \ |
| 52 | + --resource-group <resource-group-name> \ |
| 53 | + --service <service-instance-name> \ |
| 54 | + --name <app-name> \ |
| 55 | + --deployment <deployment-name> |
| 56 | +az spring app unset-deployment \ |
| 57 | + --resource-group <resource-group-name> \ |
| 58 | + --service <service-instance-name> \ |
| 59 | + --name <app-name> |
| 60 | +``` |
| 61 | + |
| 62 | +### Output updates |
| 63 | + |
| 64 | +If you're using the Azure CLI `spring-cloud` extension with a version lower than 3.0.0, and you want to upgrade the extension version or migrate to the `spring` extension, then you should take care of the following output updates. |
| 65 | + |
| 66 | +- `az spring app` command output: Remove `properties.activeDeploymentName`. Use `properties.activeDeployment.name` instead. |
| 67 | +- `az spring app` command output: Remove `properties.createdTime`. Use `systemData.createdAt` instead. |
| 68 | +- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.cpu`. Use `properties.activeDeployment.properties.deploymentSettings.resourceRequests.cpu` instead. |
| 69 | +- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.memoryInGB`. Use `properties.activeDeployment.properties.deploymentSettings.resourceRequests.memory` instead. |
| 70 | +- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.jvmOptions`. Use `properties.activeDeployment.properties.source.jvmOptions` instead. |
| 71 | +- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.runtimeVersion`. Use `properties.activeDeployment.properties.source.runtimeVersion` instead. |
| 72 | +- `az spring app` command output: Remove `properties.activeDeployment.properties.deploymentSettings.netCoreMainEntryPath`. Use `properties.activeDeployment.properties.source.netCoreMainEntryPath` instead. |
0 commit comments