EventDataInner Class

  • java.lang.Object
    • com.microsoft.azure.management.monitor.implementation.EventDataInner

public class EventDataInner

The Azure event log entries are of type EventData.

Method Summary

Modifier and Type Method and Description
SenderAuthorization authorization()

Get the sender authorization information.

String caller()

Get the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability.

LocalizableStringInner category()

Get the event category.

Map<String, String> claims()

Get key value pairs to identify ARM permissions.

String correlationId()

Get 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.

String description()

Get the description of the event.

String eventDataId()

Get the event data Id. This is a unique identifier for an event.

LocalizableStringInner eventName()

Get the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users.

DateTime eventTimestamp()

Get the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format.

HttpRequestInfo httpRequest()

Get 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).

String id()

Get the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information.

EventLevel level()

Get the event level. Possible values include: 'Critical', 'Error', 'Warning', 'Informational', 'Verbose'.

String operationId()

Get it is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName.

LocalizableStringInner operationName()

Get the operation name.

Map<String, String> properties()

Get the set of <Key, Value> pairs (usually a Dictionary<String, String>) that includes details about the event.

String resourceGroupName()

Get the resource group name of the impacted resource.

String resourceId()

Get the resource uri that uniquely identifies the resource that caused this event.

LocalizableStringInner resourceProviderName()

Get the resource provider name of the impacted resource.

LocalizableStringInner resourceType()

Get the resource type.

LocalizableStringInner status()

Get a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved.

DateTime submissionTimestamp()

Get 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.

String subscriptionId()

Get the Azure subscription Id usually a GUID.

LocalizableStringInner subStatus()

Get 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).

String tenantId()

Get the Azure tenant Id.

Method Details

authorization

public SenderAuthorization authorization()

Get the sender authorization information.

Returns:

the authorization value

caller

public String caller()

Get the email address of the user who has performed the operation, the UPN claim or SPN claim based on availability.

Returns:

the caller value

category

public LocalizableStringInner category()

Get the event category.

Returns:

the category value

claims

public Map claims()

Get key value pairs to identify ARM permissions.

Returns:

the claims value

correlationId

public String correlationId()

Get 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.

Returns:

the correlationId value

description

public String description()

Get the description of the event.

Returns:

the description value

eventDataId

public String eventDataId()

Get the event data Id. This is a unique identifier for an event.

Returns:

the eventDataId value

eventName

public LocalizableStringInner eventName()

Get the event name. This value should not be confused with OperationName. For practical purposes, OperationName might be more appealing to end users.

Returns:

the eventName value

eventTimestamp

public DateTime eventTimestamp()

Get the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format.

Returns:

the eventTimestamp value

httpRequest

public HttpRequestInfo httpRequest()

Get 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).

Returns:

the httpRequest value

id

public String id()

Get the Id of this event as required by ARM for RBAC. It contains the EventDataID and a timestamp information.

Returns:

the id value

level

public EventLevel level()

Get the event level. Possible values include: 'Critical', 'Error', 'Warning', 'Informational', 'Verbose'.

Returns:

the level value

operationId

public String operationId()

Get it is usually a GUID shared among the events corresponding to single operation. This value should not be confused with EventName.

Returns:

the operationId value

operationName

public LocalizableStringInner operationName()

Get the operation name.

Returns:

the operationName value

properties

public Map properties()

Get the set of <Key, Value> pairs (usually a Dictionary<String, String>) that includes details about the event.

Returns:

the properties value

resourceGroupName

public String resourceGroupName()

Get the resource group name of the impacted resource.

Returns:

the resourceGroupName value

resourceId

public String resourceId()

Get the resource uri that uniquely identifies the resource that caused this event.

Returns:

the resourceId value

resourceProviderName

public LocalizableStringInner resourceProviderName()

Get the resource provider name of the impacted resource.

Returns:

the resourceProviderName value

resourceType

public LocalizableStringInner resourceType()

Get the resource type.

Returns:

the resourceType value

status

public LocalizableStringInner status()

Get a string describing the status of the operation. Some typical values are: Started, In progress, Succeeded, Failed, Resolved.

Returns:

the status value

submissionTimestamp

public DateTime submissionTimestamp()

Get 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.

Returns:

the submissionTimestamp value

subscriptionId

public String subscriptionId()

Get the Azure subscription Id usually a GUID.

Returns:

the subscriptionId value

subStatus

public LocalizableStringInner subStatus()

Get 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).

Returns:

the subStatus value

tenantId

public String tenantId()

Get the Azure tenant Id.

Returns:

the tenantId value

Applies to