Skip to content

Commit 1b67fc5

Browse files
authored
Merge pull request #188211 from AaronMaxwell/aaronmax-annotations-update
[AppInsights] api key deprecation, category must be set to deployment
2 parents 18e616e + febfc13 commit 1b67fc5

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

articles/azure-monitor/app/annotations.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ You can use the CreateReleaseAnnotation PowerShell script to create annotations
9393
Id = [GUID]::NewGuid();
9494
AnnotationName = $releaseName;
9595
EventTime = (Get-Date).ToUniversalTime().GetDateTimeFormats("s")[0];
96-
Category = "Deployment";
96+
Category = "Deployment"; #Application Insights only displays annotations from the "Deployment" Category
9797
Properties = ConvertTo-Json $releaseProperties -Compress
9898
}
9999
@@ -104,6 +104,9 @@ You can use the CreateReleaseAnnotation PowerShell script to create annotations
104104
# Invoke-AzRestMethod -Path "$aiResourceId/Annotations?api-version=2015-05-01" -Method PUT -Payload $body
105105
```
106106
107+
[!NOTE]
108+
Your annotations must have **Category** set to **Deployment** in order to be displayed in the Azure Portal.
109+
107110
3. Call the PowerShell script with the following code, replacing the angle-bracketed placeholders with your values. The -releaseProperties are optional.
108111
109112
```powershell
@@ -155,6 +158,9 @@ Select any annotation marker to open details about the release, including reques
155158
156159
Release annotations are a feature of the cloud-based Azure Pipelines service of Azure DevOps.
157160
161+
> [!IMPORTANT]
162+
> Annotations using API keys is deprecated. We recommend using [Azure CLI](https://docs.microsoft.com/azure/azure-monitor/app/annotations#create-release-annotations-with-azure-cli) instead.
163+
158164
### Install the annotations extension (one time)
159165
160166
To be able to create release annotations, you'll need to install one of the many Azure DevOps extensions available in the Visual Studio Marketplace.

0 commit comments

Comments
 (0)