Skip to content

Commit 94e9e12

Browse files
gardnerjrgardnerjr
authored
Adding swagger docs for existing myworkbooks API's (#10462)
1 parent 3ab1e68 commit 94e9e12

File tree

9 files changed

+758
-0
lines changed

9 files changed

+758
-0
lines changed

‎custom-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -988,6 +988,7 @@ mysite
988988
mysquare
989989
mystore
990990
myvolume
991+
myworkbooks
991992
n'eventtype
992993
n'recognition
993994
nagios

‎specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/MyWorkbookAdd.json

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"parameters": {
3+
"api-version": "2015-05-01",
4+
"resourceGroupName": "my-resource-group",
5+
"resourceName": "deadb33f-8bee-4d3b-a059-9be8dac93960",
6+
"subscriptionId": "00000000-0000-0000-0000-00000000",
7+
"workbookProperties": {
8+
"id": "c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
9+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
10+
"location": "west us",
11+
"kind": "user",
12+
"properties": {
13+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
14+
"displayName": "Blah Blah Blah",
15+
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
16+
"category": "workbook"
17+
},
18+
"tags": [
19+
"TagSample01",
20+
"TagSample02"
21+
]
22+
}
23+
},
24+
"responses": {
25+
"200": {
26+
"body": {
27+
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/my-resource-group/providers/microsoft.insights/myworkbooks/deadb33f-8bee-4d3b-a059-9be8dac93960",
28+
"type": "microsoft.insights/myworkbooks",
29+
"location": "westus",
30+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
31+
"kind": "user",
32+
"properties": {
33+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
34+
"displayName": "Blah Blah Blah",
35+
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
36+
"version": "ME",
37+
"category": "workbook"
38+
},
39+
"tags": [
40+
"TagSample01",
41+
"TagSample02"
42+
]
43+
}
44+
},
45+
"201": {
46+
"body": {
47+
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/my-resource-group/providers/microsoft.insights/myworkbooks/deadb33f-8bee-4d3b-a059-9be8dac93960",
48+
"type": "",
49+
"location": "westus",
50+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
51+
"kind": "user",
52+
"properties": {
53+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
54+
"displayName": "Blah Blah Blah",
55+
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
56+
"version": "ME",
57+
"category": "workbook"
58+
},
59+
"tags": [
60+
"TagSample01",
61+
"TagSample02"
62+
]
63+
}
64+
}
65+
}
66+
}

‎specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/MyWorkbookDelete.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"parameters": {
3+
"api-version": "2015-05-01",
4+
"subscriptionId": "subid",
5+
"resourceGroupName": "my-resource-group",
6+
"resourceName": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"
7+
},
8+
"responses": {
9+
"201": {},
10+
"204": {}
11+
}
12+
}

‎specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/MyWorkbookGet.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"parameters": {
3+
"api-version": "2015-05-01",
4+
"subscriptionId": "6b643656-33eb-422f-aee8-3ac145d124af",
5+
"resourceGroupName": "my-resource-group",
6+
"resourceName": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"id": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/microsoft.insights/myworkbooks/deadb33f-8bee-4d3b-a059-9be8dac93960",
12+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
13+
"type": "microsoft.insights/myworkbooks",
14+
"location": "westus",
15+
"kind": "user",
16+
"properties": {
17+
"displayName": "My New Workbook",
18+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
19+
"userId": "userId",
20+
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
21+
"version": "ME",
22+
"category": "workbook",
23+
"timeModified": null
24+
},
25+
"tags": [
26+
"TagSample01",
27+
"TagSample02"
28+
]
29+
}
30+
}
31+
}
32+
}

‎specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/MyWorkbookUpdate.json

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"parameters": {
3+
"api-version": "2015-05-01",
4+
"subscriptionId": "6b643656-33eb-422f-aee8-3ac145d124af",
5+
"resourceGroupName": "my-resource-group",
6+
"resourceName": "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
7+
"workbookProperties": {
8+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
9+
"location": "west us",
10+
"tags": [
11+
"TagSample01",
12+
"TagSample02"
13+
],
14+
"kind": "user",
15+
"properties": {
16+
"displayName": "Blah Blah Blah",
17+
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
18+
"version": "ME",
19+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
20+
"category": "workbook"
21+
}
22+
}
23+
},
24+
"responses": {
25+
"200": {
26+
"body": {
27+
"id": "c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
28+
"type": "microsoft.insights/myworkbooks",
29+
"location": "westus",
30+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
31+
"tags": [
32+
"TagSample01",
33+
"TagSample02"
34+
],
35+
"kind": "user",
36+
"properties": {
37+
"displayName": "Blah Blah Blah",
38+
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
39+
"version": "ME",
40+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
41+
"category": "workbook"
42+
}
43+
}
44+
}
45+
}
46+
}

‎specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/MyWorkbooksList.json

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"parameters": {
3+
"api-version": "2015-05-01",
4+
"subscriptionId": "6b643656-33eb-422f-aee8-3ac145d124af",
5+
"resourceGroupName": "my-resource-group",
6+
"category": "workbook"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": [
11+
{
12+
"id": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/microsoft.insights/myworkbooks/c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
13+
"type": "microsoft.insights/myworkbooks",
14+
"location": "westus",
15+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
16+
"tags": [],
17+
"kind": "user",
18+
"properties": {
19+
"displayName": "My Workbook 1",
20+
"userId": "userId",
21+
"serializedData": "{\"verion\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
22+
"version": "ME",
23+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
24+
"category": "workbook",
25+
"timeModified": null
26+
}
27+
},
28+
{
29+
"id": "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/microsoft.insights/myworkbooks/c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
30+
"type": "microsoft.insights/myworkbooks",
31+
"location": "westus",
32+
"name": "deadb33f-8bee-4d3b-a059-9be8dac93960",
33+
"kind": "user",
34+
"tags": [
35+
"SampleTag01",
36+
"SampleTag2"
37+
],
38+
"properties": {
39+
"displayName": "My Workbook 2",
40+
"userId": "userId",
41+
"serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
42+
"version": "ME",
43+
"sourceId": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Web/sites/MyTestApp-CodeLens",
44+
"category": "workbook",
45+
"timeModified": null
46+
}
47+
}
48+
]
49+
}
50+
}
51+
}

0 commit comments

Comments
 (0)