diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/ResourceHealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/ResourceHealth.json index 7595d5968156..1dad570015cc 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/ResourceHealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/ResourceHealth.json @@ -599,6 +599,45 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/fetchEventDetails": { + "post": { + "tags": [ + "Event" + ], + "operationId": "Event_fetchDetailsBySubscriptionIdAndTrackingId", + "description": "Service health event details in the subscription by event tracking id. This can be used to fetch sensitive properties for Security Advisory events", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/EventTrackingIdParameter" + } + ], + "responses": { + "200": { + "description": "Service Health Event details in the subscription requested by tracking id.", + "schema": { + "$ref": "#/definitions/event" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EventDetailsBySubscriptionIdAndTrackingId": { + "$ref": "./examples/Event_fetchDetailsBySubscriptionIdAndTrackingId.json" + } + } + } + }, "/providers/Microsoft.ResourceHealth/events": { "get": { "tags": [ @@ -683,6 +722,42 @@ } } }, + "/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/fetchEventDetails": { + "post": { + "tags": [ + "Event" + ], + "operationId": "Event_fetchDetailsByTenantIdAndTrackingId", + "description": "Service health event details in the tenant by event tracking id. This can be used to fetch sensitive properties for Security Advisory events", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/EventTrackingIdParameter" + } + ], + "responses": { + "200": { + "description": "Service health event details in the tenant by event tracking id.", + "schema": { + "$ref": "#/definitions/event" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EventDetailsByTenantIdAndTrackingId": { + "$ref": "./examples/Event_fetchDetailsByTenantIdAndTrackingId.json" + } + } + } + }, "/{resourceUri}/providers/Microsoft.ResourceHealth/events": { "get": { "tags": [ diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/examples/Event_fetchDetailsBySubscriptionIdAndTrackingId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/examples/Event_fetchDetailsBySubscriptionIdAndTrackingId.json new file mode 100644 index 000000000000..6c57fdefab07 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/examples/Event_fetchDetailsBySubscriptionIdAndTrackingId.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "eventTrackingId": "eventTrackingId", + "api-version": "2022-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.ResourceHealth/events/{eventTrackingId}", + "name": "{eventTrackingId}", + "type": "/providers/Microsoft.ResourceHealth/events", + "properties": { + "eventType": "ServiceIssue", + "eventSource": "ResourceHealth", + "status": "Active", + "title": "ACTIVE: Virtual machines in West US", + "summary": "An outage alert is being investigated. More information will be provided as it is known.", + "header": "Your service might have been impacted by an Azure service issue", + "article": { + "articleContent": "An outage alert is being investigated. More information will be provided as it is known" + }, + "links": [ + { + "type": "Hyperlink", + "displayText": { + "value": "Request RCA", + "localizedValue": "Request RCA" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "RequestRCABlade", + "parameters": { + "trackingId": "{eventTrackingId}", + "rcaRequested": "False" + } + }, + { + "type": "Button", + "displayText": { + "value": "Sign up for updates", + "localizedValue": "Sign up for updates" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "AzureHealthBrowseBlade", + "parameters": { + "trackingId": "{eventTrackingId}" + } + } + ], + "level": "Warning", + "eventLevel": "Informational", + "impactStartTime": "2018-11-07T00:00:00Z", + "impactMitigationTime": "2018-11-08T00:00:00Z", + "impact": [ + { + "impactedService": "Virtual Machines", + "impactedRegions": [ + { + "impactedRegion": "West US", + "status": "Active", + "impactedSubscriptions": [ + "{subscriptionId}" + ], + "impactedTenants": [], + "lastUpdateTime": "2017-12-05T21:05:00Z" + } + ] + } + ], + "recommendedActions": { + "message": "Recommended actions title", + "actions": [ + { + "groupId": 23243, + "actionText": "action 1" + }, + { + "groupId": 23432, + "actionText": "action 2" + } + ], + "localeCode": "en" + }, + "faqs": [ + { + "question": "This is a question", + "answer": "This is an answer", + "localeCode": "en" + } + ], + "isHIR": false, + "enableMicrosoftSupport": true, + "enableChatWithUs": false, + "priority": 2, + "lastUpdateTime": "2018-11-08T00:00:00Z", + "hirStage": "resolved" + } + } + } + } +} diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/examples/Event_fetchDetailsByTenantIdAndTrackingId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/examples/Event_fetchDetailsByTenantIdAndTrackingId.json new file mode 100644 index 000000000000..f295dc51f913 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2022-10-01-preview/examples/Event_fetchDetailsByTenantIdAndTrackingId.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "eventTrackingId": "eventTrackingId", + "api-version": "2022-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.ResourceHealth/events/{eventTrackingId}", + "name": "{eventTrackingId}", + "type": "/providers/Microsoft.ResourceHealth/events", + "properties": { + "eventType": "ServiceIssue", + "eventSource": "ResourceHealth", + "status": "Active", + "title": "ACTIVE: Virtual machines in West US", + "summary": "An outage alert is being investigated. More information will be provided as it is known.", + "header": "Your service might have been impacted by an Azure service issue", + "article": { + "articleContent": "An outage alert is being investigated. More information will be provided as it is known" + }, + "links": [ + { + "type": "Hyperlink", + "displayText": { + "value": "Request RCA", + "localizedValue": "Request RCA" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "RequestRCABlade", + "parameters": { + "trackingId": "{eventTrackingId}", + "rcaRequested": "False" + } + }, + { + "type": "Button", + "displayText": { + "value": "Sign up for updates", + "localizedValue": "Sign up for updates" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "AzureHealthBrowseBlade", + "parameters": { + "trackingId": "{eventTrackingId}" + } + } + ], + "level": "Warning", + "eventLevel": "Informational", + "impactStartTime": "2018-11-07T00:00:00Z", + "impactMitigationTime": "2018-11-08T00:00:00Z", + "impact": [ + { + "impactedService": "Virtual Machines", + "impactedRegions": [ + { + "impactedRegion": "West US", + "status": "Active", + "impactedSubscriptions": [], + "impactedTenants": [ + "00000000-0000-0000-0000-000000000000" + ], + "lastUpdateTime": "2017-12-05T21:05:00Z" + } + ] + } + ], + "recommendedActions": { + "message": "Recommended actions title", + "actions": [ + { + "groupId": 23243, + "actionText": "action 1" + }, + { + "groupId": 23432, + "actionText": "action 2" + } + ], + "localeCode": "en" + }, + "faqs": [ + { + "question": "This is a question", + "answer": "This is an answer", + "localeCode": "en" + } + ], + "isHIR": false, + "enableMicrosoftSupport": true, + "enableChatWithUs": false, + "priority": 2, + "lastUpdateTime": "2018-11-08T00:00:00Z", + "hirStage": "resolved" + } + } + } + } +}