Annotations class
Class representing a Annotations.
Constructors
| Annotations(Application |
Create a Annotations. |
Methods
Constructor Details
Annotations(ApplicationInsightsManagementClientContext)
Create a Annotations.
new Annotations(client: ApplicationInsightsManagementClientContext)Parameters
Reference to the service client.
Method Details
create(string, string, Annotation, RequestOptionsBase)
Create an Annotation of an Application Insights component.
function create(resourceGroupName: string, resourceName: string, annotationProperties: Annotation, options?: RequestOptionsBase): 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
- RequestOptionsBase
The optional parameters
Returns
Promise<AnnotationsCreateResponse>
Promise<Models.AnnotationsCreateResponse>
create(string, string, Annotation, RequestOptionsBase, ServiceCallback<Annotation[]>)
function create(resourceGroupName: string, resourceName: string, annotationProperties: Annotation, options: RequestOptionsBase, callback: ServiceCallback<Annotation[]>)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
- RequestOptionsBase
The optional parameters
- callback
The callback
create(string, string, Annotation, ServiceCallback<Annotation[]>)
function create(resourceGroupName: string, resourceName: string, annotationProperties: Annotation, callback: ServiceCallback<Annotation[]>)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.
- callback
The callback
deleteMethod(string, string, string, RequestOptionsBase)
Delete an Annotation of an Application Insights component.
function deleteMethod(resourceGroupName: string, resourceName: string, annotationId: string, options?: RequestOptionsBase): Promise<RestResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteMethod(string, string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, resourceName: string, annotationId: string, options: RequestOptionsBase, callback: ServiceCallback<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
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(string, string, string, ServiceCallback<void>)
function deleteMethod(resourceGroupName: string, resourceName: string, annotationId: string, callback: ServiceCallback<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.
- callback
-
ServiceCallback<void>
The callback
get(string, string, string, RequestOptionsBase)
Get the annotation for given id.
function get(resourceGroupName: string, resourceName: string, annotationId: string, options?: RequestOptionsBase): 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
- RequestOptionsBase
The optional parameters
Returns
Promise<AnnotationsGetResponse>
Promise<Models.AnnotationsGetResponse>
get(string, string, string, RequestOptionsBase, ServiceCallback<Annotation[]>)
function get(resourceGroupName: string, resourceName: string, annotationId: string, options: RequestOptionsBase, callback: ServiceCallback<Annotation[]>)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
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, string, ServiceCallback<Annotation[]>)
function get(resourceGroupName: string, resourceName: string, annotationId: string, callback: ServiceCallback<Annotation[]>)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.
- callback
The callback
list(string, string, string, string, RequestOptionsBase)
Gets the list of annotations for a component for given time range
function list(resourceGroupName: string, resourceName: string, start: string, end: string, options?: RequestOptionsBase): Promise<AnnotationsListResponse>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
- RequestOptionsBase
The optional parameters
Returns
Promise<AnnotationsListResponse>
Promise<Models.AnnotationsListResponse>
list(string, string, string, string, RequestOptionsBase, ServiceCallback<AnnotationsListResult>)
function list(resourceGroupName: string, resourceName: string, start: string, end: string, options: RequestOptionsBase, callback: ServiceCallback<AnnotationsListResult>)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
- RequestOptionsBase
The optional parameters
- callback
The callback
list(string, string, string, string, ServiceCallback<AnnotationsListResult>)
function list(resourceGroupName: string, resourceName: string, start: string, end: string, callback: ServiceCallback<AnnotationsListResult>)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.
- callback
The callback