CapacityReservationInner Class

public final class CapacityReservationInner
extends Resource

Specifies information about the capacity reservation.

Constructor Summary

Constructor Description
CapacityReservationInner()

Creates an instance of CapacityReservationInner class.

Method Summary

Modifier and Type Method and Description
static CapacityReservationInner fromJson(JsonReader jsonReader)

Reads an instance of CapacityReservationInner from the JsonReader.

String id()

Get the id property: Fully qualified resource Id for the resource.

CapacityReservationInstanceView instanceView()

Get the instanceView property: The Capacity reservation instance view.

String name()

Get the name property: The name of the resource.

Integer platformFaultDomainCount()

Get the platformFaultDomainCount property: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size.

String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response.

OffsetDateTime provisioningTime()

Get the provisioningTime property: The date time when the capacity reservation was last updated.

String reservationId()

Get the reservationId property: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.

Sku sku()

Get the sku property: SKU of the resource for which capacity needs be reserved.

OffsetDateTime timeCreated()

Get the timeCreated property: Specifies the time at which the Capacity Reservation resource was created.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

void validate()

Validates the instance.

List<SubResourceReadOnly> virtualMachinesAssociated()

Get the virtualMachinesAssociated property: A list of all virtual machine resource ids that are associated with the capacity reservation.

CapacityReservationInner withLocation(String location)
CapacityReservationInner withSku(Sku sku)

Set the sku property: SKU of the resource for which capacity needs be reserved.

CapacityReservationInner withTags(Map<String,String> tags)
CapacityReservationInner withZones(List<String> zones)

Set the zones property: Availability Zone to use for this capacity reservation.

List<String> zones()

Get the zones property: Availability Zone to use for this capacity reservation.

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

CapacityReservationInner

public CapacityReservationInner()

Creates an instance of CapacityReservationInner class.

Method Details

fromJson

public static CapacityReservationInner fromJson(JsonReader jsonReader)

Reads an instance of CapacityReservationInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CapacityReservationInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

CapacityReservationInner.id()

Returns:

the id value.

instanceView

public CapacityReservationInstanceView instanceView()

Get the instanceView property: The Capacity reservation instance view.

Returns:

the instanceView value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

CapacityReservationInner.name()

Returns:

the name value.

platformFaultDomainCount

public Integer platformFaultDomainCount()

Get the platformFaultDomainCount property: Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. **Note:** The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01.

Returns:

the platformFaultDomainCount value.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response.

Returns:

the provisioningState value.

provisioningTime

public OffsetDateTime provisioningTime()

Get the provisioningTime property: The date time when the capacity reservation was last updated.

Returns:

the provisioningTime value.

reservationId

public String reservationId()

Get the reservationId property: A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.

Returns:

the reservationId value.

sku

public Sku sku()

Get the sku property: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.

Returns:

the sku value.

timeCreated

public OffsetDateTime timeCreated()

Get the timeCreated property: Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.

Returns:

the timeCreated value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

CapacityReservationInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

CapacityReservationInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

virtualMachinesAssociated

public List virtualMachinesAssociated()

Get the virtualMachinesAssociated property: A list of all virtual machine resource ids that are associated with the capacity reservation.

Returns:

the virtualMachinesAssociated value.

withLocation

public CapacityReservationInner withLocation(String location)

Overrides:

CapacityReservationInner.withLocation(String location)

Parameters:

location

withSku

public CapacityReservationInner withSku(Sku sku)

Set the sku property: SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.

Parameters:

sku - the sku value to set.

Returns:

the CapacityReservationInner object itself.

withTags

public CapacityReservationInner withTags(Map tags)

Overrides:

CapacityReservationInner.withTags(Map<String,String> tags)

Parameters:

tags

withZones

public CapacityReservationInner withZones(List zones)

Set the zones property: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone.

Parameters:

zones - the zones value to set.

Returns:

the CapacityReservationInner object itself.

zones

public List zones()

Get the zones property: Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone.

Returns:

the zones value.

Applies to