Reservation Class

The definition of the reservation.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

Reservation(*, location: str | None = None, etag: int | None = None, tags: Dict[str, str] | None = None, sku: _models.ReservationSkuProperty | None = None, instance_flexibility: str | _models.InstanceFlexibility | None = None, applied_scopes: List[str] | None = None, archived: bool | None = None, capabilities: str | None = None, benefit_start_time: datetime | None = None, expiry_date_time: datetime | None = None, review_date_time: datetime | None = None, extended_status_info: _models.ReservationExtendedStatusInfo | None = None, billing_plan: str | _models.ReservationBillingPlan | None = None, purchase_date: date | None = None, purchase_date_time: datetime | None = None, split_properties: _models.ReservationSplitProperties | None = None, merge_properties: _models.ReservationMergeProperties | None = None, swap_properties: _models.ReservationSwapProperties | None = None, applied_scope_properties: _models.ReservationAppliedScopeProperties | None = None, renew_destination: str | None = None, renew_properties: _models.RenewPropertiesResponse | None = None, product_code: str | None = None, aggregates: List[_models.ReservationUtilizationAggregates] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str The location of the reservation. Default value: None
etag	int Default value: None
tags	dict[str, str] Tags for this reservation. Default value: None
sku	ReservationSkuProperty The sku information associated to this reservation. Default value: None
instance_flexibility	str or InstanceFlexibility Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. Known values are: "On" and "Off". Default value: None
applied_scopes	list[str] The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope. Default value: None
archived	bool Indicates if the reservation is archived. Default value: None
capabilities	str Capabilities of the reservation. Default value: None
benefit_start_time	datetime This is the DateTime when the reservation benefit started. Default value: None
expiry_date_time	datetime This is the date-time when the reservation will expire. Default value: None
review_date_time	datetime This is the date-time when the Azure Hybrid Benefit needs to be reviewed. Default value: None
extended_status_info	ReservationExtendedStatusInfo The message giving detailed information about the status code. Default value: None
billing_plan	str or ReservationBillingPlan The billing plan options available for this sku. Known values are: "Upfront" and "Monthly". Default value: None
purchase_date	date This is the date when the reservation was purchased. Default value: None
purchase_date_time	datetime This is the date-time when the reservation was purchased. Default value: None
split_properties	ReservationSplitProperties Properties of reservation split. Default value: None
merge_properties	ReservationMergeProperties Properties of reservation merge. Default value: None
swap_properties	ReservationSwapProperties Properties of reservation swap. Default value: None
applied_scope_properties	ReservationAppliedScopeProperties Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup. Default value: None
renew_destination	str Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}. Default value: None
renew_properties	RenewPropertiesResponse The renew properties for a reservation. Default value: None
product_code	str Represents UPN. Default value: None
aggregates	list[ReservationUtilizationAggregates] The array of aggregates of a reservation's utilization. Default value: None

Variables

Name	Description
id	str Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	str The name of the resource.
type	str The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
system_data	SystemData Azure Resource Manager metadata containing createdBy and modifiedBy information.
location	str The location of the reservation.
etag	int
tags	dict[str, str] Tags for this reservation.
sku	ReservationSkuProperty The sku information associated to this reservation.
reserved_resource_type	str The reserved source type of the reservation, e.g. virtual machine.
instance_flexibility	str or InstanceFlexibility Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility. Known values are: "On" and "Off".
display_name	str The display name of the reservation.
applied_scopes	list[str] The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope.
applied_scope_type	str The applied scope type of the reservation.
archived	bool Indicates if the reservation is archived.
capabilities	str Capabilities of the reservation.
quantity	float The number of the reservation.
provisioning_state	str The provisioning state of the reservation, e.g. Succeeded.
effective_date_time	datetime The effective date time of the reservation.
benefit_start_time	datetime This is the DateTime when the reservation benefit started.
last_updated_date_time	datetime DateTime of the last time the reservation was updated.
expiry_date	str The expiry date of the reservation.
expiry_date_time	datetime This is the date-time when the reservation will expire.
review_date_time	datetime This is the date-time when the Azure Hybrid Benefit needs to be reviewed.
sku_description	str The sku description of the reservation.
extended_status_info	ReservationExtendedStatusInfo The message giving detailed information about the status code.
billing_plan	str or ReservationBillingPlan The billing plan options available for this sku. Known values are: "Upfront" and "Monthly".
display_provisioning_state	str The provisioning state of the reservation for display, e.g. Succeeded.
provisioning_sub_state	str The provisioning state of the reservation, e.g. Succeeded.
purchase_date	date This is the date when the reservation was purchased.
purchase_date_time	datetime This is the date-time when the reservation was purchased.
split_properties	ReservationSplitProperties Properties of reservation split.
merge_properties	ReservationMergeProperties Properties of reservation merge.
swap_properties	ReservationSwapProperties Properties of reservation swap.
applied_scope_properties	ReservationAppliedScopeProperties Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup.
billing_scope_id	str Subscription that will be charged for purchasing reservation or savings plan.
renew	bool The renew state of the reservation.
renew_source	str The renew source of the reservation.
renew_destination	str Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renew_properties	RenewPropertiesResponse The renew properties for a reservation.
term	str The term of the reservation, e.g. P1Y.
user_friendly_applied_scope_type	str The applied scope type of the reservation for display, e.g. Shared.
user_friendly_renew_state	str The renew state of the reservation for display, e.g. On.
product_code	str Represents UPN.
trend	str last 7 day utilization trend for a reservation.
aggregates	list[ReservationUtilizationAggregates] The array of aggregates of a reservation's utilization.