openapi-directory/api/azure.com/applicationinsights-workbookTemplates_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 template type.","title":"ApplicationInsightsManagementClient","version":"2019-10-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/2019-10-17-preview/workbookTemplates_API.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"applicationinsights-workbookTemplates_API","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/microsoft.insights/workbooktemplates":{"get":{"description":"Get all Workbook templates defined within a specified resource group.","operationId":"WorkbookTemplates_ListByResourceGroup","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplatesList":{"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":{"WorkbookTemplatesList":{"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":{"WorkbookTemplatesList":{"value":"2019-10-17-preview"}}}],"responses":{"200":{"description":"A list containing 0 or more workbook template definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookTemplatesListResult"},"examples":{"WorkbookTemplatesList":{"$ref":"#/components/examples/WorkbookTemplatesList"}}}}},"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/workbooktemplates/{resourceName}":{"delete":{"description":"Delete a workbook template.","operationId":"WorkbookTemplates_Delete","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateDelete":{"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":{"WorkbookTemplateDelete":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookTemplateResourceNameParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateDelete":{"value":"2019-10-17-preview"}}}],"responses":{"200":{"description":"The workbook template 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 template by its resourceName.","operationId":"WorkbookTemplates_Get","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateGet":{"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":{"WorkbookTemplateGet":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookTemplateResourceNameParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateGet":{"value":"2019-10-17-preview"}}}],"responses":{"200":{"description":"A workbook template definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookTemplate"},"examples":{"WorkbookTemplateGet":{"$ref":"#/components/examples/WorkbookTemplateGet"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookError"}}}}}},"patch":{"description":"Updates a workbook template that has already been added.","operationId":"WorkbookTemplates_Update","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateUpdate":{"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":{"WorkbookTemplateUpdate":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookTemplateResourceNameParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateUpdate":{"value":"2018-06-17-preview"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookTemplateUpdateParameters"}}},"description":"Properties that need to be specified to patch a workbook template."},"responses":{"200":{"description":"The workbook template definition updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookTemplate"},"examples":{"WorkbookTemplateUpdate":{"$ref":"#/components/examples/WorkbookTemplateUpdate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookError"}}}}}},"put":{"description":"Create a new workbook template.","operationId":"WorkbookTemplates_CreateOrUpdate","parameters":[{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateAdd":{"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":{"WorkbookTemplateAdd":{"value":"my-resource-group"}}},{"$ref":"#/components/parameters/WorkbookTemplateResourceNameParameter"},{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string","minLength":1},"examples":{"WorkbookTemplateAdd":{"value":"2019-10-17-preview"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookTemplate"}}},"description":"Properties that need to be specified to create a new workbook.","required":true},"responses":{"200":{"description":"The newly created workbook template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookTemplate"},"examples":{"WorkbookTemplateAdd":{"$ref":"#/components/examples/WorkbookTemplateAdd"}}}}},"201":{"description":"The newly created workbook template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkbookTemplate"},"examples":{"WorkbookTemplateAdd":{"$ref":"#/components/examples/WorkbookTemplateAdd"}}}}},"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":{"WorkbookTemplatesList":{"value":[{"id":"/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/microsoft.insights/workbooktemplates/my-resource-name","location":"westus","name":"my-resource-name","properties":{"author":"Contoso","galleries":[{"category":"Failures","name":"Simple Template","order":100,"resourceType":"microsoft.insights/components","type":"tsg"}],"priority":1,"templateData":{}},"type":"microsoft.insights/workbooktemplate"},{"id":"/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/microsoft.insights/workbooktemplates/my-resource-name2","location":"westus","name":"my-resource-name2","properties":{"author":"Contoso","galleries":[{"category":"Failures","name":"Simple Template 2","order":100,"resourceType":"microsoft.insights/components","type":"tsg"}],"priority":1,"templateData":{}},"type":"microsoft.insights/workbooktemplate"}]},"WorkbookTemplateGet":{"value":{"id":"/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourceGroups/my-resource-group/providers/microsoft.insights/workbooktemplates/my-resource-name","location":"westus","name":"my-resource-name","properties":{"author":"Contoso","galleries":[{"category":"Failures","name":"Simple Template","order":100,"resourceType":"microsoft.insights/components","type":"tsg"}],"priority":1,"templateData":{}},"type":"microsoft.insights/workbooktemplate"}},"WorkbookTemplateUpdate":{"value":{"id":"/subscriptions/50359d91-7b9d-4823-85af-eb298a61ba95/resourceGroups/testrg/providers/microsoft.insights/workbooktemplates/testtemplate2","location":"westeurope","name":"testtemplate2","properties":{"author":"Contoso","galleries":[{"category":"Failures","name":"Simple Template","order":100,"resourceType":"microsoft.insights/components","type":"tsg"}],"priority":1,"templateData":{}},"type":"microsoft.insights/workbooktemplates"}},"WorkbookTemplateAdd":{"value":{"id":"/subscriptions/50359d91-7b9d-4823-85af-eb298a61ba95/resourceGroups/testrg/providers/microsoft.insights/workbooktemplates/testtemplate2","location":"westeurope","name":"testtemplate2","properties":{"author":"Contoso","galleries":[{"category":"Failures","name":"Simple Template","order":100,"resourceType":"microsoft.insights/components","type":"tsg"}],"priority":1,"templateData":{}},"type":"microsoft.insights/workbooktemplates"}}},"parameters":{"WorkbookTemplateResourceNameParameter":{"description":"The name of the Application Insights component resource.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"WorkbookTemplateDelete":{"value":"my-template-resource"},"WorkbookTemplateGet":{"value":"my-resource-name"},"WorkbookTemplateUpdate":{"value":"my-template-resource"},"WorkbookTemplateAdd":{"value":"testtemplate2"}}}},"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"}}},"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"}}},"WorkbookTemplate":{"allOf":[{"$ref":"#/components/schemas/WorkbookTemplateResource"}],"description":"An Application Insights workbook template definition.","properties":{"properties":{"$ref":"#/components/schemas/WorkbookTemplateProperties"}}},"WorkbookTemplateGallery":{"description":"Gallery information for a workbook template.","properties":{"category":{"description":"Category for the gallery.","type":"string"},"name":{"description":"Name of the workbook template in the gallery.","type":"string"},"order":{"description":"Order of the template within the gallery.","type":"integer"},"resourceType":{"description":"Azure resource type supported by the gallery.","type":"string"},"type":{"description":"Type of workbook supported by the workbook template.","type":"string"}}},"WorkbookTemplateLocalizedGallery":{"description":"Localized template data and gallery information.","properties":{"galleries":{"description":"Workbook galleries supported by the template.","items":{"$ref":"#/components/schemas/WorkbookTemplateGallery"},"type":"array"},"templateData":{"description":"Valid JSON object containing workbook template payload.","type":"object"}}},"WorkbookTemplateProperties":{"description":"Properties that contain a workbook template.","properties":{"author":{"description":"Information about the author of the workbook template.","type":"string"},"galleries":{"description":"Workbook galleries supported by the template.","items":{"$ref":"#/components/schemas/WorkbookTemplateGallery"},"type":"array"},"localized":{"additionalProperties":{"items":{"$ref":"#/components/schemas/WorkbookTemplateLocalizedGallery"},"type":"array"},"description":"Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.","type":"object"},"priority":{"description":"Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.","type":"integer"},"templateData":{"description":"Valid JSON object containing workbook template payload.","type":"object"}},"required":["templateData","galleries"]},"WorkbookTemplateResource":{"description":"An azure resource object","properties":{"id":{"description":"Azure resource Id","readOnly":true,"type":"string"},"location":{"description":"Resource location","type":"string","x-ms-mutability":["create","read"]},"name":{"description":"Azure resource name.","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},"WorkbookTemplateUpdateParameters":{"description":"The parameters that can be provided when updating workbook template.","properties":{"properties":{"$ref":"#/components/schemas/WorkbookTemplateProperties"},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags","type":"object"}}},"WorkbookTemplatesListResult":{"description":"WorkbookTemplate list result.","properties":{"value":{"description":"An array of workbook templates.","items":{"$ref":"#/components/schemas/WorkbookTemplate"},"type":"array"}}}}}}