ReportRecordContract Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement.Models
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.1.0
Package:
Azure.ResourceManager.ApiManagement v1.2.0-beta.1
Source:
ReportRecordContract.cs
Source:
ReportRecordContract.cs

Report data.

public class ReportRecordContract
public class ReportRecordContract : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.ReportRecordContract>
type ReportRecordContract = class
type ReportRecordContract = class
    interface IJsonModel<ReportRecordContract>
    interface IPersistableModel<ReportRecordContract>
Public Class ReportRecordContract
Public Class ReportRecordContract
Implements IJsonModel(Of ReportRecordContract), IPersistableModel(Of ReportRecordContract)
Inheritance
Object
ReportRecordContract
Implements
IJsonModel<ReportRecordContract> IPersistableModel<ReportRecordContract> IPersistableModel<T>

Properties

ApiId

API identifier path. /apis/{apiId}.
ApiRegion

API region identifier.
ApiTimeAvg

Average time it took to process request.
ApiTimeMax

Maximum time it took to process request.
ApiTimeMin

Minimum time it took to process request.
Bandwidth

Bandwidth consumed.
CacheHitCount

Number of times when content was served from cache policy.
CacheMissCount

Number of times content was fetched from backend.
CallCountBlocked

Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests.
CallCountFailed

Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600.
CallCountOther

Number of other calls.
CallCountSuccess

Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect.
CallCountTotal

Total number of calls.
Country

Country to which this record data is related.
Interval

Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
Name

Name depending on report endpoint specifies product, API, operation or developer name.
OperationId

Operation identifier path. /apis/{apiId}/operations/{operationId}.
ProductId

Product identifier path. /products/{productId}.
Region

Country region to which this record data is related.
ServiceTimeAvg

Average time it took to process request on backend.
ServiceTimeMax

Maximum time it took to process request on backend.
ServiceTimeMin

Minimum time it took to process request on backend.
SubscriptionResourceId

Subscription identifier path. /subscriptions/{subscriptionId}.
Timestamp

Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
UserId

User identifier path. /users/{userId}.
Zip

Zip code to which this record data is related.

Explicit Interface Implementations

IJsonModel<ReportRecordContract>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ReportRecordContract>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ReportRecordContract>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ReportRecordContract>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ReportRecordContract>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to