ApplicationInsightsManagementClient
Azure Application Insights client for Annotations for a component
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "Azure Application Insights client for Annotations for a component.",
"title": "ApplicationInsightsManagementClient",
"version": "2015-05-01",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentAnnotations_API.json",
"version": "2.0"
}
],
"x-providerName": "azure.com",
"x-serviceName": "applicationinsights-componentAnnotations_API",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {
"AnnotationIdParameter": {
"description": "The unique annotation ID. This is unique within a Application Insights component.",
"in": "path",
"name": "annotationId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"EndParameter": {
"description": "The end time to query for annotations.",
"in": "query",
"name": "end",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"ResourceNameParameter": {
"description": "The name of the Application Insights component resource.",
"in": "path",
"name": "resourceName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"StartParameter": {
"description": "The start time to query from for annotations, cannot be older than 90 days from current date.",
"in": "query",
"name": "start",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/Annotations": {
"get": {
"description": "Gets the list of annotations for a component for given time range",
"operationId": "Annotations_List",
"parameters": [
{
"description": "The name of the resource group. The name is case insensitive.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._\\(\\)]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The API version to use for this operation.",
"in": "query",
"minLength": 1,
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The ID of the target subscription.",
"in": "path",
"minLength": 1,
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ResourceNameParameter"
},
{
"$ref": "#/parameters/StartParameter"
},
{
"$ref": "#/parameters/EndParameter"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AnnotationsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AnnotationError"
}
}
},
"x-ms-examples": {
"AnnotationsList": {
"parameters": {
"api-version": "2015-05-01",
"end": "2018-02-06T00%253A33A00.000Z",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"start": "2018-02-05T00%253A30%253A00.000Z",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": [
{
"AnnotationName": "InsightsPortal-20180126-1",
"Category": "Deployment",
"EventTime": "2018-01-29T20:30:31+00:00",
"Id": "4de4524f-fca5-44a8-b7e6-a67d5107796e",
"Properties": "{\"ReleaseDefinitionName\":\"InsightsPortal-PPEProd-KeyVault\",\"ReleaseRequestedFor\":\"6a970e9b-6220-47f3-a78c-b8be97506698\",\"TeamFoundationCollectionUri\":\"https://mseng.visualstudio.com/\",\"BuildNumber\":\"20180126.1\",\"ReleaseDescription\":\"Triggered by InsightsPortal_master_PROD1_vNext 20180126.1.\",\"ReleaseId\":\"31075\",\"ReleaseWebUrl\":\"https://mseng.visualstudio.com/96a62c4a-58c2-4dbb-94b6-5979ebc7f2af/_release?releaseId=31075\\u0026_a=release-summary\",\"SourceBranch\":\"refs/heads/master\",\"BuildRepositoryProvider\":\"TfsGit\",\"ReleaseEnvironmentName\":\"AIMON VIP SWAP\",\"BuildRepositoryName\":\"InsightsPortal\",\"ReleaseName\":\"InsightsPortal-20180126-1\"}",
"RelatedAnnotation": null
},
{
"AnnotationName": "InsightsPortal-20180125-1",
"Category": "Deployment",
"EventTime": "2018-01-29T20:38:35+00:00",
"Id": "9a82214f-8f98-4699-b5bc-cad6101ed223",
"Properties": "{\"ReleaseDefinitionName\":\"InsightsPortal-PPEProd-KeyVault\",\"ReleaseRequestedFor\":\"6a970e9b-6220-47f3-a78c-b8be97506698\",\"TeamFoundationCollectionUri\":\"https://mseng.visualstudio.com/\",\"BuildNumber\":\"20180125.1\",\"ReleaseDescription\":\"Triggered by InsightsPortal_master_PROD1_vNext 20180125.1.\",\"ReleaseId\":\"31035\",\"ReleaseWebUrl\":\"https://mseng.visualstudio.com/96a62c4a-58c2-4dbb-94b6-5979ebc7f2af/_release?releaseId=31035\\u0026_a=release-summary\",\"SourceBranch\":\"refs/heads/master\",\"BuildRepositoryProvider\":\"TfsGit\",\"ReleaseEnvironmentName\":\"Prod VIP Swap \",\"BuildRepositoryName\":\"InsightsPortal\",\"ReleaseName\":\"InsightsPortal-20180125-1\"}",
"RelatedAnnotation": null
}
]
}
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
},
"put": {
"description": "Create an Annotation of an Application Insights component.",
"operationId": "Annotations_Create",
"parameters": [
{
"description": "The name of the resource group. The name is case insensitive.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._\\(\\)]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The API version to use for this operation.",
"in": "query",
"minLength": 1,
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The ID of the target subscription.",
"in": "path",
"minLength": 1,
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ResourceNameParameter"
},
{
"description": "Properties that need to be specified to create an annotation of a Application Insights component.",
"in": "body",
"name": "AnnotationProperties",
"required": true,
"schema": {
"$ref": "#/definitions/Annotation"
}
}
],
"responses": {
"200": {
"description": "An object containing the annotation definition created by this PUT call.",
"schema": {
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AnnotationError"
}
}
},
"x-ms-examples": {
"AnnotationsCreate": {
"parameters": {
"AnnotationProperties": {
"AnnotationName": "TestAnnotation",
"Category": "Text",
"EventTime": "2018-01-31T13:41:38.657Z",
"Id": "444e2c08-274a-4bbb-a89e-d77bb720f44a",
"Properties": "{\"Comments\":\"Testing\",\"Label\":\"Success\"}"
},
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": [
{
"AnnotationName": "TestAnnotation",
"Category": "Text",
"EventTime": "2018-01-31T13:41:38.657+00:00",
"Id": "444e2c08-274a-4bbb-a89e-d77bb720f44a",
"Properties": "{\"Comments\":\"Testing\",\"Label\":\"Success\"}",
"RelatedAnnotation": null
}
]
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/Annotations/{annotationId}": {
"delete": {
"description": "Delete an Annotation of an Application Insights component.",
"operationId": "Annotations_Delete",
"parameters": [
{
"description": "The name of the resource group. The name is case insensitive.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._\\(\\)]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The API version to use for this operation.",
"in": "query",
"minLength": 1,
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The ID of the target subscription.",
"in": "path",
"minLength": 1,
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ResourceNameParameter"
},
{
"$ref": "#/parameters/AnnotationIdParameter"
}
],
"responses": {
"200": {
"description": "The annotation that was successfully deleted."
}
},
"x-ms-examples": {
"AnnotationsDelete": {
"parameters": {
"annotationId": "bb820f1b-3110-4a8b-ba2c-8c1129d7eb6a",
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid"
},
"responses": {
"200": {}
}
}
}
},
"get": {
"description": "Get the annotation for given id.",
"operationId": "Annotations_Get",
"parameters": [
{
"description": "The name of the resource group. The name is case insensitive.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._\\(\\)]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The API version to use for this operation.",
"in": "query",
"minLength": 1,
"name": "api-version",
"required": true,
"type": "string"
},
{
"description": "The ID of the target subscription.",
"in": "path",
"minLength": 1,
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/ResourceNameParameter"
},
{
"$ref": "#/parameters/AnnotationIdParameter"
}
],
"responses": {
"200": {
"description": "The Annotation object for this id.",
"schema": {
"items": {
"$ref": "#/definitions/Annotation"
},
"type": "array"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/AnnotationError"
}
}
},
"x-ms-examples": {
"AnnotationsGet": {
"parameters": {
"annotationId": "444e2c08-274a-4bbb-a89e-d77bb720f44a",
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": [
{
"AnnotationName": "TestAnnotation",
"Category": "Text",
"EventTime": "2018-01-31T13:41:38.657+00:00",
"Id": "444e2c08-274a-4bbb-a89e-d77bb720f44a",
"Properties": "{\"Comments\":\"Testing\",\"Label\":\"Success\"}",
"RelatedAnnotation": null
}
]
}
}
}
}
}
}
},
"definitions": {
"Annotation": {
"description": "Annotation associated with an application insights resource.",
"properties": {
"AnnotationName": {
"description": "Name of annotation",
"type": "string"
},
"Category": {
"description": "Category of annotation, free form",
"type": "string"
},
"EventTime": {
"description": "Time when event occurred",
"format": "date-time",
"type": "string"
},
"Id": {
"description": "Unique Id for annotation",
"type": "string"
},
"Properties": {
"description": "Serialized JSON object for detailed properties",
"type": "string"
},
"RelatedAnnotation": {
"default": "null",
"description": "Related parent annotation if any",
"type": "string"
}
},
"type": "object"
},
"AnnotationError": {
"description": "Error associated with trying to create annotation with Id that already exist",
"properties": {
"code": {
"description": "Error detail code and explanation",
"type": "string"
},
"innererror": {
"$ref": "#/definitions/InnerError"
},
"message": {
"description": "Error message",
"type": "string"
}
},
"type": "object"
},
"AnnotationsListResult": {
"description": "Annotations list result.",
"properties": {
"value": {
"description": "An array of annotations.",
"items": {
"$ref": "#/definitions/Annotation"
},
"readOnly": true,
"type": "array"
}
}
},
"InnerError": {
"description": "Inner error",
"properties": {
"diagnosticcontext": {
"description": "Provides correlation for request",
"type": "string"
},
"time": {
"description": "Request time",
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
}
}