Share via

EventData interface

  • Reference
Package:
@azure/arm-monitor

The Azure event log entries are of type EventData

Properties

authorization

The sender authorization information. NOTE: This property will not be serialized. It can only be populated by the server.
caller

the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability. NOTE: This property will not be serialized. It can only be populated by the server.
category

the event category. NOTE: This property will not be serialized. It can only be populated by the server.
claims

key value pairs to identify ARM permissions. NOTE: This property will not be serialized. It can only be populated by the server.
correlationId

the correlation Id, usually a GUID in the string format. The correlation Id is shared among the events that belong to the same uber operation. NOTE: This property will not be serialized. It can only be populated by the server.
description

the description of the event. NOTE: This property will not be serialized. It can only be populated by the server.
eventDataId

the event data Id. This is a unique identifier for an event. NOTE: This property will not be serialized. It can only be populated by the server.
eventName

the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users. NOTE: This property will not be serialized. It can only be populated by the server.
eventTimestamp

the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.
httpRequest

the HTTP request info. Usually includes the 'clientRequestId', 'clientIpAddress' (IP address of the user who initiated the event) and 'method' (HTTP method e.g. PUT). NOTE: This property will not be serialized. It can only be populated by the server.
id

the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information. NOTE: This property will not be serialized. It can only be populated by the server.
level

the event level NOTE: This property will not be serialized. It can only be populated by the server.
operationId

It is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName. NOTE: This property will not be serialized. It can only be populated by the server.
operationName

the operation name. NOTE: This property will not be serialized. It can only be populated by the server.
properties

the set of <Key, Value> pairs (usually a Dictionary<String, String>) that includes details about the event. NOTE: This property will not be serialized. It can only be populated by the server.
resourceGroupName

the resource group name of the impacted resource. NOTE: This property will not be serialized. It can only be populated by the server.
resourceId

the resource uri that uniquely identifies the resource that caused this event. NOTE: This property will not be serialized. It can only be populated by the server.
resourceProviderName

the resource provider name of the impacted resource. NOTE: This property will not be serialized. It can only be populated by the server.
resourceType

the resource type NOTE: This property will not be serialized. It can only be populated by the server.
status

a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved. NOTE: This property will not be serialized. It can only be populated by the server.
submissionTimestamp

the timestamp of when the event became available for querying via this API. It is in ISO 8601 format. This value should not be confused eventTimestamp. As there might be a delay between the occurrence time of the event, and the time that the event is submitted to the Azure logging infrastructure. NOTE: This property will not be serialized. It can only be populated by the server.
subscriptionId

the Azure subscription Id usually a GUID. NOTE: This property will not be serialized. It can only be populated by the server.
subStatus

the event sub status. Most of the time, when included, this captures the HTTP status code of the REST call. Common values are: OK (HTTP Status Code: 200), Created (HTTP Status Code: 201), Accepted (HTTP Status Code: 202), No Content (HTTP Status Code: 204), Bad Request(HTTP Status Code: 400), Not Found (HTTP Status Code: 404), Conflict (HTTP Status Code: 409), Internal Server Error (HTTP Status Code: 500), Service Unavailable (HTTP Status Code:503), Gateway Timeout (HTTP Status Code: 504) NOTE: This property will not be serialized. It can only be populated by the server.
tenantId

the Azure tenant Id NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

authorization

The sender authorization information. NOTE: This property will not be serialized. It can only be populated by the server.

authorization?: SenderAuthorization

Property Value

SenderAuthorization

caller

the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability. NOTE: This property will not be serialized. It can only be populated by the server.

caller?: string

Property Value

string

category

the event category. NOTE: This property will not be serialized. It can only be populated by the server.

category?: LocalizableString

Property Value

LocalizableString

claims

key value pairs to identify ARM permissions. NOTE: This property will not be serialized. It can only be populated by the server.

claims?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

correlationId

the correlation Id, usually a GUID in the string format. The correlation Id is shared among the events that belong to the same uber operation. NOTE: This property will not be serialized. It can only be populated by the server.

correlationId?: string

Property Value

string

description

the description of the event. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

eventDataId

the event data Id. This is a unique identifier for an event. NOTE: This property will not be serialized. It can only be populated by the server.

eventDataId?: string

Property Value

string

eventName

the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users. NOTE: This property will not be serialized. It can only be populated by the server.

eventName?: LocalizableString

Property Value

LocalizableString

eventTimestamp

the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format. NOTE: This property will not be serialized. It can only be populated by the server.

eventTimestamp?: Date

Property Value

Date

httpRequest

the HTTP request info. Usually includes the 'clientRequestId', 'clientIpAddress' (IP address of the user who initiated the event) and 'method' (HTTP method e.g. PUT). NOTE: This property will not be serialized. It can only be populated by the server.

httpRequest?: HttpRequestInfo

Property Value

HttpRequestInfo

id

the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

level

the event level NOTE: This property will not be serialized. It can only be populated by the server.

level?: EventLevel

Property Value

EventLevel

operationId

It is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName. NOTE: This property will not be serialized. It can only be populated by the server.

operationId?: string

Property Value

string

operationName

the operation name. NOTE: This property will not be serialized. It can only be populated by the server.

operationName?: LocalizableString

Property Value

LocalizableString

properties

the set of <Key, Value> pairs (usually a Dictionary<String, String>) that includes details about the event. NOTE: This property will not be serialized. It can only be populated by the server.

properties?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

resourceGroupName

the resource group name of the impacted resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGroupName?: string

Property Value

string

resourceId

the resource uri that uniquely identifies the resource that caused this event. NOTE: This property will not be serialized. It can only be populated by the server.

resourceId?: string

Property Value

string

resourceProviderName

the resource provider name of the impacted resource. NOTE: This property will not be serialized. It can only be populated by the server.

resourceProviderName?: LocalizableString

Property Value

LocalizableString

resourceType

the resource type NOTE: This property will not be serialized. It can only be populated by the server.

resourceType?: LocalizableString

Property Value

LocalizableString

status

a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved. NOTE: This property will not be serialized. It can only be populated by the server.

status?: LocalizableString

Property Value

LocalizableString

submissionTimestamp

the timestamp of when the event became available for querying via this API. It is in ISO 8601 format. This value should not be confused eventTimestamp. As there might be a delay between the occurrence time of the event, and the time that the event is submitted to the Azure logging infrastructure. NOTE: This property will not be serialized. It can only be populated by the server.

submissionTimestamp?: Date

Property Value

Date

subscriptionId

the Azure subscription Id usually a GUID. NOTE: This property will not be serialized. It can only be populated by the server.

subscriptionId?: string

Property Value

string

subStatus

the event sub status. Most of the time, when included, this captures the HTTP status code of the REST call. Common values are: OK (HTTP Status Code: 200), Created (HTTP Status Code: 201), Accepted (HTTP Status Code: 202), No Content (HTTP Status Code: 204), Bad Request(HTTP Status Code: 400), Not Found (HTTP Status Code: 404), Conflict (HTTP Status Code: 409), Internal Server Error (HTTP Status Code: 500), Service Unavailable (HTTP Status Code:503), Gateway Timeout (HTTP Status Code: 504) NOTE: This property will not be serialized. It can only be populated by the server.

subStatus?: LocalizableString

Property Value

LocalizableString

tenantId

the Azure tenant Id NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string