|
| 1 | +--- |
| 2 | +title: Azure App Configuration preview API life cycle |
| 3 | +titleSuffix: Azure App Configuration |
| 4 | +description: Learn about the preview API life cycle. |
| 5 | +services: azure-app-configuration |
| 6 | +author: amerjusupovic |
| 7 | +ms.author: ajusupovic |
| 8 | +ms.service: azure-app-configuration |
| 9 | +ms.topic: conceptual |
| 10 | +ms.date: 02/12/2025 |
| 11 | +--- |
| 12 | + |
| 13 | +# Preview API life cycle |
| 14 | + |
| 15 | +The Azure App Configuration preview APIs (all APIs that ends in `-preview`) are deprecated 90 days after a newer preview, or stable, API version is released. The policy applies to all API versions released after, and including, 2023-09-01-preview. |
| 16 | + |
| 17 | +We love when people try our preview features and give us feedback, so we encourage you to use the preview APIs. |
| 18 | + |
| 19 | +After an API version is deprecated, it will no longer function! We recommend you routinely: |
| 20 | +- Update your ARM/BICEP templates using preview API versions to use the latest version of the preview API. |
| 21 | +- Update any preview SDKs or other tools built on the preview API to the latest version. |
| 22 | + |
| 23 | +You should perform these updates at a minimum every 6-9 months. If you fail to do so, you'll be notified that you're using a soon-to-be deprecated API version as deprecation approaches. |
| 24 | + |
| 25 | +> [!NOTE] |
| 26 | +> API versions before 2023-09-01-preview won't follow the 90 day pattern outlined in the beginning of this document. Refer to the [Upcoming Deprecations](#upcoming-deprecations) and [Completed Deprecations](#completed-deprecations) tables to see if a preview API version you're using has a deprecation date. |
| 27 | +
|
| 28 | +## How to check what API versions you're using |
| 29 | + |
| 30 | +If you're unsure what client or tool is using this API version, check the [activity logs](/azure/azure-monitor/essentials/activity-log) |
| 31 | +using the following command: |
| 32 | + |
| 33 | +### [bash](#tab/bash) |
| 34 | + |
| 35 | +```bash |
| 36 | +API_VERSION=<impacted API version, such as 2021-10-01-preview> |
| 37 | +az monitor activity-log list --offset 30d --max-events 10000 --namespace Microsoft.AppConfiguration --query "[?eventName.value == 'EndRequest' && httpRequest.uri != null && contains(httpRequest.uri, '$API_VERSION')].[eventTimestamp, httpRequest.uri]" --output table |
| 38 | +``` |
| 39 | + |
| 40 | +### [PowerShell](#tab/PowerShell) |
| 41 | + |
| 42 | +```powershell |
| 43 | +$API_VERSION=<impacted API version, such as 2021-10-01-preview> |
| 44 | +az monitor activity-log list --offset 30d --max-events 10000 --namespace Microsoft.AppConfiguration | ConvertFrom-Json | Where-Object { $_.eventName.value -eq "EndRequest" -and $_.httpRequest.uri -match $API_VERSION } | Select-Object eventTimestamp, httpRequest | Format-Table -Wrap -AutoSize |
| 45 | +``` |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +## How to find the available API versions |
| 50 | + |
| 51 | +If you want to know what API versions are available, you can use the following command for a resource type: |
| 52 | + |
| 53 | +```bash |
| 54 | +az provider show --namespace Microsoft.AppConfiguration --query "resourceTypes[?resourceType=='configurationStores'].apiVersions" |
| 55 | +``` |
| 56 | + |
| 57 | +## How to update to a newer version of the API |
| 58 | + |
| 59 | +- For Azure SDKs: Use a newer API version by updating to a [newer version of the SDK](https://github.com/Azure/AppConfiguration?tab=readme-ov-file#sdks). |
| 60 | +- For Azure CLI: Update the CLI itself, usually by running `az upgrade`. |
| 61 | +- For REST requests: Update the `api-version` query parameter. |
| 62 | +- For other tools: Update the tool to the latest version. |
| 63 | + |
| 64 | +## Upcoming deprecations |
| 65 | + |
| 66 | +| API version | Announce Date | Deprecation Date | |
| 67 | +|--------------------|-------------------|-------------------| |
| 68 | +| 2023-09-01-preview | April 30, 2025 | July 29, 2025 | |
| 69 | + |
| 70 | +## Completed deprecations |
| 71 | + |
| 72 | +There are no completed deprecations yet. |
0 commit comments