Impacted Resources - List By Tenant Id And Event Id

Service:

Resource Health

API Version:

2024-02-01

Lists impacted resources in the tenant by an event.

GET https://management.azure.com/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources?api-version=2024-02-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources?api-version=2024-02-01&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
eventTrackingId	path	True	string	Event Id which uniquely identifies ServiceHealth event.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN

Responses

Name	Type	Description
200 OK	eventImpactedResourceListResult	The list of impacted resources in the tenant by an event.
Other Status Codes	ErrorResponse	DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListEventsByTenantId

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.ResourceHealth/events/BC_1-FXZ/impactedResources?api-version=2024-02-01&$filter=targetRegion eq 'westus'

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ/impactedResources/abc-123-ghj-456",
      "name": "abc-123-ghj-456",
      "type": "Microsoft.ResourceHealth/events/impactedResources",
      "properties": {
        "targetResourceType": "Microsoft.Compute/VirtualMachines",
        "targetResourceId": "{resourceId-1}",
        "targetRegion": "westus"
      }
    },
    {
      "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ/impactedResources/wer-345-tyu-789",
      "name": "wer-345-tyu-789",
      "type": "Microsoft.ResourceHealth/events/impactedResources",
      "properties": {
        "targetResourceType": "Microsoft.Compute/VirtualMachines",
        "targetResourceId": "{resourceId-2}",
        "targetRegion": "westus"
      }
    }
  ],
  "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorResponse	Error details.
eventImpactedResource	Impacted resource for an event.
eventImpactedResourceListResult	The List of eventImpactedResources operation response.
keyValueItem	Key value tuple.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Error details.

Name	Type	Description
code	string	The error code.
details	string	The error details.
message	string	The error message.

eventImpactedResource

Object

Impacted resource for an event.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.info	keyValueItem[]	Additional information.
properties.targetRegion	string	Impacted resource region name.
properties.targetResourceId	string	Identity for resource within Microsoft cloud.
properties.targetResourceType	string	Resource type within Microsoft cloud.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

eventImpactedResourceListResult

Object

The List of eventImpactedResources operation response.

Name	Type	Description
nextLink	string	The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of impacted resource.
value	eventImpactedResource[]	The list of eventImpactedResources.

keyValueItem

Object

Key value tuple.

Name	Type	Description
key	string	Key of tuple.
value	string	Value of tuple.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.