openapi-directory/api/azure.com/applicationinsights-favorites_API.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Azure Application Insights client for favorites.","title":"ApplicationInsightsManagementClient","version":"2015-05-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"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/favorites_API.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"applicationinsights-favorites_API","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/favorites":{"get":{"description":"Gets a list of favorites defined within an Application Insights component.","operationId":"Favorites_List","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"FavoritesList":{"value":"my-resource-group"}}},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoritesList":{"value":"2015-05-01"}}},{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoritesList":{"value":"subid"}}},{"$ref":"#/components/parameters/ResourceNameParameter"},{"$ref":"#/components/parameters/FavoriteTypeParameter"},{"$ref":"#/components/parameters/SourceTypeParameter"},{"$ref":"#/components/parameters/CanFetchFavoriteContentParameter"},{"$ref":"#/components/parameters/TagsFilterParameter"}],"responses":{"200":{"description":"A list containing 0 or more favorite definitions associated to the Application Insights component.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApplicationInsightsComponentFavorite"},"type":"array"},"examples":{"FavoritesList":{"$ref":"#/components/examples/FavoritesList"}}}}}}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/favorites/{favoriteId}":{"delete":{"description":"Remove a favorite that is associated to an Application Insights component.","operationId":"Favorites_Delete","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"FavoriteList":{"value":"my-resource-group"}}},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteList":{"value":"2015-05-01"}}},{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteList":{"value":"subid"}}},{"$ref":"#/components/parameters/ResourceNameParameter"},{"$ref":"#/components/parameters/FavoriteIdParameter"}],"responses":{"200":{"description":"The favorite has been successfully removed from the Application Insights component."}}},"get":{"description":"Get a single favorite by its FavoriteId, defined within an Application Insights component.","operationId":"Favorites_Get","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"FavoriteGet":{"value":"my-resource-group"}}},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteGet":{"value":"2015-05-01"}}},{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteGet":{"value":"subid"}}},{"$ref":"#/components/parameters/ResourceNameParameter"},{"$ref":"#/components/parameters/FavoriteIdParameter"}],"responses":{"200":{"description":"A favorite definition associated to the Application Insights component.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentFavorite"},"examples":{"FavoriteGet":{"$ref":"#/components/examples/FavoriteGet"}}}}}}},"patch":{"description":"Updates a favorite that has already been added to an Application Insights component.","operationId":"Favorites_Update","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"FavoriteList":{"value":"my-resource-group"}}},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteList":{"value":"2015-05-01"}}},{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteList":{"value":"subid"}}},{"$ref":"#/components/parameters/ResourceNameParameter"},{"$ref":"#/components/parameters/FavoriteIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentFavorite"}}},"description":"Properties that need to be specified to update the existing favorite.","required":true},"responses":{"200":{"description":"The favorite definition updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentFavorite"},"examples":{"FavoriteList":{"$ref":"#/components/examples/FavoriteList"}}}}}}},"put":{"description":"Adds a new favorites to an Application Insights component.","operationId":"Favorites_Add","parameters":[{"description":"The name of the resource group. The name is case insensitive.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._\\(\\)]+$"},"examples":{"FavoriteAdd":{"value":"my-resource-group"}}},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteAdd":{"value":"2015-05-01"}}},{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"FavoriteAdd":{"value":"subid"}}},{"$ref":"#/components/parameters/ResourceNameParameter"},{"$ref":"#/components/parameters/FavoriteIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentFavorite"}}},"description":"Properties that need to be specified to create a new favorite and add it to an Application Insights component.","required":true},"responses":{"200":{"description":"The newly created favorite that is associated to the Application Insights component.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationInsightsComponentFavorite"},"examples":{"FavoriteAdd":{"$ref":"#/components/examples/FavoriteAdd"}}}}}}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"FavoritesList":{"value":[{"Config":"blah blah","FavoriteId":"c0deea5e-3344-40f2-96f8-6f8e1c3b5722","FavoriteType":"shared","IsGeneratedFromTemplate":false,"Name":"Example Metric Chart Favorite","Tags":[],"TimeModified":"2018-01-31T23:56:16.008902Z","Version":"ME"},{"Config":"{\"TimeSelection\":{\"durationMs\":1800000,\"endTime\":\"2018-01-31T23:56:15.493Z\",\"createdTime\":\"Wed Jan 31 2018 15:58:36 GMT-0800 (Pacific Standard Time)\",\"isInitialTime\":false,\"grain\":1,\"useDashboardTimeRange\":false},\"SearchFilter\":{\"eventTypes\":[1,2],\"typeFacets\":{},\"isPermissive\":false},\"QueryText\":\"*\",\"partId\":\"99e33a16-1b00-4a7d-b98f-a3c1bb3a4df8\"}","FavoriteId":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2","FavoriteType":"shared","IsGeneratedFromTemplate":false,"Name":"Example Search Blade Favorite","Tags":["SampleTag01","SampleTag2"],"TimeModified":"2018-01-31T23:59:25.4594264Z","Version":"Search"}]},"FavoriteGet":{"value":{"Config":"{\"TimeSelection\":{\"durationMs\":1800000,\"endTime\":\"2018-01-31T23:56:15.493Z\",\"createdTime\":\"Wed Jan 31 2018 15:58:36 GMT-0800 (Pacific Standard Time)\",\"isInitialTime\":false,\"grain\":1,\"useDashboardTimeRange\":false},\"SearchFilter\":{\"eventTypes\":[1,2],\"typeFacets\":{},\"isPermissive\":false},\"QueryText\":\"*\",\"partId\":\"99e33a16-1b00-4a7d-b98f-a3c1bb3a4df8\"}","FavoriteId":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2","FavoriteType":"shared","IsGeneratedFromTemplate":false,"Name":"Example Search Blade Favorite","Tags":["SampleTag1","SampleTag2"],"TimeModified":"2018-01-31T23:59:25.4594264Z","Version":"Search"}},"FavoriteList":{"value":{"Config":"{\"MEDataModelRawJSON\":\"{\\\"version\\\": \\\"1.4.1\\\",\\\"isCustomDataModel\\\": true,\\\"items\\\": [{\\\"id\\\": \\\"90a7134d-9a38-4c25-88d3-a495209873eb\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Sum\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"fail\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"0c289098-88e8-4010-b212-546815cddf70\\\",\\\"chartType\\\": \\\"Area\\\",\\\"chartHeight\\\": 2,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-j1\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"greenHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"cbdaab6f-a808-4f71-aca5-b3976cbb7345\\\",\\\"chartType\\\": \\\"Bar\\\",\\\"chartHeight\\\": 4,\\\"metrics\\\": [{\\\"id\\\": \\\"preview/requests/duration\\\",\\\"metricAggregation\\\": \\\"Avg\\\",\\\"color\\\": \\\"msportalfx-bgcolor-d0\\\"}],\\\"priorPeriod\\\": false,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"aggregation\\\": \\\"Avg\\\",\\\"percentage\\\": false,\\\"palette\\\": \\\"magentaHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"},{\\\"id\\\": \\\"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\\\",\\\"grouping\\\": {\\\"kind\\\": \\\"ByDimension\\\",\\\"dimension\\\": \\\"context.application.version\\\"},\\\"chartType\\\": \\\"Grid\\\",\\\"chartHeight\\\": 1,\\\"metrics\\\": [{\\\"id\\\": \\\"basicException.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-g0\\\"},{\\\"id\\\": \\\"requestFailed.count\\\",\\\"metricAggregation\\\": \\\"Sum\\\",\\\"color\\\": \\\"msportalfx-bgcolor-f0s2\\\"}],\\\"priorPeriod\\\": true,\\\"clickAction\\\": {\\\"defaultBlade\\\": \\\"SearchBlade\\\"},\\\"horizontalBars\\\": true,\\\"showOther\\\": true,\\\"percentage\\\": false,\\\"palette\\\": \\\"blueHues\\\",\\\"yAxisOption\\\": 0,\\\"title\\\": \\\"\\\"}],\\\"currentFilter\\\": {\\\"eventTypes\\\": [1,2],\\\"typeFacets\\\": {},\\\"isPermissive\\\": false},\\\"timeContext\\\": {\\\"durationMs\\\": 75600000,\\\"endTime\\\": \\\"2018-01-31T20:30:00.000Z\\\",\\\"createdTime\\\": \\\"2018-01-31T23:54:26.280Z\\\",\\\"isInitialTime\\\": false,\\\"grain\\\": 1,\\\"useDashboardTimeRange\\\": false},\\\"jsonUri\\\": \\\"Favorite_BlankChart\\\",\\\"timeSource\\\": 0}\"}","FavoriteId":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2","FavoriteType":"shared","IsGeneratedFromTemplate":false,"Name":"Derek Changed This","Tags":["TagSample01","TagSample02","TagSample03"],"TimeModified":"2018-02-02T18:39:11.6569686Z","Version":"ME"}},"FavoriteAdd":{"value":{"Category":"","Config":"{\"MEDataModelRawJSON\":{\n  \"version\": \"1.4.1\",\n  \"isCustomDataModel\": true,\n  \"items\": [\n    {\n      \"id\": \"90a7134d-9a38-4c25-88d3-a495209873eb\",\n      \"chartType\": \"Area\",\n \"chartHeight\": 4,\n      \"metrics\": [\n        {\n          \"id\": \"preview/requests/count\",\n          \"metricAggregation\": \"Sum\",\n          \"color\": \"msportalfx-bgcolor-d0\"\n        }\n],\n      \"priorPeriod\": false,\n      \"clickAction\": {\n        \"defaultBlade\": \"SearchBlade\"\n      },\n      \"horizontalBars\": true,\n      \"showOther\": true,\n      \"aggregation\": \"Sum\",\n \"percentage\": false,\n      \"palette\": \"fail\",\n      \"yAxisOption\": 0,\n      \"title\": \"\"\n    },\n    {\n      \"id\": \"0c289098-88e8-4010-b212-546815cddf70\",\n      \"chartType\": \"Area\",\n      \"chartHeight\": 2,\n      \"metrics\": [\n        {\n          \"id\": \"preview/requests/duration\",\n          \"metricAggregation\": \"Avg\",\n          \"color\": \"msportalfx-bgcolor-j1\"\n        }\n      ],\n      \"priorPeriod\": false,\n      \"clickAction\": {\n        \"defaultBlade\": \"SearchBlade\"\n      },\n      \"horizontalBars\": true,\n \"showOther\": true,\n      \"aggregation\": \"Avg\",\n      \"percentage\": false,\n      \"palette\": \"greenHues\",\n      \"yAxisOption\": 0,\n      \"title\": \"\"\n    },\n    {\n      \"id\": \"cbdaab6f-a808-4f71-aca5-b3976cbb7345\",\n      \"chartType\": \"Bar\",\n      \"chartHeight\": 4,\n      \"metrics\": [\n        {\n          \"id\": \"preview/requests/duration\",\n \"metricAggregation\": \"Avg\",\n          \"color\": \"msportalfx-bgcolor-d0\"\n        }\n      ],\n      \"priorPeriod\": false,\n      \"clickAction\": {\n        \"defaultBlade\": \"SearchBlade\"\n },\n      \"horizontalBars\": true,\n      \"showOther\": true,\n      \"aggregation\": \"Avg\",\n      \"percentage\": false,\n      \"palette\": \"magentaHues\",\n      \"yAxisOption\": 0,\n      \"title\": \"\"\n    },\n    {\n      \"id\": \"1d5a6a3a-9fa1-4099-9cf9-05eff72d1b02\",\n      \"grouping\": {\n        \"kind\": \"ByDimension\",\n        \"dimension\": \"context.application.version\"\n      },\n \"chartType\": \"Grid\",\n      \"chartHeight\": 1,\n      \"metrics\": [\n        {\n          \"id\": \"basicException.count\",\n          \"metricAggregation\": \"Sum\",\n          \"color\": \"msportalfx-bgcolor-g0\"\n        },\n        {\n          \"id\": \"requestFailed.count\",\n          \"metricAggregation\": \"Sum\",\n          \"color\": \"msportalfx-bgcolor-f0s2\"\n        }\n      ],\n \"priorPeriod\": true,\n      \"clickAction\": {\n        \"defaultBlade\": \"SearchBlade\"\n      },\n      \"horizontalBars\": true,\n      \"showOther\": true,\n      \"percentage\": false,\n \"palette\": \"blueHues\",\n      \"yAxisOption\": 0,\n      \"title\": \"\"\n    }\n  ],\n  \"currentFilter\": {\n    \"eventTypes\": [\n      1,\n      2\n    ],\n    \"typeFacets\": {},\n \"isPermissive\": false\n  },\n  \"timeContext\": {\n    \"durationMs\": 75600000,\n    \"endTime\": \"2018-01-31T20:30:00.000Z\",\n    \"createdTime\": \"2018-01-31T23:54:26.280Z\",\n    \"isInitialTime\": false,\n    \"grain\": 1,\n    \"useDashboardTimeRange\": false\n  },\n  \"jsonUri\": \"Favorite_BlankChart\",\n  \"timeSource\": 0\n}\"}","FavoriteId":"deadb33f-8bee-4d3b-a059-9be8dac93960","FavoriteType":"shared","IsGeneratedFromTemplate":false,"Name":"Blah Blah Blah","SourceType":"","Tags":["TagSample01","TagSample02"],"TimeModified":"2018-02-02T23:18:32.1850959Z","Version":"ME"}}},"parameters":{"CanFetchFavoriteContentParameter":{"description":"Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.","in":"query","name":"canFetchContent","required":false,"x-ms-parameter-location":"method","schema":{"type":"boolean"}},"FavoriteIdParameter":{"description":"The Id of a specific favorite defined in the Application Insights component","in":"path","name":"favoriteId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"FavoriteList":{"value":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"},"FavoriteGet":{"value":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"},"FavoriteAdd":{"value":"deadb33f-8bee-4d3b-a059-9be8dac93960"}}},"FavoriteTypeParameter":{"description":"The type of favorite. Value can be either shared or user.","in":"query","name":"favoriteType","required":false,"x-ms-enum":{"modelAsString":false,"name":"FavoriteType"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["shared","user"],"default":"shared"}},"ResourceNameParameter":{"description":"The name of the Application Insights component resource.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"FavoritesList":{"value":"my-ai-component"},"FavoriteList":{"value":"my-ai-component"},"FavoriteGet":{"value":"my-ai-component"},"FavoriteAdd":{"value":"my-ai-component"}}},"SourceTypeParameter":{"allowEmptyValue":true,"description":"Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum).","in":"query","name":"sourceType","required":false,"x-ms-enum":{"modelAsString":true,"name":"FavoriteSourceType"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["retention","notebook","sessions","events","userflows","funnel","impact","segmentation"]}},"TagsFilterParameter":{"description":"Tags that must be present on each favorite returned.","in":"query","name":"tags","required":false,"x-ms-parameter-location":"method","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ApplicationInsightsComponentFavorite":{"description":"Properties that define a favorite that is associated to an Application Insights component.","properties":{"Category":{"description":"Favorite category, as defined by the user at creation time.","type":"string"},"Config":{"description":"Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON","type":"string"},"FavoriteId":{"description":"Internally assigned unique id of the favorite definition.","readOnly":true,"type":"string"},"FavoriteType":{"description":"Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.","enum":["shared","user"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"FavoriteType"}},"IsGeneratedFromTemplate":{"description":"Flag denoting wether or not this favorite was generated from a template.","type":"boolean"},"Name":{"description":"The user-defined name of the favorite.","type":"string"},"SourceType":{"description":"The source of the favorite definition.","type":"string"},"Tags":{"description":"A list of 0 or more tags that are associated with this favorite definition","items":{"type":"string"},"type":"array"},"TimeModified":{"description":"Date and time in UTC of the last modification that was made to this favorite definition.","readOnly":true,"type":"string"},"UserId":{"description":"Unique user id of the specific user that owns this favorite.","readOnly":true,"type":"string"},"Version":{"description":"This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.","type":"string"}}}}}}