ApplicationInsightsManagementClient
Azure Application Insights client for work item configurations for a component
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"description": "Azure Application Insights client for work item configurations 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/componentWorkItemConfigs_API.json",
"version": "2.0"
}
],
"x-providerName": "azure.com",
"x-serviceName": "applicationinsights-componentWorkItemConfigs_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": {
"ResourceNameParameter": {
"description": "The name of the Application Insights component resource.",
"in": "path",
"name": "resourceName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"WorkItemConfigIdParameter": {
"description": "The unique work item configuration Id. This can be either friendly name of connector as defined in connector configuration",
"in": "path",
"name": "workItemConfigId",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/DefaultWorkItemConfig": {
"get": {
"description": "Gets default work item configurations that exist for the application",
"operationId": "WorkItemConfigurations_GetDefault",
"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"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/WorkItemConfiguration"
}
}
},
"x-ms-examples": {
"WorkItemConfigurationsGetDefault": {
"parameters": {
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"ConfigDisplayName": "Visual Studio Team Services",
"ConfigProperties": "{\"VSOAccountBaseUrl\":\"https://testtodelete.visualstudio.com\",\"ProjectCollection\":\"DefaultCollection\",\"Project\":\"todeletefirst\",\"ResourceId\":\"d0662b05-439a-4a1b-840b-33a7f8b42ebf\",\"ConfigurationType\":\"Standard\",\"WorkItemType\":\"Bug\",\"AreaPath\":\"todeletefirst\",\"AssignedTo\":\"\"}",
"ConnectorId": "d334e2a4-6733-488e-8645-a9fdc1694f41",
"Id": "Visual Studio Team Services",
"IsDefault": true
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/WorkItemConfigs": {
"get": {
"description": "Gets the list work item configurations that exist for the application",
"operationId": "WorkItemConfigurations_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"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/WorkItemConfigurationsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/WorkItemConfigurationError"
}
}
},
"x-ms-examples": {
"WorkItemConfigurationsList": {
"parameters": {
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": [
{
"ConfigDisplayName": "Visual Studio Team Services",
"ConfigProperties": "{\"VSOAccountBaseUrl\":\"https://testtodelete.visualstudio.com\",\"ProjectCollection\":\"DefaultCollection\",\"Project\":\"todeletefirst\",\"ResourceId\":\"b370eeb2-5dff-4838-8253-ec3014b2c706\",\"ConfigurationType\":\"Standard\",\"WorkItemType\":\"Bug\",\"AreaPath\":\"todeletefirst\",\"AssignedTo\":\"\"}",
"ConnectorId": "d334e2a4-6733-488e-8645-a9fdc1694f41",
"Id": "Visual Studio Team Services",
"IsDefault": true
},
{
"ConfigDisplayName": "GitHub",
"ConfigProperties": "{\"GitHubAccountUrl\":\"https://github.com/jpiyali/testrepository\",\"ResourceId\":\"b370eeb2-5dff-4838-8253-ec3014b2c706\"}",
"ConnectorId": "4C89E219-D47E-4C14-866A-018D6D634CF3",
"Id": "GitHub",
"IsDefault": false
}
]
}
}
}
},
"x-ms-pageable": {
"nextLinkName": null
}
},
"post": {
"description": "Create a work item configuration for an Application Insights component.",
"operationId": "WorkItemConfigurations_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 a work item configuration of a Application Insights component.",
"in": "body",
"name": "WorkItemConfigurationProperties",
"required": true,
"schema": {
"$ref": "#/definitions/WorkItemCreateConfiguration"
}
}
],
"responses": {
"200": {
"description": "An object containing the work item configuration definition created by this PUT call.",
"schema": {
"$ref": "#/definitions/WorkItemConfiguration"
}
}
},
"x-ms-examples": {
"WorkItemConfigurationsCreate": {
"parameters": {
"WorkItemConfigurationProperties": {
"ConnectorDataConfiguration": "{\"VSOAccountBaseUrl\":\"https://testtodelete.visualstudio.com\",\"ProjectCollection\":\"DefaultCollection\",\"Project\":\"todeletefirst\",\"ResourceId\":\"d0662b05-439a-4a1b-840b-33a7f8b42ebf\",\"Custom\":\"{\\\"/fields/System.WorkItemType\\\":\\\"Bug\\\",\\\"/fields/System.AreaPath\\\":\\\"todeletefirst\\\",\\\"/fields/System.AssignedTo\\\":\\\"\\\"}\"}",
"ConnectorId": "d334e2a4-6733-488e-8645-a9fdc1694f41",
"ValidateOnly": true,
"WorkItemProperties": [
{
"name": "Title",
"value": "Validate Only Title"
},
{
"name": "Description",
"value": "Validate Only Description"
}
]
},
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/WorkItemConfigs/{workItemConfigId}": {
"delete": {
"description": "Delete a work item configuration of an Application Insights component.",
"operationId": "WorkItemConfigurations_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/WorkItemConfigIdParameter"
}
],
"responses": {
"200": {
"description": "The work item configuration that was successfully deleted."
}
},
"x-ms-examples": {
"WorkItemConfigurationDelete": {
"parameters": {
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid",
"workItemConfigId": "Visual Studio Team Services"
},
"responses": {
"200": {}
}
}
}
},
"get": {
"description": "Gets specified work item configuration for an Application Insights component.",
"operationId": "WorkItemConfigurations_GetItem",
"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/WorkItemConfigIdParameter"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/WorkItemConfiguration"
}
}
},
"x-ms-examples": {
"WorkItemConfigurationsGetDefault": {
"parameters": {
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid",
"workItemConfigId": "Visual Studio Team Services"
},
"responses": {
"200": {
"body": {
"ConfigDisplayName": "Visual Studio Team Services",
"ConfigProperties": "{\"VSOAccountBaseUrl\":\"https://testtodelete.visualstudio.com\",\"ProjectCollection\":\"DefaultCollection\",\"Project\":\"todeletefirst\",\"ResourceId\":\"d0662b05-439a-4a1b-840b-33a7f8b42ebf\",\"ConfigurationType\":\"Standard\",\"WorkItemType\":\"Bug\",\"AreaPath\":\"todeletefirst\",\"AssignedTo\":\"\"}",
"ConnectorId": "d334e2a4-6733-488e-8645-a9fdc1694f41",
"Id": "Visual Studio Team Services",
"IsDefault": true
}
}
}
}
}
},
"patch": {
"description": "Update a work item configuration for an Application Insights component.",
"operationId": "WorkItemConfigurations_UpdateItem",
"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/WorkItemConfigIdParameter"
},
{
"description": "Properties that need to be specified to update a work item configuration for this Application Insights component.",
"in": "body",
"name": "WorkItemConfigurationProperties",
"required": true,
"schema": {
"$ref": "#/definitions/WorkItemCreateConfiguration"
}
}
],
"responses": {
"200": {
"description": "Successful operation indicating the config updated by this PATCH call.",
"schema": {
"$ref": "#/definitions/WorkItemConfiguration"
}
}
},
"x-ms-examples": {
"WorkItemConfigurationsCreate": {
"parameters": {
"WorkItemConfigurationProperties": {
"ConnectorDataConfiguration": "{\"VSOAccountBaseUrl\":\"https://testtodelete.visualstudio.com\",\"ProjectCollection\":\"DefaultCollection\",\"Project\":\"todeletefirst\",\"ResourceId\":\"d0662b05-439a-4a1b-840b-33a7f8b42ebf\",\"Custom\":\"{\\\"/fields/System.WorkItemType\\\":\\\"Bug\\\",\\\"/fields/System.AreaPath\\\":\\\"todeletefirst\\\",\\\"/fields/System.AssignedTo\\\":\\\"\\\"}\"}",
"ConnectorId": "d334e2a4-6733-488e-8645-a9fdc1694f41",
"ValidateOnly": true,
"WorkItemProperties": [
{
"name": "Title",
"value": "Validate Only Title"
},
{
"name": "Description",
"value": "Validate Only Description"
}
]
},
"api-version": "2015-05-01",
"resourceGroupName": "my-resource-group",
"resourceName": "my-component",
"subscriptionId": "subid",
"workItemConfigId": "Visual Studio Team Services"
},
"responses": {
"200": {
"body": {
"ConfigDisplayName": "Visual Studio Team Services",
"ConfigProperties": "{\"VSOAccountBaseUrl\":\"https://testtodelete.visualstudio.com\",\"ProjectCollection\":\"DefaultCollection\",\"Project\":\"todeletefirst\",\"ResourceId\":\"d0662b05-439a-4a1b-840b-33a7f8b42ebf\",\"ConfigurationType\":\"Standard\",\"WorkItemType\":\"Bug\",\"AreaPath\":\"todeletefirst\",\"AssignedTo\":\"\"}",
"ConnectorId": "d334e2a4-6733-488e-8645-a9fdc1694f41",
"Id": "Visual Studio Team Services",
"IsDefault": true
}
}
}
}
}
}
}
},
"definitions": {
"InnerError": {
"description": "Inner error",
"properties": {
"diagnosticcontext": {
"description": "Provides correlation for request",
"type": "string"
},
"time": {
"description": "Request time",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"WorkItemConfiguration": {
"description": "Work item configuration associated with an application insights resource.",
"properties": {
"ConfigDisplayName": {
"description": "Configuration friendly name",
"type": "string"
},
"ConfigProperties": {
"description": "Serialized JSON object for detailed properties",
"type": "string"
},
"ConnectorId": {
"description": "Connector identifier where work item is created",
"type": "string"
},
"Id": {
"description": "Unique Id for work item",
"type": "string"
},
"IsDefault": {
"description": "Boolean value indicating whether configuration is default",
"type": "boolean"
}
},
"type": "object"
},
"WorkItemConfigurationError": {
"description": "Error associated with trying to get work item configuration or configurations",
"properties": {
"code": {
"description": "Error detail code and explanation",
"type": "string"
},
"innererror": {
"$ref": "#/definitions/InnerError"
},
"message": {
"description": "Error message",
"type": "string"
}
},
"type": "object"
},
"WorkItemConfigurationsListResult": {
"description": "Work item configuration list result.",
"properties": {
"value": {
"description": "An array of work item configurations.",
"items": {
"$ref": "#/definitions/WorkItemConfiguration"
},
"readOnly": true,
"type": "array"
}
}
},
"WorkItemCreateConfiguration": {
"description": "Work item configuration creation payload",
"properties": {
"ConnectorDataConfiguration": {
"description": "Serialized JSON object for detailed properties",
"type": "string"
},
"ConnectorId": {
"description": "Unique connector id",
"type": "string"
},
"ValidateOnly": {
"description": "Boolean indicating validate only",
"type": "boolean"
},
"WorkItemProperties": {
"additionalProperties": {
"type": "string"
},
"description": "Custom work item properties",
"type": "object"
}
},
"type": "object"
}
}
}