diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json index 8ae19f29a9e5..a2fc3f89d47e 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json @@ -45,6 +45,12 @@ "schema": { "$ref": "#/definitions/operationsList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } } }, "x-ms-pageable": { @@ -73,6 +79,12 @@ "schema": { "$ref": "#/definitions/alertsMetaData" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } } }, "x-ms-examples": { @@ -579,6 +591,7 @@ "description": "Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the \"includeContent\" filter is selected, maximum value allowed is 25. Default value is 25.", "name": "pageCount", "type": "integer", + "format": "int64", "in": "query", "required": false, "x-ms-parameter-location": "method" @@ -768,6 +781,7 @@ } }, "alert": { + "type": "object", "description": "An alert created in alert management service.", "allOf": [ { @@ -781,6 +795,7 @@ } }, "alertsList": { + "type": "object", "description": "List the alerts.", "properties": { "nextLink": { @@ -969,6 +984,7 @@ } }, "alertModification": { + "type": "object", "description": "Alert Modification details", "allOf": [ { @@ -1000,6 +1016,7 @@ } }, "alertModificationItem": { + "type": "object", "description": "Alert modification item.", "properties": { "modificationEvent": { @@ -1047,6 +1064,7 @@ } }, "alertsSummary": { + "type": "object", "description": "Summary of alerts based on the input filters and 'groupby' parameters.", "allOf": [ { @@ -1065,10 +1083,12 @@ "properties": { "total": { "type": "integer", + "format": "int64", "description": "Total count of the result set." }, "smartGroupsCount": { "type": "integer", + "format": "int64", "description": "Total count of the smart groups." }, "groupedby": { @@ -1094,6 +1114,7 @@ }, "count": { "type": "integer", + "format": "int64", "description": "Count of the aggregated field" }, "groupedby": { @@ -1110,6 +1131,7 @@ } }, "alertsMetaData": { + "type": "object", "description": "alert meta data information.", "properties": { "properties": { @@ -1118,6 +1140,7 @@ } }, "alertsMetaDataProperties": { + "type": "object", "description": "alert meta data property bag", "discriminator": "metadataIdentifier", "required": [ @@ -1138,6 +1161,7 @@ } }, "MonitorServiceList": { + "type": "object", "title": "Monitor service details", "description": "Monitor service details", "required": [ @@ -1162,6 +1186,7 @@ } }, "MonitorServiceDetails": { + "type": "object", "description": "Details of a monitor service", "properties": { "name": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json index c30ce89e0d8a..e723ddff0685 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json @@ -403,6 +403,7 @@ "description": "Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the \"includeContent\" filter is selected, maximum value allowed is 25. Default value is 25.", "name": "pageCount", "type": "integer", + "format": "int64", "in": "query", "required": false, "x-ms-parameter-location": "method" @@ -494,6 +495,7 @@ } }, "smartGroupModification": { + "type": "object", "description": "Alert Modification details", "allOf": [ { @@ -507,6 +509,7 @@ } }, "smartGroupModificationProperties": { + "type": "object", "description": "Properties of the smartGroup modification item.", "properties": { "smartGroupId": { @@ -528,6 +531,7 @@ } }, "smartGroupModificationItem": { + "type": "object", "description": "smartGroup modification item.", "properties": { "modificationEvent": { @@ -570,6 +574,7 @@ } }, "smartGroupsList": { + "type": "object", "description": "List the alerts.", "properties": { "nextLink": { @@ -586,6 +591,7 @@ } }, "smartGroup": { + "type": "object", "description": "Set of related alerts grouped together smartly by AMS.", "allOf": [ { @@ -605,6 +611,7 @@ "properties": { "alertsCount": { "type": "integer", + "format": "int64", "description": "Total number of alerts in smart group" }, "smartGroupState": { @@ -719,6 +726,7 @@ }, "count": { "type": "integer", + "format": "int64", "description": "Total number of items of type." } } diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/ActionRules.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertProcessingRules.json similarity index 72% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/ActionRules.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertProcessingRules.json index 2a6536af617a..a74077f8a0bb 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/ActionRules.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertProcessingRules.json @@ -3,7 +3,7 @@ "info": { "version": "2021-08-08-preview", "title": "Azure Alerts Management Service Resource Provider", - "description": "APIs for Azure action rules CRUD operations." + "description": "APIs for Azure alert processing rules CRUD operations." }, "host": "management.azure.com", "schemes": [ @@ -29,8 +29,8 @@ "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules": { "get": { - "description": "List all action rules of the subscription", - "operationId": "ActionRules_ListBySubscription", + "description": "List all alert processing rules in a subscription.", + "operationId": "AlertProcessingRules_ListBySubscription", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -41,7 +41,7 @@ ], "responses": { "200": { - "description": "OK. Return the list of action rules", + "description": "OK. Return the list of alert processing rules.", "headers": { "x-ms-request-id": { "type": "string", @@ -49,7 +49,7 @@ } }, "schema": { - "$ref": "#/definitions/ActionRulesList" + "$ref": "#/definitions/AlertProcessingRulesList" } }, "default": { @@ -63,16 +63,16 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "GetActionRulesSubscriptionWide": { - "$ref": "./examples/ActionRules_List_Subscription.json" + "GetAlertProcessingRulesSubscriptionWide": { + "$ref": "./examples/AlertProcessingRules_List_Subscription.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules": { "get": { - "operationId": "ActionRules_ListByResourceGroup", - "description": "List all action rules of the subscription, created in given resource group", + "operationId": "AlertProcessingRules_ListByResourceGroup", + "description": "List all alert processing rules in a resource group.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -86,7 +86,7 @@ ], "responses": { "200": { - "description": "OK. Return the list of action rules", + "description": "OK. Return the list of alert processing rules.", "headers": { "x-ms-request-id": { "type": "string", @@ -94,7 +94,7 @@ } }, "schema": { - "$ref": "#/definitions/ActionRulesList" + "$ref": "#/definitions/AlertProcessingRulesList" } }, "default": { @@ -108,16 +108,16 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "GetActionRulesResourceGroupWide": { - "$ref": "./examples/ActionRules_List_ResourceGroup.json" + "GetAlertProcessingRulesResourceGroupWide": { + "$ref": "./examples/AlertProcessingRules_List_ResourceGroup.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}": { "get": { - "description": "Get action rule by name", - "operationId": "ActionRules_GetByName", + "description": "Get an alert processing rule by name.", + "operationId": "AlertProcessingRules_GetByName", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -126,9 +126,9 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "actionRuleName", + "name": "alertProcessingRuleName", "in": "path", - "description": "The name of the action rule that needs to be fetched", + "description": "The name of the alert processing rule that needs to be fetched.", "required": true, "type": "string" }, @@ -138,7 +138,7 @@ ], "responses": { "200": { - "description": "OK. Returns the specific action rule", + "description": "OK. Returns the specific alert processing rule.", "headers": { "x-ms-request-id": { "type": "string", @@ -146,7 +146,7 @@ } }, "schema": { - "$ref": "#/definitions/ActionRule" + "$ref": "#/definitions/AlertProcessingRule" } }, "default": { @@ -157,14 +157,14 @@ } }, "x-ms-examples": { - "GetActionRuleById": { - "$ref": "./examples/ActionRules_GetById.json" + "GetAlertProcessingRuleById": { + "$ref": "./examples/AlertProcessingRules_GetById.json" } } }, "put": { - "operationId": "ActionRules_CreateUpdate", - "description": "Create or update an action rule", + "operationId": "AlertProcessingRules_CreateOrUpdate", + "description": "Create or update an alert processing rule.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -173,19 +173,19 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "actionRuleName", + "name": "alertProcessingRuleName", "in": "path", - "description": "The name of the action rule that needs to be created/updated", + "description": "The name of the alert processing rule that needs to be created/updated.", "required": true, "type": "string" }, { - "name": "actionRule", + "name": "alertProcessingRule", "in": "body", - "description": "Action rule to be created/updated", + "description": "Alert processing rule to be created/updated.", "required": true, "schema": { - "$ref": "#/definitions/ActionRule" + "$ref": "#/definitions/AlertProcessingRule" } }, { @@ -194,7 +194,7 @@ ], "responses": { "200": { - "description": "OK. Returns the updated action rule", + "description": "OK. Returns the updated alert processing rule.", "headers": { "x-ms-request-id": { "type": "string", @@ -202,11 +202,11 @@ } }, "schema": { - "$ref": "#/definitions/ActionRule" + "$ref": "#/definitions/AlertProcessingRule" } }, "201": { - "description": "Created. Returns the created action rule", + "description": "Created. Returns the created alert processing rule.", "headers": { "x-ms-request-id": { "type": "string", @@ -214,7 +214,7 @@ } }, "schema": { - "$ref": "#/definitions/ActionRule" + "$ref": "#/definitions/AlertProcessingRule" } }, "default": { @@ -226,28 +226,28 @@ }, "x-ms-examples": { "Create or update a rule that adds an action group to all alerts in a subscription": { - "$ref": "./examples/ActionRules_Create_or_update_add_action_group_all_alerts_in_subscription.json" + "$ref": "./examples/AlertProcessingRules_Create_or_update_add_action_group_all_alerts_in_subscription.json" }, "Create or update a rule that adds two action groups to all Sev0 and Sev1 alerts in two resource groups": { - "$ref": "./examples/ActionRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json" + "$ref": "./examples/AlertProcessingRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json" }, "Create or update a rule that removes all action groups from alerts on a specific VM during a one-off maintenance window (1800-2000 at a specific date, Pacific Standard Time)": { - "$ref": "./examples/ActionRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json" + "$ref": "./examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json" }, "Create or update a rule that removes all action groups from all alerts on any VM in two resource groups during a recurring maintenance window (2200-0400 every Sat and Sun, India Standard Time)": { - "$ref": "./examples/ActionRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json" + "$ref": "./examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json" }, "Create or update a rule that removes all action groups outside business hours (Mon-Fri 09:00-17:00, Eastern Standard Time)": { - "$ref": "./examples/ActionRules_Create_or_update_remove_all_action_groups_outside_business_hours.json" + "$ref": "./examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_outside_business_hours.json" }, "Create or update a rule that removes all action groups from all alerts in a subscription coming from a specific alert rule": { - "$ref": "./examples/ActionRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json" + "$ref": "./examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json" } } }, "delete": { - "description": "Delete a given action rule", - "operationId": "ActionRules_Delete", + "description": "Delete an alert processing rule.", + "operationId": "AlertProcessingRules_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -256,9 +256,9 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "actionRuleName", + "name": "alertProcessingRuleName", "in": "path", - "description": "The name of the action rule that needs to be deleted", + "description": "The name of the alert processing rule that needs to be deleted.", "required": true, "type": "string" }, @@ -268,7 +268,7 @@ ], "responses": { "200": { - "description": "Successful request to delete an action rule", + "description": "Successful request to delete an alert processing rule.", "headers": { "x-ms-request-id": { "type": "string", @@ -277,7 +277,7 @@ } }, "204": { - "description": "No content: the request was successful, but the response is empty", + "description": "No content: the request was successful, but the response is empty.", "headers": { "x-ms-request-id": { "type": "string", @@ -293,14 +293,14 @@ } }, "x-ms-examples": { - "DeleteActionRule": { - "$ref": "./examples/ActionRules_Delete.json" + "DeleteAlertProcessingRule": { + "$ref": "./examples/AlertProcessingRules_Delete.json" } } }, "patch": { - "description": "Update enabled flag and/or tags for the given action rule", - "operationId": "ActionRules_Update", + "description": "Enable, disable, or update tags for an alert processing rule.", + "operationId": "AlertProcessingRules_Update", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -309,14 +309,14 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "actionRuleName", + "name": "alertProcessingRuleName", "in": "path", - "description": "The name that needs to be updated", + "description": "The name that needs to be updated.", "required": true, "type": "string" }, { - "name": "actionRulePatch", + "name": "alertProcessingRulePatch", "in": "body", "required": true, "schema": { @@ -330,7 +330,7 @@ ], "responses": { "200": { - "description": "OK. Returns the created/updated action rule", + "description": "OK. Returns the created/updated alert processing rule.", "headers": { "x-ms-request-id": { "type": "string", @@ -338,7 +338,7 @@ } }, "schema": { - "$ref": "#/definitions/ActionRule" + "$ref": "#/definitions/AlertProcessingRule" } }, "default": { @@ -349,8 +349,8 @@ } }, "x-ms-examples": { - "PatchActionRule": { - "$ref": "./examples/ActionRules_Patch.json" + "PatchAlertProcessingRule": { + "$ref": "./examples/AlertProcessingRules_Patch.json" } } } @@ -375,7 +375,7 @@ }, "api-version": { "name": "api-version", - "description": "client API version", + "description": "Client API version.", "type": "string", "in": "query", "required": true, @@ -443,7 +443,7 @@ } }, "ManagedResource": { - "description": "An azure managed resource object", + "description": "An azure managed resource object.", "allOf": [ { "$ref": "#/definitions/Resource" @@ -472,18 +472,18 @@ }, "Scopes": { "type": "array", - "description": "List of ARM IDs which will be the target of the given action rule.", + "description": "List of ARM IDs which will be the target of the given alert processing rule.", "items": { "type": "string" } }, "Condition": { "type": "object", - "description": "Condition to trigger an action rule", + "description": "Condition to trigger an alert processing rule.", "properties": { "field": { "type": "string", - "description": "Field for a given condition", + "description": "Field for a given condition.", "enum": [ "Severity", "MonitorService", @@ -504,7 +504,7 @@ }, "operator": { "type": "string", - "description": "Operator for a given condition", + "description": "Operator for a given condition.", "enum": [ "Equals", "NotEquals", @@ -527,14 +527,14 @@ }, "Conditions": { "type": "array", - "description": "Conditions in alert instance to be matched for a given action rule. Default value is all. Multiple values could be provided with comma separation.", + "description": "Conditions in alert instance to be matched for a given alert processing rule. Default value is all. Multiple values could be provided with comma separation.", "items": { "$ref": "#/definitions/Condition" } }, "Schedule": { "type": "object", - "description": "Scheduling configuration for a given action rule", + "description": "Scheduling configuration for a given alert processing rule.", "properties": { "effectiveFrom": { "type": "string", @@ -548,11 +548,11 @@ }, "timeZone": { "type": "string", - "description": "Scheduling time zone" + "description": "Scheduling time zone." }, "recurrences": { "type": "array", - "description": "List of recurrences", + "description": "List of recurrences.", "items": { "$ref": "#/definitions/Recurrence" } @@ -561,7 +561,7 @@ }, "Recurrence": { "type": "object", - "description": "Recurrence object", + "description": "Recurrence object.", "discriminator": "recurrenceType", "required": [ "recurrenceType" @@ -569,7 +569,7 @@ "properties": { "recurrenceType": { "type": "string", - "description": "Specifies when the recurrence should be applied", + "description": "Specifies when the recurrence should be applied.", "enum": [ "Daily", "Weekly", @@ -582,18 +582,18 @@ }, "startTime": { "type": "string", - "description": "Start time for recurrence" + "description": "Start time for recurrence." }, "endTime": { "type": "string", - "description": "End time for recurrence" + "description": "End time for recurrence." } } }, "DailyRecurrence": { "x-ms-discriminator-value": "Daily", "type": "object", - "description": "Daily recurrence object", + "description": "Daily recurrence object.", "required": [ "startTime", "endTime" @@ -607,7 +607,7 @@ "WeeklyRecurrence": { "x-ms-discriminator-value": "Weekly", "type": "object", - "description": "Weekly recurrence object", + "description": "Weekly recurrence object.", "required": [ "daysOfWeek" ], @@ -619,7 +619,7 @@ "properties": { "daysOfWeek": { "type": "array", - "description": "Specifies the values for weekly recurrence pattern", + "description": "Specifies the values for weekly recurrence pattern.", "items": { "$ref": "#/definitions/DaysOfWeek" } @@ -629,7 +629,7 @@ "MonthlyRecurrence": { "x-ms-discriminator-value": "Monthly", "type": "object", - "description": "Monthly recurrence object", + "description": "Monthly recurrence object.", "required": [ "daysOfMonth" ], @@ -641,7 +641,7 @@ "properties": { "daysOfMonth": { "type": "array", - "description": "Specifies the values for monthly recurrence pattern", + "description": "Specifies the values for monthly recurrence pattern.", "items": { "type": "integer", "format": "int32" @@ -651,7 +651,7 @@ }, "DaysOfWeek": { "type": "string", - "description": "Days of week", + "description": "Days of week.", "enum": [ "Sunday", "Monday", @@ -666,8 +666,9 @@ "modelAsString": true } }, - "ActionRule": { - "description": "Action rule object containing target scopes, conditions and scheduling logic", + "AlertProcessingRule": { + "type": "object", + "description": "Alert processing rule object containing target scopes, conditions and scheduling logic.", "allOf": [ { "$ref": "#/definitions/ManagedResource" @@ -675,55 +676,56 @@ ], "properties": { "properties": { - "description": "Action rule properties", - "$ref": "#/definitions/ActionRuleProperties" + "description": "Alert processing rule properties.", + "$ref": "#/definitions/AlertProcessingRuleProperties" }, "systemData": { - "description": "Action rule system data", + "description": "Alert processing rule system data.", "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } } }, - "ActionRuleProperties": { - "description": "Action rule properties defining scopes, conditions and scheduling logic for action rule", + "AlertProcessingRuleProperties": { + "type": "object", + "description": "Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule.", "required": [ "scopes", "actions" ], "properties": { "scopes": { - "description": "Scopes on which action rule will apply", + "description": "Scopes on which alert processing rule will apply.", "$ref": "#/definitions/Scopes" }, "conditions": { - "description": "Conditions on which alerts will be filtered", + "description": "Conditions on which alerts will be filtered.", "$ref": "#/definitions/Conditions" }, "schedule": { - "description": "Scheduling for action rule", + "description": "Scheduling for alert processing rule.", "$ref": "#/definitions/Schedule" }, "actions": { "type": "array", - "description": "Actions to be applied", + "description": "Actions to be applied.", "items": { "$ref": "#/definitions/Action" } }, "description": { "type": "string", - "description": "Description of action rule" + "description": "Description of alert processing rule." }, "enabled": { "type": "boolean", "default": true, - "description": "Indicates if the given action rule is enabled or disabled" + "description": "Indicates if the given alert processing rule is enabled or disabled." } } }, "Action": { "type": "object", - "description": "Action to be applied", + "description": "Action to be applied.", "discriminator": "actionType", "required": [ "actionType" @@ -731,7 +733,7 @@ "properties": { "actionType": { "type": "string", - "description": "Action that should be applied", + "description": "Action that should be applied.", "enum": [ "AddActionGroups", "RemoveAllActionGroups" @@ -746,7 +748,7 @@ "AddActionGroups": { "x-ms-discriminator-value": "AddActionGroups", "type": "object", - "description": "Add action groups to action rule", + "description": "Add action groups to alert processing rule.", "required": [ "actionGroupIds" ], @@ -757,7 +759,7 @@ ], "properties": { "actionGroupIds": { - "description": "List of action group Ids to add to action rule", + "description": "List of action group Ids to add to alert processing rule.", "type": "array", "items": { "type": "string" @@ -768,44 +770,45 @@ "RemoveAllActionGroups": { "x-ms-discriminator-value": "RemoveAllActionGroups", "type": "object", - "description": "Indicates if all action groups should be removed", + "description": "Indicates if all action groups should be removed.", "allOf": [ { "$ref": "#/definitions/Action" } ] }, - "ActionRulesList": { - "description": "List of action rules", + "AlertProcessingRulesList": { + "type": "object", + "description": "List of alert processing rules.", "properties": { "nextLink": { "type": "string", - "description": "URL to fetch the next set of action rules" + "description": "URL to fetch the next set of alert processing rules." }, "value": { "type": "array", - "description": "List of action rules", + "description": "List of alert processing rules.", "items": { - "$ref": "#/definitions/ActionRule" + "$ref": "#/definitions/AlertProcessingRule" } } } }, "PatchProperties": { - "description": "Action rule properties supported by patch", + "description": "Alert processing rule properties supported by patch.", "properties": { "enabled": { "type": "boolean", - "description": "Indicates if the given action rule is enabled or disabled" + "description": "Indicates if the given alert processing rule is enabled or disabled." } } }, "PatchObject": { - "description": "Data contract for patch", + "description": "Data contract for patch.", "properties": { "properties": { "x-ms-client-flatten": true, - "description": "Properties supported by patch operation", + "description": "Properties supported by patch operation.", "$ref": "#/definitions/PatchProperties" }, "tags": { @@ -813,7 +816,7 @@ "additionalProperties": { "type": "string" }, - "description": "Tags to be updated" + "description": "Tags to be updated." } } } diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertsManagement.json deleted file mode 100644 index ed253c5cd422..000000000000 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertsManagement.json +++ /dev/null @@ -1,117 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2021-08-08-preview", - "title": "Azure Alerts Management Service Resource Provider", - "description": "Azure Alerts Management Service provides a single pane of glass of alerts across Azure Monitor." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.AlertsManagement/operations": { - "get": { - "operationId": "Operations_List", - "description": "List all operations available through Azure Alerts Management Resource Provider.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK. Successfully retrieved operations list.", - "schema": { - "$ref": "#/definitions/operationsList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "operation": { - "description": "Operation provided by provider", - "properties": { - "name": { - "type": "string", - "description": "Name of the operation" - }, - "display": { - "type": "object", - "description": "Properties of the operation", - "properties": { - "provider": { - "type": "string", - "description": "Provider name" - }, - "resource": { - "type": "string", - "description": "Resource name" - }, - "operation": { - "type": "string", - "description": "Operation name" - }, - "description": { - "type": "string", - "description": "Description of the operation" - } - } - } - } - }, - "operationsList": { - "description": "Lists the operations available in the AlertsManagement RP.", - "properties": { - "nextLink": { - "description": "URL to fetch the next set of operations.", - "type": "string" - }, - "value": { - "description": "Array of operations", - "type": "array", - "items": { - "$ref": "#/definitions/operation" - } - } - }, - "required": [ - "value" - ] - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } - } -} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_add_action_group_all_alerts_in_subscription.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_add_action_group_all_alerts_in_subscription.json similarity index 96% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_add_action_group_all_alerts_in_subscription.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_add_action_group_all_alerts_in_subscription.json index 52088517ef0e..50e490c2d49c 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_add_action_group_all_alerts_in_subscription.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_add_action_group_all_alerts_in_subscription.json @@ -3,8 +3,8 @@ "api-version": "2021-08-08-preview", "subscriptionId": "subId1", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "AddActionGroupToSubscription", - "actionRule": { + "alertProcessingRuleName": "AddActionGroupToSubscription", + "alertProcessingRule": { "location": "Global", "tags": {}, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json similarity index 97% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json index 76525df8a56e..21db08455a86 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_add_two_action_groups_all_Sev0_Sev1_two_resource_groups.json @@ -3,8 +3,8 @@ "api-version": "2021-08-08-preview", "subscriptionId": "subId1", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "AddActionGroupsBySeverity", - "actionRule": { + "alertProcessingRuleName": "AddActionGroupsBySeverity", + "alertProcessingRule": { "location": "Global", "tags": {}, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json similarity index 92% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json index 4cb5c8c628b1..d3ecbafde24a 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_from_specific_alert_rule.json @@ -3,8 +3,8 @@ "api-version": "2021-08-08-preview", "subscriptionId": "subId1", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "RemoveActionGroupsSpecificAlertRule", - "actionRule": { + "alertProcessingRuleName": "RemoveActionGroupsSpecificAlertRule", + "alertProcessingRule": { "location": "Global", "tags": {}, "properties": { @@ -22,7 +22,7 @@ ], "actions": [ { - "actionType": "RemoveAllActiongroups" + "actionType": "RemoveAllActionGroups" } ], "description": "Removes all ActionGroups from all Alerts that fire on above AlertRule", @@ -56,7 +56,7 @@ ], "actions": [ { - "actionType": "RemoveAllActiongroups" + "actionType": "RemoveAllActionGroups" } ], "description": "Removes all ActionGroups from all Alerts that fire on above AlertRule", @@ -94,7 +94,7 @@ ], "actions": [ { - "actionType": "RemoveAllActiongroups" + "actionType": "RemoveAllActionGroups" } ], "description": "Removes all ActionGroups from all Alerts that fire on above AlertRule", diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_outside_business_hours.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_outside_business_hours.json similarity index 97% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_outside_business_hours.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_outside_business_hours.json index c040c555ce64..cda18eb1656a 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_outside_business_hours.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_outside_business_hours.json @@ -3,8 +3,8 @@ "api-version": "2021-08-08-preview", "subscriptionId": "subId1", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "RemoveActionGroupsOutsideBusinessHours", - "actionRule": { + "alertProcessingRuleName": "RemoveActionGroupsOutsideBusinessHours", + "alertProcessingRule": { "location": "Global", "tags": {}, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json similarity index 97% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json index 65baa6704870..8b3dda899f52 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_recurring_maintenance_window.json @@ -3,8 +3,8 @@ "api-version": "2021-08-08-preview", "subscriptionId": "subId1", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "RemoveActionGroupsRecurringMaintenance", - "actionRule": { + "alertProcessingRuleName": "RemoveActionGroupsRecurringMaintenance", + "alertProcessingRule": { "location": "Global", "tags": {}, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json similarity index 97% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json index 0e46232aef9b..ba95adcfeac0 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Create_or_update_remove_all_action_groups_specific_VM_one-off_maintenance_window.json @@ -3,8 +3,8 @@ "api-version": "2021-08-08-preview", "subscriptionId": "subId1", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "RemoveActionGroupsMaintenanceWindow", - "actionRule": { + "alertProcessingRuleName": "RemoveActionGroupsMaintenanceWindow", + "alertProcessingRule": { "location": "Global", "tags": {}, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Delete.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Delete.json similarity index 82% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Delete.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Delete.json index 6a9bbd02c9e0..7c7e622235a9 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Delete.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Delete.json @@ -3,7 +3,7 @@ "api-version": "2021-08-08-preview", "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "DailySuppression" + "alertProcessingRuleName": "DailySuppression" }, "responses": { "200": {}, diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_GetById.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_GetById.json similarity index 94% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_GetById.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_GetById.json index 8b1d3aed1722..d19660c451ae 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_GetById.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_GetById.json @@ -3,7 +3,7 @@ "api-version": "2021-08-08-preview", "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "DailySuppression" + "alertProcessingRuleName": "DailySuppression" }, "responses": { "200": { @@ -86,7 +86,7 @@ ] } ], - "description": "Action rule on resource group for daily and weekly scheduling", + "description": "Alert processing rule on resource group for daily and weekly scheduling", "enabled": true }, "tags": {} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_List_ResourceGroup.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_List_ResourceGroup.json similarity index 96% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_List_ResourceGroup.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_List_ResourceGroup.json index f948c8c845b0..398cd5892286 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_List_ResourceGroup.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_List_ResourceGroup.json @@ -64,7 +64,7 @@ "actionType": "RemoveAllActionGroups" } ], - "description": "Action rule on resource group for daily suppression", + "description": "Alert processing rule on resource group for daily suppression", "enabled": true }, "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression", @@ -119,7 +119,7 @@ ] } ], - "description": "Action rule on resource group for sending email", + "description": "Alert processing rule on resource group for sending email", "enabled": true }, "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression", diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_List_Subscription.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_List_Subscription.json similarity index 95% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_List_Subscription.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_List_Subscription.json index c2c141c531f1..8a813b34c528 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_List_Subscription.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_List_Subscription.json @@ -63,7 +63,7 @@ "actionType": "RemoveAllActionGroups" } ], - "description": "Action rule on resource group for daily suppression", + "description": "Alert processing rule on resource group for daily suppression", "enabled": true }, "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression", @@ -102,7 +102,7 @@ ] } ], - "description": "Action rule on resource group for adding action group", + "description": "Alert processing rule on resource group for adding action group", "enabled": true, "actions": [ { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Patch.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Patch.json similarity index 91% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Patch.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Patch.json index ede6e07cc04d..6399c65ed87f 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/ActionRules_Patch.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2021-08-08-preview/examples/AlertProcessingRules_Patch.json @@ -3,8 +3,8 @@ "api-version": "2021-08-08-preview", "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", "resourceGroupName": "alertscorrelationrg", - "actionRuleName": "WeeklySuppression", - "actionRulePatch": { + "alertProcessingRuleName": "WeeklySuppression", + "alertProcessingRulePatch": { "tags": { "key1": "value1", "key2": "value2" @@ -72,10 +72,10 @@ }, "actions": [ { - "actionType": "removeAllActionGroups" + "actionType": "RemoveAllActionGroups" } ], - "description": "Action rule on resource group for weekly suppression", + "description": "Alert processing rule on resource group for weekly suppression", "enabled": false }, "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression", diff --git a/specification/alertsmanagement/resource-manager/readme.md b/specification/alertsmanagement/resource-manager/readme.md index c2d27f1745c3..ca5a3860ee21 100644 --- a/specification/alertsmanagement/resource-manager/readme.md +++ b/specification/alertsmanagement/resource-manager/readme.md @@ -41,11 +41,20 @@ directive: title: AlertsManagementClient description: AlertsManagement Client openapi-type: arm -tag: package-2019-06-preview +tag: package-preview-2021-08 ``` +### Tag: package-preview-2021-08 + +These settings apply only when `--tag=package-preview-2021-08` is specified on the command line. +```yaml $(tag) == 'package-preview-2021-08' +input-file: + - Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertProcessingRules.json + - Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json + - Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json +``` ### Tag: package-2021-04-only @@ -57,16 +66,6 @@ input-file: - Microsoft.AlertsManagement/stable/2021-04-01/SmartDetectorAlertRulesApi.json ``` -### Tag: package-preview-2021-08 - -These settings apply only when `--tag=package-preview-2021-08` is specified on the command line. - -```yaml $(tag) == 'package-preview-2021-08' -input-file: - - Microsoft.AlertsManagement/preview/2021-08-08-preview/ActionRules.json - - Microsoft.AlertsManagement/preview/2021-08-08-preview/AlertsManagement.json -``` - ### Tag: package-preview-2021-01 These settings apply only when `--tag=package-preview-2021-01` is specified on the command line.