azure.mgmt.reservations.models module

exception azure.mgmt.reservations.models.ErrorException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘Error’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

exception azure.mgmt.reservations.models.ExceptionResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ExceptionResponse’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

class azure.mgmt.reservations.models.AppliedReservationList(*, value=None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

AppliedReservationList.

Parameters

  • value (list[str]) –

  • next_link (str) – Url to get the next page of reservations

class azure.mgmt.reservations.models.AppliedReservations(*, reservation_order_ids=None, **kwargs)[source]

Bases: msrest.serialization.Model

AppliedReservations.

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

Variables

  • id (str) – Identifier of the applied reservations

  • name (str) – Name of resource

  • type (str) – Type of resource. “Microsoft.Capacity/AppliedReservations”

Parameters

reservation_order_ids (AppliedReservationList) –

class azure.mgmt.reservations.models.AvailableScopeProperties(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

AvailableScopeProperties.

Parameters

properties (SubscriptionScopeProperties) –

class azure.mgmt.reservations.models.AvailableScopeRequest(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Available scope.

Parameters

properties (AvailableScopeRequestProperties) –

class azure.mgmt.reservations.models.AvailableScopeRequestProperties(*, scopes=None, **kwargs)[source]

Bases: msrest.serialization.Model

Available scope request properties.

Parameters

scopes (list[str]) –

class azure.mgmt.reservations.models.BillingInformation(*, billing_currency_total_paid_amount=None, billing_currency_prorated_amount=None, billing_currency_remaining_commitment_amount=None, **kwargs)[source]

Bases: msrest.serialization.Model

billing information.

Parameters

  • billing_currency_total_paid_amount (Price) –

  • billing_currency_prorated_amount (Price) –

  • billing_currency_remaining_commitment_amount (Price) –

class azure.mgmt.reservations.models.CalculateExchangeOperationResultResponse(*, id: str = None, name: str = None, status=None, properties=None, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

CalculateExchange operation result.

Parameters
class azure.mgmt.reservations.models.CalculateExchangeRequest(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Calculate exchange request.

Parameters

properties (CalculateExchangeRequestProperties) –

class azure.mgmt.reservations.models.CalculateExchangeRequestProperties(*, reservations_to_purchase=None, reservations_to_exchange=None, **kwargs)[source]

Bases: msrest.serialization.Model

Calculate exchange request properties.

Parameters

  • reservations_to_purchase (list[PurchaseRequest]) – List of reservations that are being purchased in this exchange.

  • reservations_to_exchange (list[ReservationToReturn]) – List of reservations that are being returned in this exchange.

class azure.mgmt.reservations.models.CalculateExchangeResponseProperties(*, session_id: str = None, net_payable=None, refunds_total=None, purchases_total=None, reservations_to_purchase=None, reservations_to_exchange=None, policy_result=None, **kwargs)[source]

Bases: msrest.serialization.Model

CalculateExchange response properties.

Parameters
class azure.mgmt.reservations.models.CalculatePriceResponse(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

CalculatePriceResponse.

Parameters

properties (CalculatePriceResponseProperties) –

class azure.mgmt.reservations.models.CalculatePriceResponseProperties(*, billing_currency_total=None, is_billing_partner_managed: bool = None, reservation_order_id: str = None, sku_title: str = None, sku_description: str = None, pricing_currency_total=None, payment_schedule=None, **kwargs)[source]

Bases: msrest.serialization.Model

CalculatePriceResponseProperties.

Parameters

  • billing_currency_total (CalculatePriceResponsePropertiesBillingCurrencyTotal) – Currency and amount that customer will be charged in customer’s local currency. Tax is not included.

  • is_billing_partner_managed (bool) – True if billing is managed by Microsoft Partner. Used only for CSP accounts.

  • reservation_order_id (str) – GUID that represents reservation order that can be placed after calculating price.

  • sku_title (str) – Title of SKU that is being purchased.

  • sku_description (str) – Description of SKU that is being purchased.

  • pricing_currency_total (CalculatePriceResponsePropertiesPricingCurrencyTotal) – Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included.

  • payment_schedule (list[PaymentDetail]) –

class azure.mgmt.reservations.models.CalculatePriceResponsePropertiesBillingCurrencyTotal(*, currency_code: str = None, amount: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Currency and amount that customer will be charged in customer’s local currency. Tax is not included.

Parameters

  • currency_code (str) –

  • amount (float) –

class azure.mgmt.reservations.models.CalculatePriceResponsePropertiesPricingCurrencyTotal(*, currency_code: str = None, amount: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included.

Parameters

  • currency_code (str) –

  • amount (float) –

class azure.mgmt.reservations.models.Catalog(*, billing_plans=None, **kwargs)[source]

Bases: msrest.serialization.Model

Catalog.

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

Variables
Parameters

billing_plans (dict[str, list[str or ReservationBillingPlan]]) – The billing plan options available for this SKU.

class azure.mgmt.reservations.models.CreateGenericQuotaRequestParameters(*, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

Quota change requests information.

Parameters

value (list[CurrentQuotaLimitBase]) – Quota change requests.

class azure.mgmt.reservations.models.CurrentQuotaLimit(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Current quota limits.

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

Parameters

properties (QuotaProperties) – Quota properties for the resource.

Variables

  • provisioning_state (object) – The details of the quota request status.

  • message (str) – A user friendly message.

class azure.mgmt.reservations.models.CurrentQuotaLimitBase(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Quota properties.

Parameters

properties (QuotaProperties) – Quota properties for the resource.

class azure.mgmt.reservations.models.Error(*, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

Error.

Parameters

error (ExtendedErrorInfo) –

class azure.mgmt.reservations.models.ExceptionResponse(*, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

The API error.

Parameters

error (ServiceError) – The API error details.

class azure.mgmt.reservations.models.ExchangeOperationResultResponse(*, id: str = None, name: str = None, status=None, properties=None, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

Exchange operation result.

Parameters

  • id (str) – It should match what is used to GET the operation result.

  • name (str) – It must match the last segment of the id field, and will typically be a GUID / system generated value.

  • status (str or ExchangeOperationResultStatus) – Status of the operation. Possible values include: ‘Succeeded’, ‘Failed’, ‘Cancelled’, ‘PendingRefunds’, ‘PendingPurchases’

  • properties (ExchangeResponseProperties) –

  • error (OperationResultError) –

class azure.mgmt.reservations.models.ExchangePolicyError(*, code: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

error details.

Parameters

  • code (str) –

  • message (str) –

class azure.mgmt.reservations.models.ExchangePolicyErrors(*, policy_errors=None, **kwargs)[source]

Bases: msrest.serialization.Model

Exchange policy errors.

Parameters

policy_errors (list[ExchangePolicyError]) – Exchange Policy errors

class azure.mgmt.reservations.models.ExchangeRequest(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Exchange request.

Parameters

properties (ExchangeRequestProperties) –

class azure.mgmt.reservations.models.ExchangeRequestProperties(*, session_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Exchange request properties.

Parameters

session_id (str) – SessionId that was returned by CalculateExchange API.

class azure.mgmt.reservations.models.ExchangeResponseProperties(*, session_id: str = None, net_payable=None, refunds_total=None, purchases_total=None, reservations_to_purchase=None, reservations_to_exchange=None, policy_result=None, **kwargs)[source]

Bases: msrest.serialization.Model

Exchange response properties.

Parameters
class azure.mgmt.reservations.models.ExtendedErrorInfo(*, code=None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

ExtendedErrorInfo.

Parameters

  • code (str or ErrorResponseCode) – Possible values include: ‘NotSpecified’, ‘InternalServerError’, ‘ServerTimeout’, ‘AuthorizationFailed’, ‘BadRequest’, ‘ClientCertificateThumbprintNotSet’, ‘InvalidRequestContent’, ‘OperationFailed’, ‘HttpMethodNotSupported’, ‘InvalidRequestUri’, ‘MissingTenantId’, ‘InvalidTenantId’, ‘InvalidReservationOrderId’, ‘InvalidReservationId’, ‘ReservationIdNotInReservationOrder’, ‘ReservationOrderNotFound’, ‘InvalidSubscriptionId’, ‘InvalidAccessToken’, ‘InvalidLocationId’, ‘UnauthenticatedRequestsThrottled’, ‘InvalidHealthCheckType’, ‘Forbidden’, ‘BillingScopeIdCannotBeChanged’, ‘AppliedScopesNotAssociatedWithCommerceAccount’, ‘PatchValuesSameAsExisting’, ‘RoleAssignmentCreationFailed’, ‘ReservationOrderCreationFailed’, ‘ReservationOrderNotEnabled’, ‘CapacityUpdateScopesFailed’, ‘UnsupportedReservationTerm’, ‘ReservationOrderIdAlreadyExists’, ‘RiskCheckFailed’, ‘CreateQuoteFailed’, ‘ActivateQuoteFailed’, ‘NonsupportedAccountId’, ‘PaymentInstrumentNotFound’, ‘MissingAppliedScopesForSingle’, ‘NoValidReservationsToReRate’, ‘ReRateOnlyAllowedForEA’, ‘OperationCannotBePerformedInCurrentState’, ‘InvalidSingleAppliedScopesCount’, ‘InvalidFulfillmentRequestParameters’, ‘NotSupportedCountry’, ‘InvalidRefundQuantity’, ‘PurchaseError’, ‘BillingCustomerInputError’, ‘BillingPaymentInstrumentSoftError’, ‘BillingPaymentInstrumentHardError’, ‘BillingTransientError’, ‘BillingError’, ‘FulfillmentConfigurationError’, ‘FulfillmentOutOfStockError’, ‘FulfillmentTransientError’, ‘FulfillmentError’, ‘CalculatePriceFailed’

  • message (str) –

class azure.mgmt.reservations.models.ExtendedStatusInfo(*, status_code=None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

ExtendedStatusInfo.

Parameters

  • status_code (str or ReservationStatusCode) – Possible values include: ‘None’, ‘Pending’, ‘Active’, ‘PurchaseError’, ‘PaymentInstrumentError’, ‘Split’, ‘Merged’, ‘Expired’, ‘Succeeded’

  • message (str) – The message giving detailed information about the status code.

class azure.mgmt.reservations.models.MergeRequest(*, sources=None, **kwargs)[source]

Bases: msrest.serialization.Model

MergeRequest.

Parameters

sources (list[str]) – Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

class azure.mgmt.reservations.models.OperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

OperationDisplay.

Parameters

  • provider (str) –

  • resource (str) –

  • operation (str) –

  • description (str) –

class azure.mgmt.reservations.models.OperationResponse(*, name: str = None, display=None, origin: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

OperationResponse.

Parameters
class azure.mgmt.reservations.models.OperationResultError(*, code: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Required if status == failed or status == canceled.

Parameters

  • code (str) – Required if status == failed or status == cancelled. If status == failed, provide an invariant error code used for error troubleshooting, aggregation, and analysis.

  • message (str) – Required if status == failed. Localized. If status == failed, provide an actionable error message indicating what error occurred, and what the user can do to address the issue.

class azure.mgmt.reservations.models.Patch(*, applied_scope_type=None, applied_scopes=None, instance_flexibility=None, name: str = None, renew: bool = None, renew_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Patch.

Parameters
class azure.mgmt.reservations.models.PatchPropertiesRenewProperties(*, purchase_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

PatchPropertiesRenewProperties.

Parameters

purchase_properties (PurchaseRequest) –

class azure.mgmt.reservations.models.PaymentDetail(*, due_date=None, payment_date=None, pricing_currency_total=None, billing_currency_total=None, billing_account: str = None, status=None, extended_status_info=None, **kwargs)[source]

Bases: msrest.serialization.Model

Information about payment related to a reservation order.

Parameters

  • due_date (date) – Date when the payment needs to be done.

  • payment_date (date) – Date when the transaction is completed. Is null when it is scheduled.

  • pricing_currency_total (Price) – Amount in pricing currency. Tax not included.

  • billing_currency_total (Price) – Amount charged in Billing currency. Tax not included. Is null for future payments

  • billing_account (str) – Shows the Account that is charged for this payment.

  • status (str or PaymentStatus) – Possible values include: ‘Succeeded’, ‘Failed’, ‘Scheduled’, ‘Cancelled’

  • extended_status_info (ExtendedStatusInfo) –

class azure.mgmt.reservations.models.Price(*, currency_code: str = None, amount: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Price.

Parameters

  • currency_code (str) – The ISO 4217 3-letter currency code for the currency used by this purchase record.

  • amount (float) –

class azure.mgmt.reservations.models.PurchaseRequest(*, sku=None, location: str = None, reserved_resource_type=None, billing_scope_id: str = None, term=None, billing_plan=None, quantity: int = None, display_name: str = None, applied_scope_type=None, applied_scopes=None, renew: bool = None, reserved_resource_properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

PurchaseRequest.

Parameters

  • sku (SkuName) –

  • location (str) – The Azure Region where the reserved resource lives.

  • reserved_resource_type (str or ReservedResourceType) – Possible values include: ‘VirtualMachines’, ‘SqlDatabases’, ‘SuseLinux’, ‘CosmosDb’, ‘RedHat’, ‘SqlDataWarehouse’, ‘VMwareCloudSimple’, ‘RedHatOsa’, ‘Databricks’, ‘AppService’, ‘ManagedDisk’, ‘BlockBlob’, ‘RedisCache’, ‘AzureDataExplorer’, ‘MySql’, ‘MariaDb’, ‘PostgreSql’, ‘DedicatedHost’, ‘SapHana’, ‘SqlAzureHybridBenefit’

  • billing_scope_id (str) –

  • term (str or ReservationTerm) – Possible values include: ‘P1Y’, ‘P3Y’

  • billing_plan (str or ReservationBillingPlan) – Possible values include: ‘Upfront’, ‘Monthly’

  • quantity (int) –

  • display_name (str) – Friendly name of the Reservation

  • applied_scope_type (str or AppliedScopeType) – Possible values include: ‘Single’, ‘Shared’

  • applied_scopes (list[str]) –

  • renew (bool) –

  • reserved_resource_properties (PurchaseRequestPropertiesReservedResourceProperties) – Properties specific to each reserved resource type. Not required if not applicable.

class azure.mgmt.reservations.models.PurchaseRequestPropertiesReservedResourceProperties(*, instance_flexibility=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties specific to each reserved resource type. Not required if not applicable.

Parameters

instance_flexibility (str or InstanceFlexibility) – Possible values include: ‘On’, ‘Off’

class azure.mgmt.reservations.models.QuotaLimitsResponse(*, value=None, next_link: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Quotas (service limits) in the request response.

Parameters

  • value (list[CurrentQuotaLimit]) – List of quotas with the quota request status.

  • next_link (str) – The URI for fetching the next page of quota limits. When no more pages exist, the value is null.

class azure.mgmt.reservations.models.QuotaProperties(*, limit: int = None, unit: str = None, name=None, resource_type=None, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Quota properties for the resource.

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

Parameters

  • limit (int) – Quota properties.

  • unit (str) – The limit units, such as count and bytes. Use the unit field provided in the response of the GET quota operation.

  • name (ResourceName) – Name of the resource provide by the resource provider. Use this property for quotaRequests resource operations.

  • resource_type (object) – The name of the resource type.

  • properties (object) – Additional properties for the specified resource provider.

Variables

  • current_value (int) – Current usage value for the resource.

  • quota_period (str) – The time period over which the quota usage values are summarized. For example, P1D (per one day), PT1M (per one minute), and PT1S (per one second). This parameter is optional because, for some resources such as compute, the time period is irrelevant.

class azure.mgmt.reservations.models.QuotaRequestDetails(*, provisioning_state=None, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

Quota request details.

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

Variables

  • id (str) – Quota request ID.

  • name (str) – Quota request name.

  • message (str) – User friendly status message.

  • request_submit_time (datetime) – The time when the quota request was submitted using format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

  • type (str) – Resource type

Parameters

  • provisioning_state (object) – The quota request status.

  • value (list[SubRequest]) – The quotaRequests.

class azure.mgmt.reservations.models.QuotaRequestOneResourceSubmitResponse(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the quota submission request.

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

Variables

  • id (str) – The quota request ID.

  • name (str) – The name of the quota request.

  • type (str) – Type of resource. “Microsoft.Capacity/ServiceLimits”

  • provisioning_state (object) – The quota request status.

  • message (str) – User friendly status message.

  • request_submit_time (datetime) – The time when the quota request was submitted using format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Parameters

properties (QuotaProperties) – Quota properties for the resource.

class azure.mgmt.reservations.models.QuotaRequestProperties(*, provisioning_state=None, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The details of quota request.

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

Parameters

  • provisioning_state (object) – The quota request status.

  • value (list[SubRequest]) – The quotaRequests.

Variables

  • message (str) – User friendly status message.

  • request_submit_time (datetime) – The time when the quota request was submitted using format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

class azure.mgmt.reservations.models.QuotaRequestSubmitResponse(*, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

Response for the quota submission request.

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

Variables

  • id (str) – The quota request ID.

  • name (str) – The name of the quota request.

  • type (str) – Type of resource. “Microsoft.Capacity/serviceLimits”

Parameters

properties (QuotaRequestProperties) – The quota request details.

class azure.mgmt.reservations.models.QuotaRequestSubmitResponse201(**kwargs)[source]

Bases: msrest.serialization.Model

Response with request ID that the quota request was accepted.

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

Variables

  • id (str) – The quota request ID. Use the requestId parameter to check the request status.

  • name (str) – Operation ID

  • type (str) – Resource type

  • provisioning_state (object) – The details of the quota request status.

  • message (str) – A user friendly message.

class azure.mgmt.reservations.models.RenewPropertiesResponse(*, purchase_properties=None, pricing_currency_total=None, billing_currency_total=None, **kwargs)[source]

Bases: msrest.serialization.Model

RenewPropertiesResponse.

Parameters
class azure.mgmt.reservations.models.RenewPropertiesResponseBillingCurrencyTotal(*, currency_code: str = None, amount: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Currency and amount that customer will be charged in customer’s local currency for renewal purchase. Tax is not included.

Parameters

  • currency_code (str) –

  • amount (float) –

class azure.mgmt.reservations.models.RenewPropertiesResponsePricingCurrencyTotal(*, currency_code: str = None, amount: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry.

Parameters

  • currency_code (str) –

  • amount (float) –

class azure.mgmt.reservations.models.ReservationMergeProperties(*, merge_destination: str = None, merge_sources=None, **kwargs)[source]

Bases: msrest.serialization.Model

ReservationMergeProperties.

Parameters

  • merge_destination (str) – Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

  • merge_sources (list[str]) – Resource Ids of the Source Reservation’s merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

class azure.mgmt.reservations.models.ReservationOrderBillingPlanInformation(*, pricing_currency_total=None, start_date=None, next_payment_due_date=None, transactions=None, **kwargs)[source]

Bases: msrest.serialization.Model

Information describing the type of billing plan for this reservation.

Parameters

  • pricing_currency_total (Price) – Amount of money to be paid for the Order. Tax is not included.

  • start_date (date) – Date when the billing plan has started.

  • next_payment_due_date (date) – For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off.

  • transactions (list[PaymentDetail]) –

class azure.mgmt.reservations.models.ReservationOrderResponse(*, etag: int = None, display_name: str = None, request_date_time=None, created_date_time=None, expiry_date=None, original_quantity: int = None, term=None, provisioning_state: str = None, billing_plan=None, plan_information=None, reservations=None, **kwargs)[source]

Bases: msrest.serialization.Model

ReservationOrderResponse.

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

Parameters

  • etag (int) –

  • display_name (str) – Friendly name for user to easily identified the reservation.

  • request_date_time (datetime) – This is the DateTime when the reservation was initially requested for purchase.

  • created_date_time (datetime) – This is the DateTime when the reservation was created.

  • expiry_date (date) – This is the date when the Reservation will expire.

  • original_quantity (int) –

  • term (str or ReservationTerm) – Possible values include: ‘P1Y’, ‘P3Y’

  • provisioning_state (str) – Current state of the reservation.

  • billing_plan (str or ReservationBillingPlan) – Possible values include: ‘Upfront’, ‘Monthly’

  • plan_information (ReservationOrderBillingPlanInformation) –

  • reservations (list[ReservationResponse]) –

Variables

  • id (str) – Identifier of the reservation

  • name (str) – Name of the reservation

  • type (str) – Type of resource. “Microsoft.Capacity/reservations”

class azure.mgmt.reservations.models.ReservationProperties(*, reserved_resource_type=None, instance_flexibility=None, display_name: str = None, applied_scopes=None, applied_scope_type=None, quantity: int = None, provisioning_state: str = None, effective_date_time=None, expiry_date=None, sku_description: str = None, extended_status_info=None, billing_plan=None, split_properties=None, merge_properties=None, billing_scope_id: str = None, renew: bool = None, renew_source: str = None, renew_destination: str = None, renew_properties=None, term=None, **kwargs)[source]

Bases: msrest.serialization.Model

ReservationProperties.

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

Parameters

  • reserved_resource_type (str or ReservedResourceType) – Possible values include: ‘VirtualMachines’, ‘SqlDatabases’, ‘SuseLinux’, ‘CosmosDb’, ‘RedHat’, ‘SqlDataWarehouse’, ‘VMwareCloudSimple’, ‘RedHatOsa’, ‘Databricks’, ‘AppService’, ‘ManagedDisk’, ‘BlockBlob’, ‘RedisCache’, ‘AzureDataExplorer’, ‘MySql’, ‘MariaDb’, ‘PostgreSql’, ‘DedicatedHost’, ‘SapHana’, ‘SqlAzureHybridBenefit’

  • instance_flexibility (str or InstanceFlexibility) – Possible values include: ‘On’, ‘Off’

  • display_name (str) – Friendly name for user to easily identify the reservation

  • applied_scopes (list[str]) –

  • applied_scope_type (str or AppliedScopeType) – Possible values include: ‘Single’, ‘Shared’

  • quantity (int) –

  • provisioning_state (str) – Current state of the reservation.

  • effective_date_time (datetime) – DateTime of the Reservation starting when this version is effective from.

  • expiry_date (date) – This is the date when the Reservation will expire.

  • sku_description (str) – Description of the SKU in english.

  • extended_status_info (ExtendedStatusInfo) –

  • billing_plan (str or ReservationBillingPlan) – Possible values include: ‘Upfront’, ‘Monthly’

  • split_properties (ReservationSplitProperties) –

  • merge_properties (ReservationMergeProperties) –

  • billing_scope_id (str) –

  • renew (bool) –

  • renew_source (str) – Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

  • 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) –

  • term (str or ReservationTerm) – Possible values include: ‘P1Y’, ‘P3Y’

Variables

last_updated_date_time (datetime) – DateTime of the last time the Reservation was updated.

class azure.mgmt.reservations.models.ReservationResponse(*, etag: int = None, sku=None, properties=None, **kwargs)[source]

Bases: msrest.serialization.Model

ReservationResponse.

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

Variables

  • location (str) – The Azure Region where the reserved resource lives.

  • id (str) – Identifier of the reservation

  • name (str) – Name of the reservation

  • type (str) – Type of resource. “Microsoft.Capacity/reservationOrders/reservations”

Parameters
class azure.mgmt.reservations.models.ReservationSplitProperties(*, split_destinations=None, split_source: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

ReservationSplitProperties.

Parameters

  • split_destinations (list[str]) – List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

  • split_source (str) – Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

class azure.mgmt.reservations.models.ReservationToExchange(*, reservation_id: str = None, quantity: int = None, billing_refund_amount=None, billing_information=None, **kwargs)[source]

Bases: msrest.serialization.Model

Reservation refund details.

Parameters

  • reservation_id (str) – Fully qualified id of the Reservation being returned.

  • quantity (int) – Quantity to be returned

  • billing_refund_amount (Price) –

  • billing_information (BillingInformation) –

class azure.mgmt.reservations.models.ReservationToPurchaseCalculateExchange(*, properties=None, billing_currency_total=None, **kwargs)[source]

Bases: msrest.serialization.Model

Reservation purchase details.

Parameters
class azure.mgmt.reservations.models.ReservationToPurchaseExchange(*, reservation_order_id: str = None, reservation_id: str = None, properties=None, billing_currency_total=None, status=None, **kwargs)[source]

Bases: msrest.serialization.Model

Reservation purchase details.

Parameters

  • reservation_order_id (str) – Fully qualified id of the ReservationOrder being purchased

  • reservation_id (str) – Fully qualified id of the Reservation being purchased. This value is only guaranteed to be non-null if the purchase is successful.

  • properties (PurchaseRequest) –

  • billing_currency_total (Price) –

  • status (str or OperationStatus) – Possible values include: ‘Succeeded’, ‘Failed’, ‘Cancelled’, ‘Pending’

class azure.mgmt.reservations.models.ReservationToReturn(*, reservation_id: str = None, quantity: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Reservation to return.

Parameters

  • reservation_id (str) – Fully qualified identifier of the Reservation being returned

  • quantity (int) – Quantity to be returned. Must be greater than zero.

class azure.mgmt.reservations.models.ReservationToReturnForExchange(*, reservation_id: str = None, quantity: int = None, billing_refund_amount=None, billing_information=None, status=None, **kwargs)[source]

Bases: msrest.serialization.Model

Reservation refund details.

Parameters

  • reservation_id (str) – Fully qualified id of the Reservation being returned.

  • quantity (int) – Quantity to be returned

  • billing_refund_amount (Price) –

  • billing_information (BillingInformation) –

  • status (str or OperationStatus) – Possible values include: ‘Succeeded’, ‘Failed’, ‘Cancelled’, ‘Pending’

class azure.mgmt.reservations.models.ResourceName(*, value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Resource name provided by the resource provider. Use this property for quotaRequest parameter.

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

Parameters

value (str) – Resource name.

Variables

localized_value (str) – Resource display localized name.

class azure.mgmt.reservations.models.ScopeProperties(*, scope: str = None, valid: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

ScopeProperties.

Parameters
class azure.mgmt.reservations.models.ServiceError(*, code: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The API error details.

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

Parameters

  • code (str) – The error code.

  • message (str) – The error message text.

Variables

details (list[ServiceErrorDetail]) – The list of error details.

class azure.mgmt.reservations.models.ServiceErrorDetail(**kwargs)[source]

Bases: msrest.serialization.Model

The error details.

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

Variables

  • code (str) – The error code.

  • message (str) – The error message.

class azure.mgmt.reservations.models.SkuName(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

SkuName.

Parameters

name (str) –

class azure.mgmt.reservations.models.SkuProperty(*, name: str = None, value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

SkuProperty.

Parameters

  • name (str) – An invariant to describe the feature.

  • value (str) – An invariant if the feature is measured by quantity.

class azure.mgmt.reservations.models.SkuRestriction(*, type: str = None, values=None, reason_code: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

SkuRestriction.

Parameters

  • type (str) – The type of restrictions.

  • values (list[str]) – The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.

  • reason_code (str) – The reason for restriction.

class azure.mgmt.reservations.models.SplitRequest(*, quantities=None, reservation_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

SplitRequest.

Parameters

  • quantities (list[int]) – List of the quantities in the new reservations to create.

  • reservation_id (str) – Resource id of the reservation to be split. Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}

class azure.mgmt.reservations.models.SubRequest(*, name=None, unit: str = None, provisioning_state=None, **kwargs)[source]

Bases: msrest.serialization.Model

The sub-request submitted with the quota request.

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

Variables

  • limit (int) – Quota (resource limit).

  • resource_type (str) – Resource type for which the quota check was made.

  • message (str) – User-friendly status message.

  • sub_request_id (str) – Sub request ID for individual request.

Parameters

  • name (ResourceName) – The resource name.

  • unit (str) – The limit units, such as count and bytes. Use the unit field provided in the response of the GET quota operation.

  • provisioning_state (object) – The quota request status.

class azure.mgmt.reservations.models.SubscriptionScopeProperties(*, scopes=None, **kwargs)[source]

Bases: msrest.serialization.Model

SubscriptionScopeProperties.

Parameters

scopes (list[ScopeProperties]) –

class azure.mgmt.reservations.models.ReservationResponsePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ReservationResponse object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.reservations.models.ReservationOrderResponsePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ReservationOrderResponse object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.reservations.models.OperationResponsePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of OperationResponse object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.reservations.models.CurrentQuotaLimitBasePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of CurrentQuotaLimitBase object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.reservations.models.QuotaRequestDetailsPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of QuotaRequestDetails object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.reservations.models.ReservedResourceType[source]

Bases: str, enum.Enum

An enumeration.

app_service = 'AppService'
azure_data_explorer = 'AzureDataExplorer'
block_blob = 'BlockBlob'
cosmos_db = 'CosmosDb'
databricks = 'Databricks'
dedicated_host = 'DedicatedHost'
managed_disk = 'ManagedDisk'
maria_db = 'MariaDb'
my_sql = 'MySql'
postgre_sql = 'PostgreSql'
red_hat = 'RedHat'
red_hat_osa = 'RedHatOsa'
redis_cache = 'RedisCache'
sap_hana = 'SapHana'
sql_azure_hybrid_benefit = 'SqlAzureHybridBenefit'
sql_data_warehouse = 'SqlDataWarehouse'
sql_databases = 'SqlDatabases'
suse_linux = 'SuseLinux'
virtual_machines = 'VirtualMachines'
vmware_cloud_simple = 'VMwareCloudSimple'
class azure.mgmt.reservations.models.ReservationTerm[source]

Bases: str, enum.Enum

An enumeration.

p1_y = 'P1Y'
p3_y = 'P3Y'
class azure.mgmt.reservations.models.ReservationBillingPlan[source]

Bases: str, enum.Enum

An enumeration.

monthly = 'Monthly'
upfront = 'Upfront'
class azure.mgmt.reservations.models.AppliedScopeType[source]

Bases: str, enum.Enum

An enumeration.

shared = 'Shared'
single = 'Single'
class azure.mgmt.reservations.models.InstanceFlexibility[source]

Bases: str, enum.Enum

An enumeration.

off = 'Off'
on = 'On'
class azure.mgmt.reservations.models.ReservationStatusCode[source]

Bases: str, enum.Enum

An enumeration.

active = 'Active'
expired = 'Expired'
merged = 'Merged'
none = 'None'
payment_instrument_error = 'PaymentInstrumentError'
pending = 'Pending'
purchase_error = 'PurchaseError'
split = 'Split'
succeeded = 'Succeeded'
class azure.mgmt.reservations.models.ErrorResponseCode[source]

Bases: str, enum.Enum

An enumeration.

activate_quote_failed = 'ActivateQuoteFailed'
applied_scopes_not_associated_with_commerce_account = 'AppliedScopesNotAssociatedWithCommerceAccount'
authorization_failed = 'AuthorizationFailed'
bad_request = 'BadRequest'
billing_customer_input_error = 'BillingCustomerInputError'
billing_error = 'BillingError'
billing_payment_instrument_hard_error = 'BillingPaymentInstrumentHardError'
billing_payment_instrument_soft_error = 'BillingPaymentInstrumentSoftError'
billing_scope_id_cannot_be_changed = 'BillingScopeIdCannotBeChanged'
billing_transient_error = 'BillingTransientError'
calculate_price_failed = 'CalculatePriceFailed'
capacity_update_scopes_failed = 'CapacityUpdateScopesFailed'
client_certificate_thumbprint_not_set = 'ClientCertificateThumbprintNotSet'
create_quote_failed = 'CreateQuoteFailed'
forbidden = 'Forbidden'
fulfillment_configuration_error = 'FulfillmentConfigurationError'
fulfillment_error = 'FulfillmentError'
fulfillment_out_of_stock_error = 'FulfillmentOutOfStockError'
fulfillment_transient_error = 'FulfillmentTransientError'
http_method_not_supported = 'HttpMethodNotSupported'
internal_server_error = 'InternalServerError'
invalid_access_token = 'InvalidAccessToken'
invalid_fulfillment_request_parameters = 'InvalidFulfillmentRequestParameters'
invalid_health_check_type = 'InvalidHealthCheckType'
invalid_location_id = 'InvalidLocationId'
invalid_refund_quantity = 'InvalidRefundQuantity'
invalid_request_content = 'InvalidRequestContent'
invalid_request_uri = 'InvalidRequestUri'
invalid_reservation_id = 'InvalidReservationId'
invalid_reservation_order_id = 'InvalidReservationOrderId'
invalid_single_applied_scopes_count = 'InvalidSingleAppliedScopesCount'
invalid_subscription_id = 'InvalidSubscriptionId'
invalid_tenant_id = 'InvalidTenantId'
missing_applied_scopes_for_single = 'MissingAppliedScopesForSingle'
missing_tenant_id = 'MissingTenantId'
no_valid_reservations_to_re_rate = 'NoValidReservationsToReRate'
nonsupported_account_id = 'NonsupportedAccountId'
not_specified = 'NotSpecified'
not_supported_country = 'NotSupportedCountry'
operation_cannot_be_performed_in_current_state = 'OperationCannotBePerformedInCurrentState'
operation_failed = 'OperationFailed'
patch_values_same_as_existing = 'PatchValuesSameAsExisting'
payment_instrument_not_found = 'PaymentInstrumentNotFound'
purchase_error = 'PurchaseError'
re_rate_only_allowed_for_ea = 'ReRateOnlyAllowedForEA'
reservation_id_not_in_reservation_order = 'ReservationIdNotInReservationOrder'
reservation_order_creation_failed = 'ReservationOrderCreationFailed'
reservation_order_id_already_exists = 'ReservationOrderIdAlreadyExists'
reservation_order_not_enabled = 'ReservationOrderNotEnabled'
reservation_order_not_found = 'ReservationOrderNotFound'
risk_check_failed = 'RiskCheckFailed'
role_assignment_creation_failed = 'RoleAssignmentCreationFailed'
server_timeout = 'ServerTimeout'
unauthenticated_requests_throttled = 'UnauthenticatedRequestsThrottled'
unsupported_reservation_term = 'UnsupportedReservationTerm'
class azure.mgmt.reservations.models.CalculateExchangeOperationResultStatus[source]

Bases: str, enum.Enum

An enumeration.

cancelled = 'Cancelled'
failed = 'Failed'
pending = 'Pending'
succeeded = 'Succeeded'
class azure.mgmt.reservations.models.ExchangeOperationResultStatus[source]

Bases: str, enum.Enum

An enumeration.

cancelled = 'Cancelled'
failed = 'Failed'
pending_purchases = 'PendingPurchases'
pending_refunds = 'PendingRefunds'
succeeded = 'Succeeded'
class azure.mgmt.reservations.models.OperationStatus[source]

Bases: str, enum.Enum

An enumeration.

cancelled = 'Cancelled'
failed = 'Failed'
pending = 'Pending'
succeeded = 'Succeeded'
class azure.mgmt.reservations.models.PaymentStatus[source]

Bases: str, enum.Enum

An enumeration.

cancelled = 'Cancelled'
failed = 'Failed'
scheduled = 'Scheduled'
succeeded = 'Succeeded'