Class BillingReservationData

A class representing the BillingReservation data model. The definition of the reservation.

Inheritance
Azure.ResourceManager.Models.TrackedResourceData
BillingReservationData
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.Billing.dll
Syntax
public class BillingReservationData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Billing.BillingReservationData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Billing.BillingReservationData>

Constructors

BillingReservationData(AzureLocation)

Initializes a new instance of BillingReservationData.

Declaration
public BillingReservationData (Azure.Core.AzureLocation location);
Parameters
Azure.Core.AzureLocation location

The location.

Properties

Aggregates

The array of aggregates of a reservation's utilization.

Declaration
public System.Collections.Generic.IList<Azure.ResourceManager.Billing.Models.ReservationUtilizationAggregates> Aggregates { get; }
Property Value
System.Collections.Generic.IList<ReservationUtilizationAggregates>

AppliedScopeProperties

Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup.

Declaration
public Azure.ResourceManager.Billing.Models.ReservationAppliedScopeProperties AppliedScopeProperties { get; set; }
Property Value
ReservationAppliedScopeProperties

AppliedScopes

The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope.

Declaration
public System.Collections.Generic.IList<string> AppliedScopes { get; }
Property Value
System.Collections.Generic.IList<System.String>

AppliedScopeType

The applied scope type of the reservation.

Declaration
public string AppliedScopeType { get; }
Property Value
System.String

BenefitStartOn

This is the DateTime when the reservation benefit started.

Declaration
public Nullable<DateTimeOffset> BenefitStartOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

BillingPlan

The billing plan options available for this sku.

Declaration
public Nullable<Azure.ResourceManager.Billing.Models.ReservationBillingPlan> BillingPlan { get; set; }
Property Value
System.Nullable<ReservationBillingPlan>

BillingScopeId

Subscription that will be charged for purchasing reservation or savings plan.

Declaration
public string BillingScopeId { get; }
Property Value
System.String

Capabilities

Capabilities of the reservation.

Declaration
public string Capabilities { get; set; }
Property Value
System.String

DisplayName

The display name of the reservation.

Declaration
public string DisplayName { get; }
Property Value
System.String

DisplayProvisioningState

The provisioning state of the reservation for display, e.g. Succeeded.

Declaration
public string DisplayProvisioningState { get; }
Property Value
System.String

EffectiveOn

The effective date time of the reservation.

Declaration
public Nullable<DateTimeOffset> EffectiveOn { get; }
Property Value
System.Nullable<System.DateTimeOffset>

ETag

Gets or sets the e tag.

Declaration
public Nullable<int> ETag { get; set; }
Property Value
System.Nullable<System.Int32>

ExpireOn

The expiry date of the reservation.

Declaration
public Nullable<DateTimeOffset> ExpireOn { get; }
Property Value
System.Nullable<System.DateTimeOffset>

ExtendedStatusInfo

The message giving detailed information about the status code.

Declaration
public Azure.ResourceManager.Billing.Models.ReservationExtendedStatusInfo ExtendedStatusInfo { get; set; }
Property Value
ReservationExtendedStatusInfo

InstanceFlexibility

Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.

Declaration
public Nullable<Azure.ResourceManager.Billing.Models.InstanceFlexibility> InstanceFlexibility { get; set; }
Property Value
System.Nullable<InstanceFlexibility>

IsArchived

Indicates if the reservation is archived.

Declaration
public Nullable<bool> IsArchived { get; set; }
Property Value
System.Nullable<System.Boolean>

IsRenewed

The renew state of the reservation.

Declaration
public Nullable<bool> IsRenewed { get; }
Property Value
System.Nullable<System.Boolean>

LastUpdatedOn

DateTime of the last time the reservation was updated.

Declaration
public Nullable<DateTimeOffset> LastUpdatedOn { get; }
Property Value
System.Nullable<System.DateTimeOffset>

MergeProperties

Properties of reservation merge.

Declaration
public Azure.ResourceManager.Billing.Models.ReservationMergeProperties MergeProperties { get; set; }
Property Value
ReservationMergeProperties

ProductCode

Represents UPN.

Declaration
public string ProductCode { get; set; }
Property Value
System.String

ProvisioningState

The provisioning state of the reservation, e.g. Succeeded.

Declaration
public string ProvisioningState { get; }
Property Value
System.String

ProvisioningSubState

The provisioning state of the reservation, e.g. Succeeded.

Declaration
public string ProvisioningSubState { get; }
Property Value
System.String

PurchaseOn

This is the date when the reservation was purchased.

Declaration
public Nullable<DateTimeOffset> PurchaseOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

Quantity

The number of the reservation.

Declaration
public Nullable<float> Quantity { get; }
Property Value
System.Nullable<System.Single>

RenewDestination

Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

Declaration
public string RenewDestination { get; set; }
Property Value
System.String

RenewProperties

The renew properties for a reservation.

Declaration
public Azure.ResourceManager.Billing.Models.ReservationRenewProperties RenewProperties { get; set; }
Property Value
ReservationRenewProperties

RenewSource

The renew source of the reservation.

Declaration
public string RenewSource { get; }
Property Value
System.String

ReservationExpireOn

This is the date-time when the reservation will expire.

Declaration
public Nullable<DateTimeOffset> ReservationExpireOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

ReservationPurchaseOn

This is the date-time when the reservation was purchased.

Declaration
public Nullable<DateTimeOffset> ReservationPurchaseOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

ReservedResourceType

The reserved source type of the reservation, e.g. virtual machine.

Declaration
public string ReservedResourceType { get; }
Property Value
System.String

ReviewOn

This is the date-time when the Azure Hybrid Benefit needs to be reviewed.

Declaration
public Nullable<DateTimeOffset> ReviewOn { get; set; }
Property Value
System.Nullable<System.DateTimeOffset>

SkuDescription

The sku description of the reservation.

Declaration
public string SkuDescription { get; }
Property Value
System.String

SkuName

The name of the reservation sku.

Declaration
public string SkuName { get; }
Property Value
System.String

SplitProperties

Properties of reservation split.

Declaration
public Azure.ResourceManager.Billing.Models.ReservationSplitProperties SplitProperties { get; set; }
Property Value
ReservationSplitProperties

SwapProperties

Properties of reservation swap.

Declaration
public Azure.ResourceManager.Billing.Models.ReservationSwapProperties SwapProperties { get; set; }
Property Value
ReservationSwapProperties

Term

The term of the reservation, e.g. P1Y.

Declaration
public string Term { get; }
Property Value
System.String

Trend

last 7 day utilization trend for a reservation.

Declaration
public string Trend { get; }
Property Value
System.String

UserFriendlyAppliedScopeType

The applied scope type of the reservation for display, e.g. Shared.

Declaration
public string UserFriendlyAppliedScopeType { get; }
Property Value
System.String

UserFriendlyRenewState

The renew state of the reservation for display, e.g. On.

Declaration
public string UserFriendlyRenewState { get; }
Property Value
System.String

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected override void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<BillingReservationData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.Billing.BillingReservationData IJsonModel<BillingReservationData>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
BillingReservationData

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<BillingReservationData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<BillingReservationData>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BillingReservationData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.Billing.BillingReservationData IPersistableModel<BillingReservationData>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
BillingReservationData

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BillingReservationData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<BillingReservationData>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<BillingReservationData>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<BillingReservationData>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.