ApplicationInsightsComponentResource.GetAnnotationsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetAnnotationsAsync(String, CancellationToken) |
Get the annotation for given id.
|
GetAnnotationsAsync(String, String, CancellationToken) |
Gets the list of annotations for a component for given time range
|
GetAnnotationsAsync(String, CancellationToken)
Get the annotation for given id.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/Annotations/{annotationId}
- Operation Id: Annotations_Get
- Default Api Version: 2015-05-01
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation> GetAnnotationsAsync (string annotationId, System.Threading.CancellationToken cancellationToken = default);
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation> GetAnnotationsAsync (string annotationId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAnnotationsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
override this.GetAnnotationsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
abstract member GetAnnotationsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
override this.GetAnnotationsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
Public Overridable Function GetAnnotationsAsync (annotationId As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ApplicationInsightsAnnotation)
Public Overridable Function GetAnnotationsAsync (annotationId As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of Annotation)
Parameters
- annotationId
- String
The unique annotation ID. This is unique within a Application Insights component.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of ApplicationInsightsAnnotation that may take multiple service requests to iterate over.
Exceptions
annotationId
is an empty string, and was expected to be non-empty.
annotationId
is null.
Applies to
GetAnnotationsAsync(String, String, CancellationToken)
Gets the list of annotations for a component for given time range
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/Annotations
- Operation Id: Annotations_List
- Default Api Version: 2015-05-01
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation> GetAnnotationsAsync (string start, string end, System.Threading.CancellationToken cancellationToken = default);
public virtual Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation> GetAnnotationsAsync (string start, string end, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAnnotationsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
override this.GetAnnotationsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
abstract member GetAnnotationsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
override this.GetAnnotationsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
Public Overridable Function GetAnnotationsAsync (start As String, end As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ApplicationInsightsAnnotation)
Public Overridable Function GetAnnotationsAsync (start As String, end As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of Annotation)
Parameters
- start
- String
The start time to query from for annotations, cannot be older than 90 days from current date.
- end
- String
The end time to query for annotations.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of ApplicationInsightsAnnotation that may take multiple service requests to iterate over.
Exceptions
start
or end
is null.