Adding 2023-07-01-preview

a) Adding maintenance related fields for events b) Adding maintenance related fields for impacted resources c) Adding subeventType for events
Azure · Aug 22, 2023 · 446c8a3 · 446c8a3
1 parent ff7e78b
commit 446c8a3
Show file tree

Hide file tree

Showing 6 changed files with 118 additions and 6 deletions.
diff --git a/.../resource-manager/Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json b/.../resource-manager/Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json
@@ -1148,6 +1148,17 @@
                 "modelAsString": true
               }
             },
+            "eventSubType": {
+              "type": "string",
+              "description": "Sub type of the event. Currently used to determine retirement communications for health advisory events",
+              "enum": [
+                "Retirement"
+              ],
+              "x-ms-enum": {
+                "name": "EventSubTypeValues",
+                "modelAsString": true
+              }
+            },
             "eventSource": {
               "type": "string",
               "description": "Source of event.",
@@ -1356,6 +1367,18 @@
             "impactType": {
               "type": "string",
               "description": "The type of the impact"
+            },
+            "maintenanceId": {
+              "type": "string",
+              "description": "Unique identifier for planned maintenance event."
+            },
+            "maintenanceType": {
+              "type": "string",
+              "description": "The type of planned maintenance event."
+            },
+            "argQuery": {
+              "type": "string",
+              "description": "Azure Resource Graph query to fetch the affected resources from their existing Azure Resource Graph locations."
             }
           }
         }
@@ -2048,6 +2071,31 @@
               "type": "string",
               "description": "Impacted resource region name."
             },
+            "resourceName": {
+              "readOnly": true,
+              "type": "string",
+              "description": "Resource name."
+            },
+            "resourceGroup": {
+              "readOnly": true,
+              "type": "string",
+              "description": "Resource group name."
+            },
+            "maintenanceStatus": {
+              "readOnly": true,
+              "type": "string",
+              "description": "Status of maintenance for the impacted resource."
+            },
+            "maintenanceStartTime": {
+              "readOnly": true,
+              "type": "string",
+              "description": "Start time of maintenance for the impacted resource."
+            },
+            "maintenanceEndTime": {
+              "readOnly": true,
+              "type": "string",
+              "description": "End time of maintenance for the impacted resource."
+            },
             "info": {
               "type": "array",
               "items": {

diff --git a/...rceHealth/preview/2023-07-01-preview/examples/Event_GetBySubscriptionIdAndTrackingId.json b/...rceHealth/preview/2023-07-01-preview/examples/Event_GetBySubscriptionIdAndTrackingId.json
@@ -95,7 +95,10 @@
           "enableChatWithUs": false,
           "priority": 2,
           "lastUpdateTime": "2018-11-08T00:00:00Z",
-          "hirStage": "resolved"
+          "hirStage": "resolved",
+          "maintenanceId": "{maintenanceId}",
+          "maintenanceType": "{maintenanceType}",
+          "argQuery": "{argQuery}"
         }
       }
     }

diff --git a/.../preview/2023-07-01-preview/examples/Event_fetchDetailsBySubscriptionIdAndTrackingId.json b/.../preview/2023-07-01-preview/examples/Event_fetchDetailsBySubscriptionIdAndTrackingId.json
@@ -93,7 +93,10 @@
           "enableChatWithUs": false,
           "priority": 2,
           "lastUpdateTime": "2018-11-08T00:00:00Z",
-          "hirStage": "resolved"
+          "hirStage": "resolved",
+          "maintenanceId": "{maintenanceId}",
+          "maintenanceType": "{maintenanceType}",
+          "argQuery": "{argQuery}"
         }
       }
     }

diff --git a/...osoft.ResourceHealth/preview/2023-07-01-preview/examples/Events_ListBySubscriptionId.json b/...osoft.ResourceHealth/preview/2023-07-01-preview/examples/Events_ListBySubscriptionId.json
@@ -96,7 +96,50 @@
               "enableChatWithUs": false,
               "priority": 2,
               "lastUpdateTime": "2018-11-08T00:00:00Z",
-              "hirStage": "resolved"
+              "hirStage": "resolved",
+              "maintenanceId": "{maintenanceId}",
+              "maintenanceType": "{maintenanceType}",
+              "argQuery": "{argQuery}"
+            }
+          },
+          {
+            "id": "Microsoft.ResourceHealth/events/ABH3-RET",
+            "name": "ABH3-RET",
+            "type": "Microsoft.ResourceHealth/events",
+            "properties": {
+                "eventType": "HealthAdvisory",
+                "eventSubType": "Retirement",
+                "eventSource": "ServiceHealth",
+                "status": "Active",
+                "title": "retirement test",
+                "summary": "retirement test",
+                "description": "retirement test",
+                "platformInitiated": true,
+                "header": "retirement test",
+                "level": "Warning",
+                "eventLevel": "Warning",
+                "impactStartTime": "2023-08-14T19:10:00Z",
+                "impactMitigationTime": "2023-08-14T20:10:00Z",
+                "impact": [
+                {
+                  "impactedService": "Virtual Machines",
+                  "impactedRegions": [
+                    {
+                      "impactedRegion": "West US",
+                      "status": "Active",
+                      "impactedSubscriptions": [
+                        "{subscriptionId}"
+                      ],
+                      "impactedTenants": [],
+                      "lastUpdateTime": "2023-08-14T20:10:00Z"
+                    }
+                  ]
+                }
+              ],
+                "recommendedActions": {},
+                "isHIR": false,
+                "priority": 22,
+                "lastUpdateTime": "2023-08-14T20:10:00Z"
             }
           }
         ],

diff --git a/...r/Microsoft.ResourceHealth/preview/2023-07-01-preview/examples/ImpactedResources_Get.json b/...r/Microsoft.ResourceHealth/preview/2023-07-01-preview/examples/ImpactedResources_Get.json
@@ -14,7 +14,12 @@
         "properties": {
           "targetResourceType": "Microsoft.Compute/VirtualMachines",
           "targetResourceId": "/subscriptions/4970d23e-ed41-4670-9c19-02a1d2808dd9/resourceGroups/TEST/providers/Microsoft.Compute/virtualMachines/testvm",
-          "targetRegion": "westus"
+          "targetRegion": "westus",
+          "resourceName": "{resourceName}",
+          "resourceGroup": "{resourceGroup}",
+          "maintenanceStatus": "{maintenanceStatus}",
+          "maintenanceStartTime": "{maintenanceStartTime}",
+          "maintenanceEndTime": "{maintenanceEndTime}"
         }
       }
     }

diff --git a/...iew/2023-07-01-preview/examples/ImpactedResources_ListBySubscriptionId_ListByEventId.json b/...iew/2023-07-01-preview/examples/ImpactedResources_ListBySubscriptionId_ListByEventId.json
@@ -16,7 +16,12 @@
             "properties": {
               "targetResourceType": "Microsoft.Compute/VirtualMachines",
               "targetResourceId": "/subscriptions/4970d23e-ed41-4670-9c19-02a1d2808dd9/resourceGroups/TEST/providers/Microsoft.Compute/virtualMachines/testvm",
-              "targetRegion": "westus"
+              "targetRegion": "westus",
+              "resourceName": "{resourceName}",
+              "resourceGroup": "{resourceGroup}",
+              "maintenanceStatus": "{maintenanceStatus}",
+              "maintenanceStartTime": "{maintenanceStartTime}",
+              "maintenanceEndTime": "{maintenanceEndTime}"
             }
           },
           {
@@ -51,7 +56,12 @@
             "properties": {
               "targetResourceType": "Microsoft.Compute/VirtualMachines",
               "targetResourceId": "/subscriptions/4970d23e-ed41-4670-9c19-02a1d2808dd9/resourceGroups/Dev2/providers/Microsoft.Compute/virtualMachines/testvm2",
-              "targetRegion": "westus"
+              "targetRegion": "westus",
+              "resourceName": "{resourceName}",
+              "resourceGroup": "{resourceGroup}",
+              "maintenanceStatus": "{maintenanceStatus}",
+              "maintenanceStartTime": "{maintenanceStartTime}",
+              "maintenanceEndTime": "{maintenanceEndTime}"
             }
           }
         ],