class Azure::Consumption::Mgmt::V2019_06_01::Models::ReservationSummary

reservation summary resource.

Attributes

avg_utilization_percentage[RW]

@return This is average utilization for the entire time range. (day or month depending on the grain)

kind[RW]

@return [String] The reservation kind.

max_utilization_percentage[RW]

@return This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.

min_utilization_percentage[RW]

@return This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day

purchased_quantity[RW]

@return This is the purchased quantity for the reservationId.

remaining_quantity[RW]

@return This is the remaining quantity for the reservationId.

reservation_id[RW]

@return [String] The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.

reservation_order_id[RW]

@return [String] The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.

reserved_hours[RW]

@return This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days

sku_name[RW]

@return [String] This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.

total_reserved_quantity[RW]

@return This is the total count of instances that are reserved for the reservationId.

usage_date[RW]

@return [DateTime] Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.

used_hours[RW]

@return Total used hours by the reservation

used_quantity[RW]

@return This is the used quantity for the reservationId.

utilized_percentage[RW]

@return This is the utilized percentage for the reservation Id.

Public Class Methods

mapper() click to toggle source

Mapper for ReservationSummary class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2019-06-01/generated/azure_mgmt_consumption/models/reservation_summary.rb, line 84
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ReservationSummary',
    type: {
      name: 'Composite',
      class_name: 'ReservationSummary',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        reservation_order_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservationOrderId',
          type: {
            name: 'String'
          }
        },
        reservation_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservationId',
          type: {
            name: 'String'
          }
        },
        sku_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.skuName',
          type: {
            name: 'String'
          }
        },
        reserved_hours: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.reservedHours',
          type: {
            name: 'Number'
          }
        },
        usage_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.usageDate',
          type: {
            name: 'DateTime'
          }
        },
        used_hours: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.usedHours',
          type: {
            name: 'Number'
          }
        },
        min_utilization_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.minUtilizationPercentage',
          type: {
            name: 'Number'
          }
        },
        avg_utilization_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.avgUtilizationPercentage',
          type: {
            name: 'Number'
          }
        },
        max_utilization_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.maxUtilizationPercentage',
          type: {
            name: 'Number'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.kind',
          type: {
            name: 'String'
          }
        },
        purchased_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.purchasedQuantity',
          type: {
            name: 'Number'
          }
        },
        remaining_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.remainingQuantity',
          type: {
            name: 'Number'
          }
        },
        total_reserved_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.totalReservedQuantity',
          type: {
            name: 'Number'
          }
        },
        used_quantity: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.usedQuantity',
          type: {
            name: 'Number'
          }
        },
        utilized_percentage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.utilizedPercentage',
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end