openapi-directory/api/azure.com/applicationinsights-workbooks_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 workbook type.","title":"ApplicationInsightsManagementClient","version":"2018-06-17-preview","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/preview/2018-06-17-preview/workbooks_API.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"applicationinsights-workbooks_API","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/microsoft.insights/workbooks":{"get":{"description":"Get all Workbooks defined within a specified resource group and category.","operationId":"Workbooks_ListByResourceGroup","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbooksList":{"value":"6b643656-33eb-422f-aee8-3ac145d124af"}}},{"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":{"WorkbooksList":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/CategoryParameter"},{"$ref":"#/components/parameters/TagsParameter"},{"$ref":"#/components/parameters/SourceIdParameter"},{"$ref":"#/components/parameters/CanFetchWorkbookContentParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbooksList":{"value":"2018-06-17-preview"}}}],"responses":{"200":{"description":"A list containing 0 or more workbook definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbooksListResult"},"examples":{"WorkbooksList":{"$ref":"#/components/examples/WorkbooksList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookError"}}}}},"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/microsoft.insights/workbooks/{resourceName}":{"delete":{"description":"Delete a workbook.","operationId":"Workbooks_Delete","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookDelete":{"value":"subid"}}},{"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":{"WorkbookDelete":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookResourceNameParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookDelete":{"value":"2018-06-17-preview"}}}],"responses":{"201":{"description":"The workbook has been successfully deleted."},"204":{"description":"The resource doesn't exist."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookError"}}}}}},"get":{"description":"Get a single workbook by its resourceName.","operationId":"Workbooks_Get","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookGet":{"value":"6b643656-33eb-422f-aee8-3ac145d124af"}}},{"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":{"WorkbookGet":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookResourceNameParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookGet":{"value":"2018-06-17-preview"}}}],"responses":{"200":{"description":"A workbook definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workbook"},"examples":{"WorkbookGet":{"$ref":"#/components/examples/WorkbookGet"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookError"}}}}}},"patch":{"description":"Updates a workbook that has already been added.","operationId":"Workbooks_Update","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookUpdate":{"value":"6b643656-33eb-422f-aee8-3ac145d124af"}}},{"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":{"WorkbookUpdate":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookResourceNameParameter"},{"$ref":"#/components/parameters/SourceIdParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookUpdate":{"value":"2018-06-17-preview"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookUpdateParameters"}}},"description":"Properties that need to be specified to create a new workbook."},"responses":{"200":{"description":"The workbook definition updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workbook"},"examples":{"WorkbookUpdate":{"$ref":"#/components/examples/WorkbookUpdate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookError"}}}}}},"put":{"description":"Create a new workbook.","operationId":"Workbooks_CreateOrUpdate","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookAdd":{"value":"subid"}}},{"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":{"WorkbookAdd":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookResourceNameParameter"},{"$ref":"#/components/parameters/SourceIdParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookAdd":{"value":"2018-06-17-preview"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workbook"}}},"description":"Properties that need to be specified to create a new workbook.","required":true},"responses":{"200":{"description":"The newly created workbook.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workbook"},"examples":{"WorkbookAdd":{"$ref":"#/components/examples/WorkbookAdd"}}}}},"201":{"description":"The newly created workbook.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workbook"},"examples":{"WorkbookAdd":{"$ref":"#/components/examples/WorkbookAdd"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookError"}}}}}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"WorkbooksList":{"value":[{"id":"c0deea5e-3344-40f2-96f8-6f8e1c3b5722","kind":"shared","location":"westus","name":"deadb33f-8bee-4d3b-a059-9be8dac93960","properties":{"category":"workbook","displayName":"My Workbook 1","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}","userId":"userId","version":"ME"},"tags":[],"type":""},{"id":"c0deea5e-3344-40f2-96f8-6f8e1c3b5722","kind":"shared","location":"westus","name":"deadb33f-8bee-4d3b-a059-9be8dac93960","properties":{"category":"workbook","displayName":"My Workbook 2","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}","userId":"userId","version":"ME"},"tags":["SampleTag01","SampleTag2"],"type":""}]},"WorkbookGet":{"value":{"id":"c0deea5e-3344-40f2-96f8-6f8e1c3b5722","kind":"shared","location":"westus","name":"deadb33f-8bee-4d3b-a059-9be8dac93960","properties":{"category":"workbook","displayName":"My New Workbook","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}","userId":"userId","version":"ME"},"type":""}},"WorkbookUpdate":{"value":{"id":"c0deea5e-3344-40f2-96f8-6f8e1c3b5722","kind":"shared","location":"westus","name":"deadb33f-8bee-4d3b-a059-9be8dac93960","properties":{"category":"workbook","displayName":"Blah Blah Blah","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}","userId":"userId","version":"ME"},"type":""}},"WorkbookAdd":{"value":{"id":"c0deea5e-3344-40f2-96f8-6f8e1c3b5722","kind":"shared","location":"westus","name":"deadb33f-8bee-4d3b-a059-9be8dac93960","properties":{"category":"workbook","displayName":"Blah Blah Blah","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}","userId":"userId","version":"ME"},"type":""}}},"parameters":{"CanFetchWorkbookContentParameter":{"description":"Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.","in":"query","name":"canFetchContent","required":false,"x-ms-parameter-location":"method","schema":{"type":"boolean"}},"CategoryParameter":{"description":"Category of workbook to return.","in":"query","name":"category","required":true,"x-ms-enum":{"modelAsString":true,"name":"CategoryType"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["workbook","TSG","performance","retention"]},"examples":{"WorkbooksList":{"value":"workbook"}}},"SourceIdParameter":{"description":"Azure Resource Id that will fetch all related workbooks.","in":"query","name":"sourceId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"WorkbooksList":{"value":"/subscriptions/ad2f1a83-caac-4e21-9d2a-9ca3f87105e2/resourceGroups/Default-Web-WestUS/providers/Microsoft.Web/sites/MyTestApp-CodeLens1"},"WorkbookUpdate":{"value":"/subscriptions/ad2f1a83-caac-4e21-9d2a-9ca3f87105e2/resourceGroups/Default-Web-WestUS/providers/Microsoft.Web/sites/MyTestApp-CodeLens1"},"WorkbookAdd":{"value":"/subscriptions/ad2f1a83-caac-4e21-9d2a-9ca3f87105e2/resourceGroups/Default-Web-WestUS/providers/Microsoft.Web/sites/MyTestApp-CodeLens1"}}},"TagsParameter":{"description":"Tags presents on each workbook returned.","in":"query","name":"tags","required":false,"x-ms-parameter-location":"method","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},"WorkbookResourceNameParameter":{"description":"The name of the Application Insights component resource.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"WorkbookDelete":{"value":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"},"WorkbookGet":{"value":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"},"WorkbookUpdate":{"value":"deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"},"WorkbookAdd":{"value":"deadb33f-8bee-4d3b-a059-9be8dac93960"}}}},"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":{"ErrorFieldContract":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"Resource":{"description":"An azure resource object","properties":{"id":{"description":"Azure resource Id","readOnly":true,"type":"string"},"kind":{"description":"The kind of workbook. Choices are user and shared.","enum":["user","shared"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SharedTypeKind"}},"location":{"description":"Resource location","type":"string","x-ms-mutability":["create","read"]},"name":{"description":"Azure resource name. This is GUID value. The display name should be assigned within properties field.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags","type":"object"},"type":{"description":"Azure resource type","readOnly":true,"type":"string"}},"required":["location"],"x-ms-azure-resource":true},"Workbook":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"An Application Insights workbook definition.","properties":{"properties":{"$ref":"#/components/schemas/WorkbookProperties"}}},"WorkbookError":{"description":"Error message body that will indicate why the operation failed.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"$ref":"#/components/schemas/ErrorFieldContract"},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}},"WorkbookProperties":{"description":"Properties that contain a workbook.","properties":{"category":{"description":"Workbook category, as defined by the user at creation time.","type":"string"},"displayName":{"description":"The user-defined name (display name) of the workbook.","type":"string"},"serializedData":{"description":"Configuration of this particular workbook. Configuration data is a string containing valid JSON","type":"string"},"tags":{"description":"A list of 0 or more tags that are associated with this workbook definition","items":{"type":"string"},"type":"array"},"timeModified":{"description":"Date and time in UTC of the last modification that was made to this workbook definition.","readOnly":true,"type":"string"},"userId":{"description":"Unique user id of the specific user that owns this workbook.","type":"string"},"version":{"description":"Workbook version","type":"string"}},"required":["displayName","category","serializedData","userId"]},"WorkbookPropertiesUpdateParameters":{"description":"Properties that contain a workbook for PATCH operation.","properties":{"category":{"description":"Workbook category, as defined by the user at creation time.","type":"string"},"displayName":{"description":"The user-defined name (display name) of the workbook.","type":"string"},"serializedData":{"description":"Configuration of this particular workbook. Configuration data is a string containing valid JSON","type":"string"},"tags":{"description":"A list of 0 or more tags that are associated with this workbook definition","items":{"type":"string"},"type":"array"}}},"WorkbookUpdateParameters":{"description":"The parameters that can be provided when updating workbook properties properties.","properties":{"kind":{"description":"The kind of workbook. Choices are user and shared.","enum":["user","shared"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"SharedTypeKind"}},"properties":{"$ref":"#/components/schemas/WorkbookPropertiesUpdateParameters"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags","type":"object"}}},"WorkbooksListResult":{"description":"Workbook list result.","properties":{"value":{"description":"An array of workbooks.","items":{"$ref":"#/components/schemas/Workbook"},"type":"array"}}}}}}