ArmApiManagementModelFactory.ReportRecordContract Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement.Models

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ArmApiManagementModelFactory.cs

Initializes a new instance of ReportRecordContract.

public static Azure.ResourceManager.ApiManagement.Models.ReportRecordContract ReportRecordContract (string name = default, DateTimeOffset? timestamp = default, string interval = default, string country = default, string region = default, string zip = default, string userId = default, string productId = default, string apiId = default, string operationId = default, string apiRegion = default, Azure.Core.ResourceIdentifier subscriptionResourceId = default, int? callCountSuccess = default, int? callCountBlocked = default, int? callCountFailed = default, int? callCountOther = default, int? callCountTotal = default, long? bandwidth = default, int? cacheHitCount = default, int? cacheMissCount = default, double? apiTimeAvg = default, double? apiTimeMin = default, double? apiTimeMax = default, double? serviceTimeAvg = default, double? serviceTimeMin = default, double? serviceTimeMax = default);

static member ReportRecordContract : string * Nullable<DateTimeOffset> * string * string * string * string * string * string * string * string * string * Azure.Core.ResourceIdentifier * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int64> * Nullable<int> * Nullable<int> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> -> Azure.ResourceManager.ApiManagement.Models.ReportRecordContract

Public Shared Function ReportRecordContract (Optional name As String = Nothing, Optional timestamp As Nullable(Of DateTimeOffset) = Nothing, Optional interval As String = Nothing, Optional country As String = Nothing, Optional region As String = Nothing, Optional zip As String = Nothing, Optional userId As String = Nothing, Optional productId As String = Nothing, Optional apiId As String = Nothing, Optional operationId As String = Nothing, Optional apiRegion As String = Nothing, Optional subscriptionResourceId As ResourceIdentifier = Nothing, Optional callCountSuccess As Nullable(Of Integer) = Nothing, Optional callCountBlocked As Nullable(Of Integer) = Nothing, Optional callCountFailed As Nullable(Of Integer) = Nothing, Optional callCountOther As Nullable(Of Integer) = Nothing, Optional callCountTotal As Nullable(Of Integer) = Nothing, Optional bandwidth As Nullable(Of Long) = Nothing, Optional cacheHitCount As Nullable(Of Integer) = Nothing, Optional cacheMissCount As Nullable(Of Integer) = Nothing, Optional apiTimeAvg As Nullable(Of Double) = Nothing, Optional apiTimeMin As Nullable(Of Double) = Nothing, Optional apiTimeMax As Nullable(Of Double) = Nothing, Optional serviceTimeAvg As Nullable(Of Double) = Nothing, Optional serviceTimeMin As Nullable(Of Double) = Nothing, Optional serviceTimeMax As Nullable(Of Double) = Nothing) As ReportRecordContract

Parameters

name

String

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

timestamp

Nullable<DateTimeOffset>

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

interval

String

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

country

String

Country to which this record data is related.

region

String

Country region to which this record data is related.

zip

String

Zip code to which this record data is related.

userId

String

User identifier path. /users/{userId}.

productId

String

Product identifier path. /products/{productId}.

apiId

String

API identifier path. /apis/{apiId}.

operationId

String

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

apiRegion

String

API region identifier.

subscriptionResourceId

ResourceIdentifier

Subscription identifier path. /subscriptions/{subscriptionId}.

callCountSuccess

Nullable<Int32>

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

callCountBlocked

Nullable<Int32>

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

callCountFailed

Nullable<Int32>

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

callCountOther

Nullable<Int32>

Number of other calls.

callCountTotal

Nullable<Int32>

Total number of calls.

bandwidth

Nullable<Int64>

Bandwidth consumed.

cacheHitCount

Nullable<Int32>

Number of times when content was served from cache policy.

cacheMissCount

Nullable<Int32>

Number of times content was fetched from backend.

apiTimeAvg

Nullable<Double>

Average time it took to process request.

apiTimeMin

Nullable<Double>

Minimum time it took to process request.

apiTimeMax

Nullable<Double>

Maximum time it took to process request.

serviceTimeAvg

Nullable<Double>

Average time it took to process request on backend.

serviceTimeMin

Nullable<Double>

Minimum time it took to process request on backend.

serviceTimeMax

Nullable<Double>

Maximum time it took to process request on backend.

Returns

ReportRecordContract

A new ReportRecordContract instance for mocking.