openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 40.8 kB
JSON
{"openapi":"3.0.0","info":{"description":"REST APIs for Azure Alerts Management Service.","title":"Azure Alerts Management Service Resource Provider","version":"2018-05-05-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/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"alertsmanagement-AlertsManagement","x-tags":["Azure","Microsoft"]},"paths":{"/providers/Microsoft.AlertsManagement/operations":{"get":{"description":"List all operations available through Azure Alerts Management Resource Provider.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Successfully retrieved operations list.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/operationsList"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts":{"get":{"description":"List all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields. ","operationId":"Alerts_GetAll","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/targetResource"},{"$ref":"#/components/parameters/targetResourceGroup"},{"$ref":"#/components/parameters/targetResourceType"},{"$ref":"#/components/parameters/monitorService"},{"$ref":"#/components/parameters/monitorCondition"},{"$ref":"#/components/parameters/severity"},{"$ref":"#/components/parameters/alertState"},{"$ref":"#/components/parameters/smartGroupIdFilter"},{"$ref":"#/components/parameters/includePayload"},{"$ref":"#/components/parameters/pageCount"},{"$ref":"#/components/parameters/alertsSortBy"},{"$ref":"#/components/parameters/sortOrder"},{"$ref":"#/components/parameters/timeRange"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Successfully listed alert objects.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertsList"},"examples":{"ListAlerts":{"$ref":"#/components/examples/ListAlerts"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}":{"get":{"description":"Get information related to a specific alert","operationId":"Alerts_GetById","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/alertId"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Returns the alert with the specified ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert"},"examples":{"GetById":{"$ref":"#/components/examples/GetById"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"summary":"Get a specific alert."}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate":{"post":{"description":"Change the state of the alert.","operationId":"Alerts_ChangeState","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/alertId"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/newState"}],"responses":{"200":{"description":"OK. Alert state updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alert"},"examples":{"Resolve":{"$ref":"#/components/examples/Resolve"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history":{"get":{"description":"Get the history of the changes of an alert.","operationId":"Alerts_GetHistory","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/alertId"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Returns the list of changes of alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertModification"},"examples":{"Resolve":{"$ref":"#/components/examples/Resolve"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary":{"get":{"description":"Summary of alerts with the count each severity.","operationId":"Alerts_GetSummary","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/targetResourceGroup"},{"$ref":"#/components/parameters/timeRange"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Alert state updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/alertsSummary"},"examples":{"Summary":{"$ref":"#/components/examples/Summary"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups":{"get":{"description":"List all the smartGroups within the specified subscription. ","operationId":"SmartGroups_GetAll","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/targetResource"},{"$ref":"#/components/parameters/targetResourceGroup"},{"$ref":"#/components/parameters/targetResourceType"},{"$ref":"#/components/parameters/monitorService"},{"$ref":"#/components/parameters/monitorCondition"},{"$ref":"#/components/parameters/severity"},{"$ref":"#/components/parameters/smartGroupState"},{"$ref":"#/components/parameters/timeRange"},{"$ref":"#/components/parameters/pageCount"},{"$ref":"#/components/parameters/smartGroupsSortBy"},{"$ref":"#/components/parameters/sortOrder"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Returns list of all smartGroups.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartGroupsList"},"examples":{"List":{"$ref":"#/components/examples/List"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"summary":"Get all smartGroups within the subscription"}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}":{"get":{"description":"Get details of smart group.","operationId":"SmartGroups_GetById","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/smartGroupId"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Returns the group with the specified smart group Id.","headers":{"x-ms-request-id":{"description":"Service generated Request ID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartGroup"},"examples":{"Get":{"$ref":"#/components/examples/Get"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}},"summary":"Get information of smart alerts group."}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState":{"post":{"description":"Change the state from unresolved to resolved and all the alerts within the smart group will also be resolved.","operationId":"SmartGroups_ChangeState","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/smartGroupId"},{"$ref":"#/components/parameters/api-version"},{"$ref":"#/components/parameters/newState"}],"responses":{"200":{"description":"OK. Alert state updated.","headers":{"x-ms-request-id":{"description":"Service generated Request ID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartGroup"},"examples":{"changestate":{"$ref":"#/components/examples/changestate"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}},"/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history":{"get":{"description":"Get the history of the changes of smart group.","operationId":"SmartGroups_GetHistory","parameters":[{"$ref":"#/components/parameters/subscriptionId"},{"$ref":"#/components/parameters/smartGroupId"},{"$ref":"#/components/parameters/api-version"}],"responses":{"200":{"description":"OK. Returns the list of changes of smart group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/smartGroupModification"},"examples":{"Resolve":{"$ref":"#/components/examples/Resolve"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorResponse"}}}}}}}},"servers":[{"url":"https://azure.local"}],"components":{"examples":{"ListAlerts":{"value":{"nextLink":"https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1","value":[{"id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100","name":"cpu alert","properties":{"alertState":"New","lastModifiedDateTime":"2018-06-12T22:05:09Z","lastModifiedUserName":"System","monitorCondition":"Fired","monitorService":"Application Insights","payload":{},"severity":"Sev3","signalType":"Log","smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059","smartGroupingReason":"Alerts that frequently occur together have been grouped.","sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34","startDateTime":"2018-06-12T22:05:09Z","targetResource":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int","targetResourceGroup":"alertscorrelationrg","targetResourceName":"alertscorrelationworkerrole_int","targetResourceType":"components"},"type":"Microsoft.AlertsManagement/alerts"},{"id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts/239f0e9f-9871-4c8b-a6a2-b893853d1066","name":"cpu alert","properties":{"alertState":"New","lastModifiedDateTime":"2018-06-12T21:40:09Z","lastModifiedUserName":"System","monitorCondition":"Fired","monitorService":"Application Insights","payload":{},"severity":"Sev3","signalType":"Log","smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059","smartGroupingReason":"Alerts that frequently occur together have been grouped.","sourceCreatedId":"e1c5c974-b796-46a1-bb59-740eeca48c15","startDateTime":"2018-06-12T21:40:09Z","targetResource":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int","targetResourceGroup":"alertscorrelationrg","targetResourceName":"alertscorrelationworkerrole_int","targetResourceType":"components"},"type":"Microsoft.AlertsManagement/alerts"}]}},"GetById":{"value":{"id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100","name":"cpu alert","properties":{"alertState":"New","lastModifiedDateTime":"2018-06-12T22:05:09Z","lastModifiedUserName":"System","monitorCondition":"Fired","monitorService":"Application Insights","payload":{},"severity":"Sev3","signalType":"Log","smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059","smartGroupingReason":"Alerts that frequently occur together have been grouped.","sourceCreatedId":"57c049b5-9654-4bb4-a443-3bac3f725d34","startDateTime":"2018-06-12T22:05:09Z","targetResource":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int","targetResourceGroup":"alertscorrelationrg","targetResourceName":"alertscorrelationworkerrole_int","targetResourceType":"components"},"type":"Microsoft.AlertsManagement/alerts"}},"Resolve":{"value":{"id":"/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059/history/default","name":"cpu alert","properties":{"modifications":[{"comments":"","description":"New Smart Group is created","modificationEvent":"SmartGroupCreated","modifiedAt":"2018-06-06T12:35:09Z","modifiedBy":"System","newValue":"","oldValue":""}],"smartGroupId":"a808445e-bb38-4751-85c2-1b109ccc1059"},"type":"Microsoft.AlertsManagement/alerts"}},"Summary":{"value":{"id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current","name":"current","properties":{"smartGroupsCount":2,"summaryByMonitorService":{"activityLog Administrative":0,"activityLog Autoscale":0,"activityLog Policy":0,"activityLog Recommendation":0,"activityLog Security":0,"application Insights":290,"infrastructure Insights":0,"log Analytics":595,"nagios":0,"platform":0,"scom":0,"serviceHealth":0,"smartDetector":0,"zabbix":0},"summaryBySeverity":{"sev0":{"acknowledged":0,"closed":0,"new":286},"sev1":{"acknowledged":0,"closed":0,"new":309},"sev2":{"acknowledged":0,"closed":0,"new":0},"sev3":{"acknowledged":1,"closed":0,"new":289},"sev4":{"acknowledged":0,"closed":0,"new":0}},"summaryBySeverityAndMonitorCondition":{"sev0":{"fired":286,"resolved":0},"sev1":{"fired":309,"resolved":0},"sev2":{"fired":0,"resolved":0},"sev3":{"fired":290,"resolved":0},"sev4":{"fired":0,"resolved":0}},"summaryByState":{"acknowledged":1,"closed":0,"new":884},"total":885},"type":"Microsoft.AlertsManagement/alertsSummary"}},"List":{"value":{"nextLink":"","value":[{"id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059","name":"cpu alert","properties":{"alertSeverities":[{"count":1942,"name":"Sev3"}],"alertStates":[{"count":1941,"name":"New"},{"count":1,"name":"Acknowledged"}],"alertsCount":1942,"lastModifiedDateTime":"2018-06-13T06:30:09Z","lastModifiedUserName":"System","monitorConditions":[{"count":1942,"name":"Fired"}],"monitorServices":[{"count":1942,"name":"Application Insights"}],"resourceGroups":[{"count":1942,"name":"alertscorrelationrg"}],"resourceTypes":[{"count":1942,"name":"components"}],"resources":[{"count":1942,"name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int"}],"severity":"Sev3","smartGroupState":"New","startDateTime":"2018-06-06T12:35:09Z"},"type":"Microsoft.AlertsManagement/smartGroups"},{"id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/01114c7c-769f-4fd4-b6fa-ab77693b83cd","name":"CPU Alert","properties":{"alertSeverities":[{"count":6984,"name":"Sev0"},{"count":6927,"name":"Sev1"}],"alertStates":[{"count":15358,"name":"New"},{"count":12,"name":"Acknowledged"},{"count":4,"name":"Closed"}],"alertsCount":15374,"lastModifiedDateTime":"2018-06-13T06:29:01Z","lastModifiedUserName":"System","monitorConditions":[{"count":15374,"name":"Fired"}],"monitorServices":[{"count":13911,"name":"Log Analytics"}],"resourceGroups":[{"count":15374,"name":"mms-eus"}],"resourceTypes":[{"count":6912,"name":"microsoft.operationalinsights/workspaces"},{"count":8462,"name":"workspaces"}],"resources":[{"count":15374,"name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/alertsint"}],"severity":"Sev0","smartGroupState":"Acknowledged","startDateTime":"2018-05-17T10:18:44.2020997Z"},"type":"Microsoft.AlertsManagement/smartGroups"}]}},"Get":{"value":{"id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059","name":"cpu alert","properties":{"alertSeverities":[{"count":1942,"name":"Sev3"}],"alertStates":[{"count":1941,"name":"New"},{"count":1,"name":"Acknowledged"}],"alertsCount":1942,"lastModifiedDateTime":"2018-06-13T06:30:09Z","lastModifiedUserName":"System","monitorConditions":[{"count":1942,"name":"Fired"}],"monitorServices":[{"count":1942,"name":"Application Insights"}],"resourceGroups":[{"count":1942,"name":"alertscorrelationrg"}],"resourceTypes":[{"count":1942,"name":"components"}],"resources":[{"count":1942,"name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int"}],"severity":"Sev3","smartGroupState":"New","startDateTime":"2018-06-06T12:35:09Z"},"type":"Microsoft.AlertsManagement/smartGroups"}},"changestate":{"value":{"id":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059","name":"cpu alert","properties":{"alertSeverities":[{"count":1942,"name":"Sev3"}],"alertStates":[{"count":1941,"name":"New"},{"count":1,"name":"Acknowledged"}],"alertsCount":1942,"lastModifiedDateTime":"2018-06-13T06:30:09Z","lastModifiedUserName":"System","monitorConditions":[{"count":1942,"name":"Fired"}],"monitorServices":[{"count":1942,"name":"Application Insights"}],"resourceGroups":[{"count":1942,"name":"alertscorrelationrg"}],"resourceTypes":[{"count":1942,"name":"components"}],"resources":[{"count":1942,"name":"/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int"}],"severity":"Sev3","smartGroupState":"Acknowledged","startDateTime":"2018-06-06T12:35:09Z"},"type":"Microsoft.AlertsManagement/smartGroups"}}},"parameters":{"alertId":{"description":"Unique ID of an alert object.","in":"path","name":"alertId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"GetById":{"value":"66114d64-d9d9-478b-95c9-b789d6502100"},"Resolve":{"value":"66114d64-d9d9-478b-95c9-b789d6502100"}}},"alertState":{"description":"filter by state","in":"query","name":"alertState","required":false,"x-ms-enum":{"modelAsString":true,"name":"AlertState"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["New","Acknowledged","Closed"]}},"alertsSortBy":{"description":"sort the query results by input field, default value is 'lastModifiedDateTime'.","in":"query","name":"sortBy","required":false,"x-ms-enum":{"modelAsString":true,"name":"AlertsSortByFields"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["name","severity","alertState","monitorCondition","targetResource","targetResourceName","targetResourceGroup","targetResourceType","startDateTime","lastModifiedDateTime"]}},"api-version":{"description":"client API version","in":"query","name":"api-version","required":true,"x-ms-enum":{"modelAsString":true,"name":"api-version"},"schema":{"type":"string","enum":["2017-11-15-privatepreview","2018-05-05-preview"]},"examples":{"ListAlerts":{"value":"2018-05-05-preview"},"GetById":{"value":"2018-05-05-preview"},"Resolve":{"value":"2018-05-05-preview"},"Summary":{"value":"2018-05-05-preview"},"List":{"value":"2018-05-05-preview"},"Get":{"value":"2018-05-05-preview"},"changestate":{"value":"2018-05-05-preview"}}},"includePayload":{"description":"include payload field content, default value is 'false'.","in":"query","name":"includePayload","required":false,"x-ms-parameter-location":"method","schema":{"type":"boolean"}},"monitorCondition":{"description":"filter by monitor condition which is the state of the alert at monitor service","in":"query","name":"monitorCondition","required":false,"x-ms-enum":{"modelAsString":true,"name":"MonitorCondition"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["Fired","Resolved"]}},"monitorService":{"description":"filter by monitor service which is the source of the alert object.","in":"query","name":"monitorService","required":false,"x-ms-enum":{"modelAsString":true,"name":"MonitorService"},"schema":{"type":"string","enum":["Platform","Application Insights","Log Analytics","Zabbix","SCOM","Nagios","Infrastructure Insights","ActivityLog Administrative","ActivityLog Security","ActivityLog Recommendation","ActivityLog Policy","ActivityLog Autoscale","ServiceHealth","SmartDetector"]}},"newState":{"description":"filter by state","in":"query","name":"newState","required":true,"x-ms-enum":{"modelAsString":true,"name":"AlertState"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["New","Acknowledged","Closed"]},"examples":{"Resolve":{"value":"Acknowledged"},"changestate":{"value":"Acknowledged"}}},"pageCount":{"description":"number of items per page, default value is '25'.","in":"query","name":"pageCount","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer"}},"severity":{"description":"filter by severity","in":"query","name":"severity","required":false,"x-ms-enum":{"modelAsString":true,"name":"Severity"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["Sev0","Sev1","Sev2","Sev3","Sev4"]}},"smartGroupId":{"description":"Smart Group Id","in":"path","name":"smartGroupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get":{"value":"603675da-9851-4b26-854a-49fc53d32715"},"changestate":{"value":"a808445e-bb38-4751-85c2-1b109ccc1059"},"Resolve":{"value":"a808445e-bb38-4751-85c2-1b109ccc1059"}}},"smartGroupIdFilter":{"description":"filter by smart Group Id","in":"query","name":"smartGroupId","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},"smartGroupState":{"description":"filter by state","in":"query","name":"smartGroupState","required":false,"x-ms-enum":{"modelAsString":true,"name":"AlertState"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["New","Acknowledged","Closed"]}},"smartGroupsSortBy":{"description":"sort the query results by input field, default value is 'lastModifiedDateTime'.","in":"query","name":"sortBy","required":false,"x-ms-enum":{"modelAsString":true,"name":"SmartGroupsSortByFields"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["alertsCount","state","severity","startDateTime","lastModifiedDateTime"]}},"sortOrder":{"description":"sort the query results order in either ascending or descending, default value is 'desc' for time fields and 'asc' for others.","in":"query","name":"sortOrder","required":false,"x-ms-parameter-location":"method","schema":{"type":"string","enum":["asc","desc"]}},"subscriptionId":{"description":"subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ListAlerts":{"value":"1e3ff1c0-771a-4119-a03b-be82a51e232d"},"GetById":{"value":"9e261de7-c804-4b9d-9ebf-6f50fe350a9a"},"Resolve":{"value":"9e261de7-c804-4b9d-9ebf-6f50fe350a9a"},"Summary":{"value":"1e3ff1c0-771a-4119-a03b-be82a51e232d"},"List":{"value":"dd91de05-d791-4ceb-b6dc-988682dc7d72"},"Get":{"value":"9e261de7-c804-4b9d-9ebf-6f50fe350a9a"},"changestate":{"value":"dd91de05-d791-4ceb-b6dc-988682dc7d72"}}},"targetResource":{"description":"filter by target resource","in":"query","name":"targetResource","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},"targetResourceGroup":{"description":"filter by target resource group name","in":"query","name":"targetResourceGroup","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},"targetResourceType":{"description":"filter by target resource type","in":"query","name":"targetResourceType","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},"timeRange":{"description":"filter by time range, default value is 1 day","in":"query","name":"timeRange","required":false,"x-ms-enum":{"modelAsString":true,"name":"TimeRange"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["1h","1d","7d","30d"]}}},"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":{"Resource":{"description":"An azure resource object","properties":{"id":{"description":"Azure resource Id","readOnly":true,"type":"string"},"name":{"description":"Azure resource name","readOnly":true,"type":"string"},"type":{"description":"Azure resource type","readOnly":true,"type":"string"}},"x-ms-azure-resource":true},"alert":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"An alert created in alert management service.","properties":{"properties":{"$ref":"#/components/schemas/alertProperties"}}},"alertModification":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Alert Modification details","properties":{"properties":{"$ref":"#/components/schemas/alertModificationProperties"}}},"alertModificationItem":{"description":"Alert modification item.","properties":{"comments":{"description":"Modification comments","type":"string"},"description":{"description":"Description of the modification","type":"string"},"modificationEvent":{"description":"Reason for the modification","enum":["AlertCreated","StateChange","MonitorConditionChange"],"type":"string","x-ms-enum":{"name":"AlertModificationEvent"}},"modifiedAt":{"description":"Modified date and time","type":"string"},"modifiedBy":{"description":"Modified user details (Principal client name)","type":"string"},"newValue":{"description":"New value","type":"string"},"oldValue":{"description":"Old value","type":"string"}}},"alertModificationProperties":{"description":"Properties of the alert modification item.","properties":{"alertId":{"description":"Unique Id of the alert for which the history is being retrieved","readOnly":true,"type":"string"},"modifications":{"description":"Modification details","items":{"$ref":"#/components/schemas/alertModificationItem"},"type":"array"}},"type":"object"},"alertProperties":{"description":"An alert created in alert management service.","properties":{"alertState":{"description":"Alert object state","enum":["New","Acknowledged","Closed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"AlertState"}},"lastModifiedDateTime":{"description":"Last modification time(ISO-8601 format).","format":"date-time","readOnly":true,"type":"string"},"lastModifiedUserName":{"description":"User who last modified the alert.","readOnly":true,"type":"string"},"monitorCondition":{"description":"Condition of the rule at the monitor service","enum":["Fired","Resolved"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"MonitorCondition"}},"monitorService":{"description":"Monitor service which is the source of the alert object.","enum":["Platform","Application Insights","Log Analytics","Infrastructure Insights","ActivityLog Administrative","ActivityLog Security","ActivityLog Recommendation","ActivityLog Policy","ActivityLog Autoscale","ServiceHealth","SmartDetector","Zabbix","SCOM","Nagios"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"MonitorService"}},"payload":{"description":"More details which are contextual to the monitor service.","readOnly":true,"type":"object"},"severity":{"description":"Severity of alert Sev1 being highest and Sev3 being lowest.","enum":["Sev0","Sev1","Sev2","Sev3","Sev4"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"Severity"}},"signalType":{"description":"Log based alert or metric based alert","enum":["Metric","Log","Unknown"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"SignalType"}},"smartGroupId":{"description":"Unique Id of the smart group","readOnly":true,"type":"string"},"smartGroupingReason":{"description":"Reason for addition to a smart group","readOnly":true,"type":"string"},"sourceCreatedId":{"description":"Unique Id created by monitor service","readOnly":true,"type":"string"},"startDateTime":{"description":"Creation time(ISO-8601 format).","format":"date-time","readOnly":true,"type":"string"},"targetResource":{"description":"Target ARM resource, on which alert got created.","type":"string"},"targetResourceGroup":{"description":"Resource group of target ARM resource.","type":"string"},"targetResourceName":{"description":"Target ARM resource name, on which alert got created.","type":"string"},"targetResourceType":{"description":"Resource type of target ARM resource","type":"string"}},"type":"object"},"alertsList":{"description":"List the alerts.","properties":{"nextLink":{"description":"URL to fetch the next set of alerts.","type":"string"},"value":{"description":"List of alerts","items":{"$ref":"#/components/schemas/alert"},"type":"array"}}},"alertsSummary":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Summary of the alerts.","properties":{"properties":{"$ref":"#/components/schemas/alertsSummaryProperties"}}},"alertsSummaryByMonitorCondition":{"description":"Summary of the alerts by monitor condition","properties":{"fired":{"description":"Count of alerts with monitorCondition 'Fired'","type":"integer"},"resolved":{"description":"Count of alerts with monitorCondition 'Resolved'","type":"integer"}},"type":"object"},"alertsSummaryByMonitorService":{"description":"Summary of the alerts by monitor service","properties":{"activityLog Administrative":{"description":"Count of alerts of \"ActivityLog Administrative\"","type":"integer"},"activityLog Autoscale":{"description":"Count of alerts of \"ActivityLog Autoscale\"","type":"integer"},"activityLog Policy":{"description":"Count of alerts of \"ActivityLog Policy\"","type":"integer"},"activityLog Recommendation":{"description":"Count of alerts of \"ActivityLog Recommendation\"","type":"integer"},"activityLog Security":{"description":"Count of alerts of \"ActivityLog Security\"","type":"integer"},"application Insights":{"description":"Count of alerts of \"Application Insights\"","type":"integer"},"infrastructure Insights":{"description":"Count of alerts of \"Infrastructure Insights\"","type":"integer"},"log Analytics":{"description":"Count of alerts of \"Log Analytics\"","type":"integer"},"nagios":{"description":"Count of alerts of \"Nagios\"","type":"integer"},"platform":{"description":"Count of alerts of \"Platform\"","type":"integer"},"scom":{"description":"Count of alerts of \"SCOM\"","type":"integer"},"serviceHealth":{"description":"Count of alerts of \"ServiceHealth\"","type":"integer"},"smartDetector":{"description":"Count of alerts of \"Smart Detector\"","type":"integer"},"zabbix":{"description":"Count of alerts of \"Zabbix\"","type":"integer"}},"type":"object"},"alertsSummaryBySeverityAndMonitorCondition":{"description":"Summary of the alerts by severity and monitor condition","properties":{"sev0":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByMonitorCondition"}],"description":"Summary of alerts by monitor condition with severity 'Sev0'"},"sev1":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByMonitorCondition"}],"description":"Summary of alerts by monitor condition with severity 'Sev1'"},"sev2":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByMonitorCondition"}],"description":"Summary of alerts by monitor condition with severity 'Sev2'"},"sev3":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByMonitorCondition"}],"description":"Summary of alerts by monitor condition with severity 'Sev3'"},"sev4":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByMonitorCondition"}],"description":"Summary of alerts by monitor condition with severity 'Sev4'"}},"type":"object"},"alertsSummaryByState":{"description":"Summary of alerts by state","properties":{"acknowledged":{"description":"Count of alerts with state 'Acknowledged'","type":"integer"},"closed":{"description":"Count of alerts with state 'Closed'","type":"integer"},"new":{"description":"Count of alerts with state 'New'","type":"integer"}},"type":"object"},"alertsSummaryProperties":{"description":"Summary of the alerts","properties":{"nextLink":{"description":"URL to fetch the next set of results.","type":"string"},"smartGroupsCount":{"description":"Total number of smart groups.","type":"integer"},"summaryByMonitorService":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByMonitorService"}],"description":"Summary of alerts by severity","type":"object"},"summaryBySeverity":{"description":"Summary of alerts by severity","properties":{"sev0":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByState"}],"description":"Summary of alerts by severity 'Sev0'","type":"object"},"sev1":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByState"}],"description":"Summary of alerts by severity 'Sev1'","type":"object"},"sev2":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByState"}],"description":"Summary of alerts by severity 'Sev2'","type":"object"},"sev3":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByState"}],"description":"Summary of alerts by severity 'Sev3'","type":"object"},"sev4":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByState"}],"description":"Summary of alerts by severity 'Sev4'","type":"object"}},"type":"object"},"summaryBySeverityAndMonitorCondition":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryBySeverityAndMonitorCondition"}],"description":"Summary of alerts by severity and monitor condition","type":"object"},"summaryByState":{"allOf":[{"$ref":"#/components/schemas/alertsSummaryByState"}],"description":"Summary of alerts by state","type":"object"},"total":{"description":"Total number of alerts.","type":"integer"}},"type":"object"},"errorResponse":{"description":"An error response from the service.","properties":{"error":{"$ref":"#/components/schemas/errorResponseBody"}},"x-ms-external":true},"errorResponseBody":{"description":"Details of error response.","properties":{"code":{"description":"Error code, intended to be consumed programmatically.","type":"string"},"details":{"description":"A list of additional details about the error.","items":{"$ref":"#/components/schemas/errorResponseBody"},"type":"array"},"message":{"description":"Description of the error, intended for display in user interface.","type":"string"},"target":{"description":"Target of the particular error, for example name of the property.","type":"string"}},"x-ms-external":true},"operation":{"description":"Operation provided by provider","properties":{"display":{"description":"Properties of the operation","properties":{"description":{"description":"Description of the operation","type":"string"},"operation":{"description":"Operation name","type":"string"},"provider":{"description":"Provider name","type":"string"},"resource":{"description":"Resource name","type":"string"}},"type":"object"},"name":{"description":"Name of the operation","type":"string"}}},"operationsList":{"description":"Lists the operations available in the AlertsManagement RP.","properties":{"nextLink":{"description":"URL to fetch the next set of alerts.","type":"string"},"value":{"description":"Array of operations","items":{"$ref":"#/components/schemas/operation"},"type":"array"}},"required":["value"]},"smartGroup":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Set of related alerts grouped together smartly by AMS.","properties":{"properties":{"$ref":"#/components/schemas/smartGroupProperties"}}},"smartGroupAggregatedProperty":{"description":"Aggregated property of each type","properties":{"count":{"description":"Total number of items of type.","type":"integer"},"name":{"description":"Name of the type.","type":"string"}},"type":"object"},"smartGroupModification":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"Alert Modification details","properties":{"properties":{"$ref":"#/components/schemas/smartGroupModificationProperties"}}},"smartGroupModificationItem":{"description":"smartGroup modification item.","properties":{"comments":{"description":"Modification comments","type":"string"},"description":{"description":"Description of the modification","type":"string"},"modificationEvent":{"description":"Reason for the modification","enum":["SmartGroupCreated","StateChange","AlertAdded","AlertRemoved"],"type":"string","x-ms-enum":{"name":"SmartGroupModificationEvent"}},"modifiedAt":{"description":"Modified date and time","type":"string"},"modifiedBy":{"description":"Modified user details (Principal client name)","type":"string"},"newValue":{"description":"New value","type":"string"},"oldValue":{"description":"Old value","type":"string"}}},"smartGroupModificationProperties":{"description":"Properties of the smartGroup modification item.","properties":{"modifications":{"description":"Modification details","items":{"$ref":"#/components/schemas/smartGroupModificationItem"},"type":"array"},"nextLink":{"description":"URL to fetch the next set of results.","type":"string"},"smartGroupId":{"description":"Unique Id of the smartGroup for which the history is being retrieved","readOnly":true,"type":"string"}}},"smartGroupProperties":{"description":"Properties of smart group.","properties":{"alertSeverities":{"description":"Summary of alertSeverities in the smart group","items":{"$ref":"#/components/schemas/smartGroupAggregatedProperty"},"type":"array"},"alertStates":{"description":"Summary of alertStates in the smart group","items":{"$ref":"#/components/schemas/smartGroupAggregatedProperty"},"type":"array"},"alertsCount":{"description":"Total number of alerts in smart group","type":"integer"},"lastModifiedDateTime":{"description":"Last updated time of smart group. Date-Time in ISO-8601 format.","format":"date-time","readOnly":true,"type":"string"},"lastModifiedUserName":{"description":"Last modified by user name.","readOnly":true,"type":"string"},"monitorConditions":{"description":"Summary of monitorConditions in the smart group","items":{"$ref":"#/components/schemas/smartGroupAggregatedProperty"},"type":"array"},"monitorServices":{"description":"Summary of monitorServices in the smart group","items":{"$ref":"#/components/schemas/smartGroupAggregatedProperty"},"type":"array"},"nextLink":{"description":"The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts.","type":"string"},"resourceGroups":{"description":"Summary of target resource groups in the smart group","items":{"$ref":"#/components/schemas/smartGroupAggregatedProperty"},"type":"array"},"resourceTypes":{"description":"Summary of target resource types in the smart group","items":{"$ref":"#/components/schemas/smartGroupAggregatedProperty"},"type":"array"},"resources":{"description":"Summary of target resources in the smart group","items":{"$ref":"#/components/schemas/smartGroupAggregatedProperty"},"type":"array"},"severity":{"description":"Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group.","enum":["Sev0","Sev1","Sev2","Sev3","Sev4"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"Severity"}},"smartGroupState":{"description":"Smart group state","enum":["New","Acknowledged","Closed"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"State"}},"startDateTime":{"description":"Creation time of smart group. Date-Time in ISO-8601 format.","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"smartGroupsList":{"description":"List the alerts.","properties":{"nextLink":{"description":"URL to fetch the next set of alerts.","type":"string"},"value":{"description":"List of alerts","items":{"$ref":"#/components/schemas/smartGroup"},"type":"array"}}}}}}