Class EventData

The Azure event log entries are of type EventData

Inheritance

Object

EventData

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Monitor.dll

Syntax

public class EventData

Constructors

EventData()

Initializes a new instance of the EventData class.

Declaration

public EventData ();

EventData(SenderAuthorization, IDictionary<String,String>, String, String, String, String, String, LocalizableString, LocalizableString, HttpRequestInfo, Nullable<EventLevel>, String, LocalizableString, String, LocalizableString, String, LocalizableString, IDictionary<String,String>, LocalizableString, LocalizableString, Nullable<DateTime>, Nullable<DateTime>, String, String)

Initializes a new instance of the EventData class.

Declaration

public EventData (Microsoft.Azure.Management.Monitor.Models.SenderAuthorization authorization = null, System.Collections.Generic.IDictionary<string,string> claims = null, string caller = null, string description = null, string id = null, string eventDataId = null, string correlationId = null, Microsoft.Azure.Management.Monitor.Models.LocalizableString eventName = null, Microsoft.Azure.Management.Monitor.Models.LocalizableString category = null, Microsoft.Azure.Management.Monitor.Models.HttpRequestInfo httpRequest = null, Nullable<Microsoft.Azure.Management.Monitor.Models.EventLevel> level = null, string resourceGroupName = null, Microsoft.Azure.Management.Monitor.Models.LocalizableString resourceProviderName = null, string resourceId = null, Microsoft.Azure.Management.Monitor.Models.LocalizableString resourceType = null, string operationId = null, Microsoft.Azure.Management.Monitor.Models.LocalizableString operationName = null, System.Collections.Generic.IDictionary<string,string> properties = null, Microsoft.Azure.Management.Monitor.Models.LocalizableString status = null, Microsoft.Azure.Management.Monitor.Models.LocalizableString subStatus = null, Nullable<DateTime> eventTimestamp = null, Nullable<DateTime> submissionTimestamp = null, string subscriptionId = null, string tenantId = null);

Parameters

SenderAuthorization authorization The sender authorization information.

IDictionary<String,String> claims key value pairs to identify ARM permissions.

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

String description the description of the event.

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

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

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.

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

LocalizableString category the event category.

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

Nullable<EventLevel> level the event level. Possible values include: 'Critical', 'Error', 'Warning', 'Informational', 'Verbose'

String resourceGroupName the resource group name of the impacted resource.

LocalizableString resourceProviderName the resource provider name of the impacted resource.

String resourceId the resource uri that uniquely identifies the resource that caused this event.

LocalizableString resourceType the resource type

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

LocalizableString operationName the operation name.

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

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

LocalizableString 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)

Nullable<DateTime> eventTimestamp the timestamp of when the event was generated by the Azure service processing the request corresponding the event. It in ISO 8601 format.

Nullable<DateTime> 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.

String subscriptionId the Azure subscription Id usually a GUID.

String tenantId the Azure tenant Id

Properties

Authorization

Gets the sender authorization information.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="authorization")]
public Microsoft.Azure.Management.Monitor.Models.SenderAuthorization Authorization { get; }

Property Value

SenderAuthorization

Caller

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="caller")]
public string Caller { get; }

Property Value

String

Category

Gets the event category.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="category")]
public Microsoft.Azure.Management.Monitor.Models.LocalizableString Category { get; }

Property Value

LocalizableString

Claims

Gets key value pairs to identify ARM permissions.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="claims")]
public System.Collections.Generic.IDictionary<string,string> Claims { get; }

Property Value

IDictionary<String,String>

CorrelationId

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="correlationId")]
public string CorrelationId { get; }

Property Value

String

Description

Gets the description of the event.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="description")]
public string Description { get; }

Property Value

String

EventDataId

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="eventDataId")]
public string EventDataId { get; }

Property Value

String

EventName

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="eventName")]
public Microsoft.Azure.Management.Monitor.Models.LocalizableString EventName { get; }

Property Value

LocalizableString

EventTimestamp

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="eventTimestamp")]
public Nullable<DateTime> EventTimestamp { get; }

Property Value

Nullable<DateTime>

HttpRequest

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="httpRequest")]
public Microsoft.Azure.Management.Monitor.Models.HttpRequestInfo HttpRequest { get; }

Property Value

HttpRequestInfo

Id

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="id")]
public string Id { get; }

Property Value

String

Level

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="level")]
public Nullable<Microsoft.Azure.Management.Monitor.Models.EventLevel> Level { get; }

Property Value

Nullable<EventLevel>

OperationId

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="operationId")]
public string OperationId { get; }

Property Value

String

OperationName

Gets the operation name.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="operationName")]
public Microsoft.Azure.Management.Monitor.Models.LocalizableString OperationName { get; }

Property Value

LocalizableString

Properties

Gets the set of &lt;Key, Value&gt; pairs (usually a Dictionary&lt;String, String&gt;) that includes details about the event.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="properties")]
public System.Collections.Generic.IDictionary<string,string> Properties { get; }

Property Value

IDictionary<String,String>

ResourceGroupName

Gets the resource group name of the impacted resource.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="resourceGroupName")]
public string ResourceGroupName { get; }

Property Value

String

ResourceId

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="resourceId")]
public string ResourceId { get; }

Property Value

String

ResourceProviderName

Gets the resource provider name of the impacted resource.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="resourceProviderName")]
public Microsoft.Azure.Management.Monitor.Models.LocalizableString ResourceProviderName { get; }

Property Value

LocalizableString

ResourceType

Gets the resource type

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="resourceType")]
public Microsoft.Azure.Management.Monitor.Models.LocalizableString ResourceType { get; }

Property Value

LocalizableString

Status

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="status")]
public Microsoft.Azure.Management.Monitor.Models.LocalizableString Status { get; }

Property Value

LocalizableString

SubmissionTimestamp

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

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="submissionTimestamp")]
public Nullable<DateTime> SubmissionTimestamp { get; }

Property Value

Nullable<DateTime>

SubscriptionId

Gets the Azure subscription Id usually a GUID.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="subscriptionId")]
public string SubscriptionId { get; }

Property Value

String

SubStatus

Gets 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)

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="subStatus")]
public Microsoft.Azure.Management.Monitor.Models.LocalizableString SubStatus { get; }

Property Value

LocalizableString

TenantId

Gets the Azure tenant Id

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="tenantId")]
public string TenantId { get; }

Property Value

String

Methods

Validate()

Validate the object.

Declaration

public virtual void Validate ();

Exceptions

ValidationException Thrown if validation fails