Annotations interface

Package:

@azure/arm-appinsights

Interface representing a Annotations.

Methods

create(string, string, Annotation, AnnotationsCreateOptionalParams)	Create an Annotation of an Application Insights component.
delete(string, string, string, AnnotationsDeleteOptionalParams)	Delete an Annotation of an Application Insights component.
get(string, string, string, AnnotationsGetOptionalParams)	Get the annotation for given id.
list(string, string, string, string, AnnotationsListOptionalParams)	Gets the list of annotations for a component for given time range

Method Details

create(string, string, Annotation, AnnotationsCreateOptionalParams)

Create an Annotation of an Application Insights component.

function create(resourceGroupName: string, resourceName: string, annotationProperties: Annotation, options?: AnnotationsCreateOptionalParams): Promise<AnnotationsCreateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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

AnnotationsCreateOptionalParams

The options parameters.

Returns

Promise<AnnotationsCreateResponse>

delete(string, string, string, AnnotationsDeleteOptionalParams)

Delete an Annotation of an Application Insights component.

function delete(resourceGroupName: string, resourceName: string, annotationId: string, options?: AnnotationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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

AnnotationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, AnnotationsGetOptionalParams)

Get the annotation for given id.

function get(resourceGroupName: string, resourceName: string, annotationId: string, options?: AnnotationsGetOptionalParams): Promise<AnnotationsGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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

AnnotationsGetOptionalParams

The options parameters.

Returns

Promise<AnnotationsGetResponse>

list(string, string, string, string, AnnotationsListOptionalParams)

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

function list(resourceGroupName: string, resourceName: string, start: string, end: string, options?: AnnotationsListOptionalParams): PagedAsyncIterableIterator<Annotation, Annotation[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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

AnnotationsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Annotation, Annotation[], PageSettings>