Share via

ApplicationInsightsComponentResource.GetAnnotations Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApplicationInsights
Assembly:
Azure.ResourceManager.ApplicationInsights.dll
Package:
Azure.ResourceManager.ApplicationInsights v1.0.0
Package:
Azure.ResourceManager.ApplicationInsights v1.0.0-beta.5

Overloads

GetAnnotations(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
GetAnnotations(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

GetAnnotations(String, CancellationToken)

Source:
ApplicationInsightsComponentResource.cs
Source:
ApplicationInsightsComponentResource.cs

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.Pageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation> GetAnnotations (string annotationId, System.Threading.CancellationToken cancellationToken = default);
public virtual Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation> GetAnnotations (string annotationId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAnnotations : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
override this.GetAnnotations : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
abstract member GetAnnotations : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
override this.GetAnnotations : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
Public Overridable Function GetAnnotations (annotationId As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ApplicationInsightsAnnotation)
Public Overridable Function GetAnnotations (annotationId As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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

Pageable<ApplicationInsightsAnnotation>
Pageable<Annotation>

A collection of ApplicationInsightsAnnotation that may take multiple service requests to iterate over.

Exceptions

ArgumentException

annotationId is an empty string, and was expected to be non-empty.

ArgumentNullException

annotationId is null.

Applies to

GetAnnotations(String, String, CancellationToken)

Source:
ApplicationInsightsComponentResource.cs
Source:
ApplicationInsightsComponentResource.cs

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.Pageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation> GetAnnotations (string start, string end, System.Threading.CancellationToken cancellationToken = default);
public virtual Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation> GetAnnotations (string start, string end, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAnnotations : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
override this.GetAnnotations : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.ApplicationInsightsAnnotation>
abstract member GetAnnotations : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
override this.GetAnnotations : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.ApplicationInsights.Models.Annotation>
Public Overridable Function GetAnnotations (start As String, end As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ApplicationInsightsAnnotation)
Public Overridable Function GetAnnotations (start As String, end As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(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

Pageable<ApplicationInsightsAnnotation>
Pageable<Annotation>

A collection of ApplicationInsightsAnnotation that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

start or end is null.

Applies to