Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Annotations

Package version

Class representing a Annotations.

Hierarchy

  • Annotations

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(resourceGroupName: string, resourceName: string, annotationProperties: Annotation, options?: msRest.RequestOptionsBase): Promise<Models.AnnotationsCreateResponse>
  • create(resourceGroupName: string, resourceName: string, annotationProperties: Annotation, callback: msRest.ServiceCallback<Annotation[]>): void
  • create(resourceGroupName: string, resourceName: string, annotationProperties: Annotation, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Annotation[]>): void

  • Create an Annotation of an Application Insights component.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationProperties: Annotation

      Properties that need to be specified to create an annotation of a Application Insights component.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AnnotationsCreateResponse>

    Promise<Models.AnnotationsCreateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationProperties: Annotation

      Properties that need to be specified to create an annotation of a Application Insights component.

    • callback: msRest.ServiceCallback<Annotation[]>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationProperties: Annotation

      Properties that need to be specified to create an annotation of a Application Insights component.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Annotation[]>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, resourceName: string, annotationId: string, options?: msRest.RequestOptionsBase): Promise<Models.AnnotationsDeleteMethodResponse>
  • deleteMethod(resourceGroupName: string, resourceName: string, annotationId: string, callback: msRest.ServiceCallback<any>): void
  • deleteMethod(resourceGroupName: string, resourceName: string, annotationId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<any>): void

  • Delete an Annotation of an Application Insights component.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationId: string

      The unique annotation ID. This is unique within a Application Insights component.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AnnotationsDeleteMethodResponse>

    Promise<Models.AnnotationsDeleteMethodResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationId: string

      The unique annotation ID. This is unique within a Application Insights component.

    • callback: msRest.ServiceCallback<any>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationId: string

      The unique annotation ID. This is unique within a Application Insights component.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<any>

      The callback

    Returns void

get

  • get(resourceGroupName: string, resourceName: string, annotationId: string, options?: msRest.RequestOptionsBase): Promise<Models.AnnotationsGetResponse>
  • get(resourceGroupName: string, resourceName: string, annotationId: string, callback: msRest.ServiceCallback<Annotation[]>): void
  • get(resourceGroupName: string, resourceName: string, annotationId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Annotation[]>): void

  • Get the annotation for given id.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationId: string

      The unique annotation ID. This is unique within a Application Insights component.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AnnotationsGetResponse>

    Promise<Models.AnnotationsGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationId: string

      The unique annotation ID. This is unique within a Application Insights component.

    • callback: msRest.ServiceCallback<Annotation[]>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • annotationId: string

      The unique annotation ID. This is unique within a Application Insights component.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Annotation[]>

      The callback

    Returns void

list

  • list(resourceGroupName: string, resourceName: string, start: string, end: string, options?: msRest.RequestOptionsBase): Promise<Models.AnnotationsListResponse>
  • list(resourceGroupName: string, resourceName: string, start: string, end: string, callback: msRest.ServiceCallback<AnnotationsListResult>): void
  • list(resourceGroupName: string, resourceName: string, start: string, end: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AnnotationsListResult>): void

  • Gets the list of annotations for a component for given time range

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • 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.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AnnotationsListResponse>

    Promise<Models.AnnotationsListResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • 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.

    • callback: msRest.ServiceCallback<AnnotationsListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • 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.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AnnotationsListResult>

      The callback

    Returns void

Generated using TypeDoc