-
Notifications
You must be signed in to change notification settings - Fork 180
/
Annotations.yml
144 lines (144 loc) · 5.62 KB
/
Annotations.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
### YamlMime:TSType
name: Annotations
uid: '@azure/arm-appinsights.Annotations'
package: '@azure/arm-appinsights'
summary: Interface representing a Annotations.
fullName: Annotations
remarks: ''
isDeprecated: false
type: interface
methods:
- name: create(string, string, Annotation, AnnotationsCreateOptionalParams)
uid: '@azure/arm-appinsights.Annotations.create'
package: '@azure/arm-appinsights'
summary: Create an Annotation of an Application Insights component.
remarks: ''
isDeprecated: false
syntax:
content: >-
function create(resourceGroupName: string, resourceName: string,
annotationProperties: Annotation, options?:
AnnotationsCreateOptionalParams): Promise<AnnotationsCreateResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: resourceName
type: string
description: The name of the Application Insights component resource.
- id: annotationProperties
type: <xref uid="@azure/arm-appinsights.Annotation" />
description: |-
Properties that need to be specified to create an annotation of a
Application Insights component.
- id: options
type: >-
<xref uid="@azure/arm-appinsights.AnnotationsCreateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-appinsights.AnnotationsCreateResponse" />>
- name: delete(string, string, string, AnnotationsDeleteOptionalParams)
uid: '@azure/arm-appinsights.Annotations.delete'
package: '@azure/arm-appinsights'
summary: Delete an Annotation of an Application Insights component.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, resourceName: string,
annotationId: string, options?: AnnotationsDeleteOptionalParams):
Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: resourceName
type: string
description: The name of the Application Insights component resource.
- id: annotationId
type: string
description: >-
The unique annotation ID. This is unique within a Application
Insights
component.
- id: options
type: >-
<xref uid="@azure/arm-appinsights.AnnotationsDeleteOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, AnnotationsGetOptionalParams)
uid: '@azure/arm-appinsights.Annotations.get'
package: '@azure/arm-appinsights'
summary: Get the annotation for given id.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, resourceName: string,
annotationId: string, options?: AnnotationsGetOptionalParams):
Promise<AnnotationsGetResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: resourceName
type: string
description: The name of the Application Insights component resource.
- id: annotationId
type: string
description: >-
The unique annotation ID. This is unique within a Application
Insights
component.
- id: options
type: <xref uid="@azure/arm-appinsights.AnnotationsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-appinsights.AnnotationsGetResponse"
/>>
- name: list(string, string, string, string, AnnotationsListOptionalParams)
uid: '@azure/arm-appinsights.Annotations.list'
package: '@azure/arm-appinsights'
summary: Gets the list of annotations for a component for given time range
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, resourceName: string, start:
string, end: string, options?: AnnotationsListOptionalParams):
PagedAsyncIterableIterator<Annotation, Annotation[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group. The name is case insensitive.
- id: resourceName
type: string
description: The name of the Application Insights component resource.
- id: start
type: string
description: >-
The start time to query from for annotations, cannot be older than
90 days from current
date.
- id: end
type: string
description: The end time to query for annotations.
- id: options
type: <xref uid="@azure/arm-appinsights.AnnotationsListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-appinsights.Annotation" />, <xref
uid="@azure/arm-appinsights.Annotation" />[], <xref
uid="@azure/core-paging.PageSettings" />>