Skip to content

Commit

Permalink
Document existing capabilites related apis (Azure#2342)
Browse files Browse the repository at this point in the history 
* add capabilities related apis

* remove unnecesary change in pacakge.json

* update for code review feedback
  • Loading branch information
@frankguodongchen @jianghaolu
frankguodongchen authored and jianghaolu committed Feb 2, 2018
1 parent f9ec240 commit 1dcfeb3
Show file tree
Hide file tree
Showing 5 changed files with 573 additions and 2 deletions.
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
"scripts": {
"test": "mocha -t 500000"
}
}
}
260 changes: 259 additions & 1 deletion ...esource-manager/microsoft.insights/stable/2015-05-01/componentFeaturesAndPricing_API.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,72 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/featurecapabilities": {
"get": {
"description": "Returns feature capabilites of the application insights component.",
"operationId": "ComponentFeatureCapabilities_Get",
"parameters": [
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceNameParameter"
}
],
"responses": {
"200": {
"description": "An Application Insights component feature capabilities definition.",
"schema": {
"$ref": "#/definitions/ApplicationInsightsComponentFeatureCapabilities"
}
}
},
"x-ms-examples": {
"ComponentCurrentBillingFeaturesGet": {
"$ref": "./examples/FeatureCapabilitiesGet.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/components/{resourceName}/getavailablebillingfeatures": {
"get": {
"description": "Returns all available features of the application insights component.",
"operationId": "ComponentAvailableFeatures_Get",
"parameters": [
{
"$ref": "#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ResourceNameParameter"
}
],
"responses": {
"200": {
"description": "An Application Insights component available features definition.",
"schema": {
"$ref": "#/definitions/ApplicationInsightsComponentAvailableFeatures"
}
}
},
"x-ms-examples": {
"ComponentCurrentBillingFeaturesGet": {
"$ref": "./examples/AvailableBillingFeaturesGet.json"
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -211,7 +277,199 @@
"description": "Date and time when the daily data volume cap will be reset, and data ingestion will resume."
}
}
}
},
"ApplicationInsightsComponentFeatureCapabilities": {
"type": "object",
"description": "An Application Insights component feature capabilities",
"properties": {
"SupportExportData": {
"type": "boolean",
"readOnly": true,
"description": "Whether allow to use continuous export feature."
},
"BurstThrottlePolicy": {
"type": "string",
"readOnly": true,
"description": "Reserved, not used now."
},
"MetadataClass": {
"type": "string",
"readOnly": true,
"description": "Reserved, not used now."
},
"LiveStreamMetrics": {
"type": "boolean",
"readOnly": true,
"description": "Reserved, not used now."
},
"ApplicationMap": {
"type": "boolean",
"readOnly": true,
"description": "Reserved, not used now."
},
"WorkItemIntegration": {
"type": "boolean",
"readOnly": true,
"description": "Whether allow to use work item integration feature."
},
"PowerBIIntegration": {
"type": "boolean",
"readOnly": true,
"description": "Reserved, not used now."
},
"OpenSchema": {
"type": "boolean",
"readOnly": true,
"description": "Reserved, not used now."
},
"ProactiveDetection": {
"type": "boolean",
"readOnly": true,
"description": "Reserved, not used now."
},
"AnalyticsIntegration": {
"type": "boolean",
"readOnly": true,
"description": "Reserved, not used now."
},
"MultipleStepWebTest": {
"type": "boolean",
"readOnly": true,
"description": "Whether allow to use multiple steps web test feature."
},
"ApiAccessLevel": {
"type": "string",
"readOnly": true,
"description": "Reserved, not used now."
},
"TrackingType": {
"type": "string",
"readOnly": true,
"description": "The applciation insights component used tracking type."
},
"DailyCap": {
"type": "number",
"readOnly": true,
"description": "Daily data volume cap in GB."
},
"DailyCapResetTime": {
"type": "number",
"readOnly": true,
"description": "Daily data volume cap UTC reset hour."
},
"ThrottleRate": {
"type": "number",
"readOnly": true,
"description": "Reserved, not used now."
}
}
},
"ApplicationInsightsComponentAvailableFeatures":{
"type": "object",
"description": "An Application Insights component available features.",
"properties": {
"Result": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/ApplicationInsightsComponentFeature"
},
"readOnly": true,
"description": "A list of Application Insigths component feature."
}
}
},
"ApplicationInsightsComponentFeature":{
"type": "object",
"description": "An Application Insights component daily data volume cap status",
"properties": {
"FeatureName":{
"type": "string",
"readOnly": true,
"description": "The pricing feature name."
},
"MeterId":{
"type": "string",
"readOnly": true,
"description": "The meter id used for the feature."
},
"MeterRateFrequency":{
"type": "string",
"readOnly": true,
"description": "The meter meter rate for the feature's meter."
},
"ResouceId":{
"type": "string",
"readOnly": true,
"description": "Reserved, not used now."
},
"IsHidden":{
"type": "boolean",
"readOnly": true,
"description": "Reserved, not used now."
},
"Capabilities":{
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/ApplicationInsightsComponentFeatureCapability"
},
"readOnly": true,
"description": "A list of Application Insigths component feature capability."
},
"Title": {
"type": "string",
"readOnly": true,
"description": "Desplay name of the feature."
},
"IsMainFeature": {
"type": "boolean",
"readOnly": true,
"description": "Whether can apply addon feature on to it."
},
"SupportedAddonFeatures": {
"type": "string",
"readOnly": true,
"description": "The add on features on main feature."
}
}
},
"ApplicationInsightsComponentFeatureCapability": {
"type": "object",
"description": "An Application Insights component feature capability",
"properties": {
"Name":{
"type": "string",
"readOnly": true,
"description": "The name of the capability."
},
"Description":{
"type": "string",
"readOnly": true,
"description": "The description of the capability."
},
"Value":{
"type": "string",
"readOnly": true,
"description": "The vaule of the capability."
},
"Unit":{
"type": "string",
"readOnly": true,
"description": "The unit of the capability."
},
"MeterId":{
"type": "string",
"readOnly": true,
"description": "The meter used for the capability."
},
"MeterRateFrequency":{
"type": "string",
"readOnly": true,
"description": "The meter rate of the meter."
}
}
}
},
"parameters": {
"SubscriptionIdParameter": {
Expand Down
Loading

0 comments on commit 1dcfeb3

Please sign in to comment.