@azure/arm-reservations package
Clases
| AzureReservationAPI |
Interfaces
| AppliedReservationList |
Lista paginada de reservas aplicadas |
| AppliedReservations |
Respuesta de la API de reservas aplicadas |
| AppliedReservationsProperties |
Propiedades para reservas aplicadas devueltas |
| AppliedScopeProperties |
Propiedades específicas del tipo de ámbito aplicado. No es necesario si no es aplicable. Obligatorio y necesario proporcionar tenantId y managementGroupId si AppliedScopeType es ManagementGroup |
| AvailableScopeProperties |
La respuesta de la API de ámbito disponible que contiene ámbitos y sus idoneidad. |
| AvailableScopeRequest |
Ámbito disponible |
| AvailableScopeRequestProperties |
Propiedades de solicitud de ámbito disponibles |
| AzureReservationAPIOptionalParams |
Parámetros opcionales para el cliente. |
| BillingInformation |
información de facturación |
| CalculateExchangeOperationResultResponse |
Resultado de la operación CalculateExchange |
| CalculateExchangeOperations |
Interfaz que representa operaciones de CalculateExchange. |
| CalculateExchangePostOptionalParams |
Parámetros opcionales. |
| CalculateExchangeRequest |
Cálculo de la solicitud de intercambio |
| CalculateExchangeRequestProperties |
Cálculo de las propiedades de la solicitud de intercambio |
| CalculateExchangeResponseProperties |
Propiedades de respuesta CalculateExchange |
| CalculatePriceResponse |
Respuesta del cálculo del precio de la reserva. |
| CalculatePriceResponseProperties |
Propiedades para calcular la respuesta de precios |
| CalculatePriceResponsePropertiesBillingCurrencyTotal |
Moneda y cantidad que se cobrará al cliente en la moneda local del cliente. No se incluye el impuesto. |
| CalculatePriceResponsePropertiesPricingCurrencyTotal |
Cantidad que Microsoft usa para el registro. Se usa durante el reembolso para calcular el límite de reembolso. No se incluye el impuesto. |
| CalculateRefundOperations |
Interfaz que representa una operación de CalculateRefund. |
| CalculateRefundPostOptionalParams |
Parámetros opcionales. |
| CalculateRefundRequest |
Solicitud que contiene información necesaria para calcular el reembolso. |
| CalculateRefundRequestProperties |
Propiedades necesarias para calcular el reembolso, incluido el ámbito y la reserva que se va a devolver. |
| CalculateRefundResponse |
La respuesta del cálculo del reembolso que contiene la información de reembolso de la reserva |
| Catalog |
Detalles del producto de un tipo de recurso. |
| CatalogMsrp |
Información de precios sobre la SKU |
| ChangeDirectoryRequest |
Cuerpo de la solicitud para cambiar el directorio de una reserva. |
| ChangeDirectoryResponse |
Cambio de la respuesta del directorio |
| ChangeDirectoryResult |
Cambio del resultado del directorio para el pedido de reserva o la reserva |
| Commitment |
Compromiso con el beneficio. |
| CurrentQuotaLimitBase |
Propiedades de cuota. |
| ErrorDetails |
Detalles del error. |
| ErrorModel |
Información de error |
| ErrorResponse |
La respuesta de error indica que el servicio no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error. |
| ExceptionResponse |
Error de API. |
| ExchangeOperationResultResponse |
Resultado de la operación de Exchange |
| ExchangeOperations |
Interfaz que representa una operación de Exchange. |
| ExchangePolicyError |
detalles del error |
| ExchangePolicyErrors |
Errores de directiva de Exchange |
| ExchangePostOptionalParams |
Parámetros opcionales. |
| ExchangeRequest |
Solicitud de Exchange |
| ExchangeRequestProperties |
Propiedades de solicitud de Exchange |
| ExchangeResponseProperties |
Propiedades de respuesta de Exchange |
| ExtendedErrorInfo |
Información de error extendida, incluido el código de error y el mensaje de error |
| ExtendedStatusInfo |
interfaz de modelo ExtendedStatusInfo |
| GetAppliedReservationListOptionalParams |
Parámetros opcionales. |
| GetCatalogOptionalParams |
Parámetros opcionales. |
| MergeProperties |
Propiedades para fusión de reservas |
| MergeRequest |
Solicitud de combinación de reservas |
| OperationDisplay |
Información sobre una operación |
| OperationListOptionalParams |
Parámetros opcionales. |
| OperationOperations |
Interfaz que representa operaciones de operación. |
| OperationResponse |
La respuesta que contiene información de la operación |
| OperationResultError |
Obligatorio si el estado == error o estado == cancelado. |
| PageSettings |
Opciones para el método byPage |
| PagedAsyncIterableIterator |
Interfaz que permite la iteración asincrónica tanto a la finalización como a la página. |
| Patch |
Solicitud de revisión de reserva |
| PatchProperties |
Propiedades para el parche de reserva |
| PatchPropertiesRenewProperties |
interfaz de modelo ParchePropiedadesRenewProperties |
| PaymentDetail |
Información sobre el pago relacionado con un pedido de reserva. |
| Price |
Información de precios que contiene la cantidad y el código de moneda |
| ProxyResource |
Definición del modelo de recursos para un recurso proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación |
| PurchaseRequest |
Solicitud de compra de reserva |
| PurchaseRequestProperties |
Propiedades de la solicitud de compra de reserva |
| PurchaseRequestPropertiesReservedResourceProperties |
Propiedades específicas de cada tipo de recurso reservado. No es necesario si no es aplicable. |
| QuotaCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| QuotaGetOptionalParams |
Parámetros opcionales. |
| QuotaListOptionalParams |
Parámetros opcionales. |
| QuotaOperations |
Interfaz que representa una operación de cuota. |
| QuotaProperties |
Propiedades de cuota para el recurso. |
| QuotaRequestDetails |
Detalles de la solicitud de cuota. |
| QuotaRequestProperties |
Detalles de la solicitud de cuota. |
| QuotaRequestStatusGetOptionalParams |
Parámetros opcionales. |
| QuotaRequestStatusListOptionalParams |
Parámetros opcionales. |
| QuotaRequestStatusOperations |
Interfaz que representa una operación QuotaRequestStatus. |
| QuotaUpdateOptionalParams |
Parámetros opcionales. |
| RefundBillingInformation |
información de facturación |
| RefundPolicyError |
detalles del error |
| RefundPolicyResult |
Resultado de la directiva de reembolso |
| RefundPolicyResultProperty |
Propiedad de resultado de la directiva de reembolso |
| RefundRequest |
Solicitud que contiene información necesaria para devolver la reserva. |
| RefundRequestProperties |
Propiedades necesarias para la solicitud de reembolso, incluido el identificador de sesión del cálculo del reembolso, el ámbito, la reserva que se va a devolver y el motivo de devolución. |
| RefundResponseProperties |
Las propiedades de reembolso de la reserva |
| RenewPropertiesResponse |
Propiedades de renovación de una reserva. |
| RenewPropertiesResponseBillingCurrencyTotal |
Moneda y importe que se cobrará al cliente en la moneda local del cliente para la compra de renovación. No se incluye el impuesto. |
| RenewPropertiesResponsePricingCurrencyTotal |
Cantidad que Microsoft usa para el registro. Se usa durante el reembolso para calcular el límite de reembolso. No se incluye el impuesto. Este precio está bloqueado 30 días antes de la expiración. |
| ReservationArchiveOptionalParams |
Parámetros opcionales. |
| ReservationAvailableScopesOptionalParams |
Parámetros opcionales. |
| ReservationGetOptionalParams |
Parámetros opcionales. |
| ReservationListAllOptionalParams |
Parámetros opcionales. |
| ReservationListOptionalParams |
Parámetros opcionales. |
| ReservationListRevisionsOptionalParams |
Parámetros opcionales. |
| ReservationMergeOptionalParams |
Parámetros opcionales. |
| ReservationMergeProperties |
Propiedades de la combinación de reservas |
| ReservationOperations |
Interfaz que representa una operación de Reserva. |
| ReservationOrderBillingPlanInformation |
Información que describe el tipo de plan de facturación de esta reserva. |
| ReservationOrderCalculateOptionalParams |
Parámetros opcionales. |
| ReservationOrderChangeDirectoryOptionalParams |
Parámetros opcionales. |
| ReservationOrderGetOptionalParams |
Parámetros opcionales. |
| ReservationOrderListOptionalParams |
Parámetros opcionales. |
| ReservationOrderOperations |
Interfaz que representa una operación de Reservationorder. |
| ReservationOrderProperties |
Propiedades de una orden de reserva. |
| ReservationOrderPurchaseOptionalParams |
Parámetros opcionales. |
| ReservationOrderResponse |
Detalles de un pedido de reserva que se va a devolver. |
| ReservationResponse |
Definición de la reserva. |
| ReservationSplitOptionalParams |
Parámetros opcionales. |
| ReservationSplitProperties |
Propiedades de división de reserva |
| ReservationSummary |
Resumen del recuento acumulativo de reservas en cada estado |
| ReservationSwapProperties |
Propiedades del intercambio de reservas |
| ReservationToExchange |
Detalles del reembolso de la reserva |
| ReservationToPurchaseCalculateExchange |
Detalles de compra de reservas |
| ReservationToPurchaseExchange |
Detalles de compra de reservas |
| ReservationToReturn |
Reserva para devolver |
| ReservationToReturnForExchange |
Detalles del reembolso de la reserva |
| ReservationUnarchiveOptionalParams |
Parámetros opcionales. |
| ReservationUpdateOptionalParams |
Parámetros opcionales. |
| ReservationUtilizationAggregates |
Valores agregados del uso de reservas |
| ReservationsProperties |
Propiedades de las reservas |
| ReservationsPropertiesUtilization |
Uso de las reservas |
| Resource |
Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager |
| ResourceName |
Nombre del recurso proporcionado por el proveedor de recursos. Use esta propiedad para el parámetro quotaRequest. |
| RestorePollerOptions | |
| ReturnOperations |
Interfaz que representa una operación de retorno. |
| ReturnPostOptionalParams |
Parámetros opcionales. |
| SavingsPlanPurchaseRequest |
Cuerpo de la solicitud para la compra del plan de ahorro |
| SavingsPlanPurchaseRequestProperties |
Propiedades de una compra de un plan de ahorro |
| SavingsPlanToPurchaseCalculateExchange |
Detalles de compra del plan de ahorro |
| SavingsPlanToPurchaseExchange |
Detalles de compra del plan de ahorro |
| ScopeProperties |
Ámbito y si es válido. |
| ServiceError |
Detalles del error de la API. |
| ServiceErrorDetail |
Detalles del error. |
| SimplePollerLike |
Un sondeo sencillo que se puede usar para sondear una operación de larga duración. |
| SkuCapability |
Funcionalidad de una SKU. |
| SkuName |
El nombre de la SKU |
| SkuProperty |
Propiedad de una SKU. |
| SkuRestriction |
Restricción de una SKU. |
| SplitProperties |
Propiedades para la división de reservas |
| SplitRequest |
Solicitud de división de reservas |
| SubRequest |
La sub-solicitud enviada con la solicitud de cuota. |
| SubscriptionScopeProperties |
Los ámbitos comprobados por la API de ámbito disponible. |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
Alias de tipos
| AppliedScopeType |
Tipo del ámbito aplicado. Valores conocidos admitidos por el servicio
Sencillo: Sencillo |
| AzureSupportedClouds |
Los valores admitidos para la configuración de nube como un tipo literal de cadena |
| BillingPlan |
Representa el plan de facturación en formato ISO 8601. Solo es necesario para los planes de facturación mensuales. Valores conocidos admitidos por el servicioP1M: P1M |
| CalculateExchangeOperationResultStatus |
Estado de la operación. Valores conocidos admitidos por el servicio
Sucedió: Sucedió |
| CommitmentGrain |
Grano de compromiso. Valores conocidos admitidos por el servicioPor horas: Por horas |
| ContinuablePage |
Interfaz que describe una página de resultados. |
| CreatedByType |
Tipo de entidad que creó el recurso. Valores conocidos admitidos por el servicio
Usuario: un usuario creó la entidad. |
| ErrorResponseCode |
Código de error que describe la razón por la que el servicio no puede procesar la solicitud entrante Valores conocidos admitidos por el servicio
NoEspecificado: NoEspecificado |
| ExchangeOperationResultStatus |
Estado de la operación. Valores conocidos admitidos por el servicio
Sucedió: Sucedió |
| InstanceFlexibility |
Al activar esto, se aplicará el descuento de reserva a otras máquinas virtuales del mismo grupo de tamaño de máquina virtual. Especifique solo el tipo de recurso reservado VirtualMachines. Valores conocidos admitidos por el servicio
En: En |
| OperationStatus |
Estado de la operación individual. Valores conocidos admitidos por el servicio
Sucedió: Sucedió |
| PaymentStatus |
Describe si el pago se ha completado, con errores, cancelado o programado en el futuro. Valores conocidos admitidos por el servicio
Sucedió: Sucedió |
| ProvisioningState |
Representa el estado actual de la reserva. Valores conocidos admitidos por el servicio
Crear: Crear |
| QuotaRequestState |
Estado de la solicitud de cuota. Valores conocidos admitidos por el servicio
Aceptado: Aceptado |
| ReservationBillingPlan |
Representa los planes de facturación. Valores conocidos admitidos por el servicio
De entrada: De antelación |
| ReservationStatusCode |
Tipo de Código de Estado de Reserva |
| ReservationTerm |
Representa el plazo de reserva. Valores conocidos admitidos por el servicio
P1Y: P1Y |
| ReservedResourceType |
Tipo del recurso que se está reservando. Además de los siguientes tipos, también hemos agregado los siguientes: OpenAIPTU, MDC, Sentinel. Valores conocidos admitidos por el servicio
VirtualMachines: VirtualMachines |
| ResourceType |
Los tipos de recursos. Valores conocidos admitidos por el servicio
Estándar: Estándar |
| SavingsPlanTerm |
Representa el término del plan de ahorro en formato ISO 8601. Valores conocidos admitidos por el servicio
P1Y: P1Y |
Enumeraciones
| AzureClouds |
Una enumeración para describir los entornos de la nube de Azure. |
| KnownAppliedScopeType |
Tipo del ámbito aplicado. |
| KnownBillingPlan |
Representa el plan de facturación en formato ISO 8601. Solo es necesario para los planes de facturación mensuales. |
| KnownCalculateExchangeOperationResultStatus |
Estado de la operación. |
| KnownCommitmentGrain |
Grano de compromiso. |
| KnownCreatedByType |
Tipo de entidad que creó el recurso. |
| KnownErrorResponseCode |
Código de error que describe el motivo por el que el servicio no puede procesar la solicitud entrante |
| KnownExchangeOperationResultStatus |
Estado de la operación. |
| KnownInstanceFlexibility |
Al activar esto, se aplicará el descuento de reserva a otras máquinas virtuales del mismo grupo de tamaño de máquina virtual. Especifique solo el tipo de recurso reservado VirtualMachines. |
| KnownOperationStatus |
Estado de la operación individual. |
| KnownPaymentStatus |
Describe si el pago se ha completado, con errores, cancelado o programado en el futuro. |
| KnownProvisioningState |
Representa el estado actual de la reserva. |
| KnownQuotaRequestState |
Estado de la solicitud de cuota. |
| KnownReservationBillingPlan |
Representa los planes de facturación. |
| KnownReservationStatusCode |
Valores conocidos de ReservationStatusCode que acepta el servicio. |
| KnownReservationTerm |
Representa el plazo de reserva. |
| KnownReservedResourceType |
Tipo del recurso que se está reservando. Además de los siguientes tipos, también hemos agregado los siguientes: OpenAIPTU, MDC, Sentinel. |
| KnownResourceType |
Los tipos de recursos. |
| KnownSavingsPlanTerm |
Representa el término del plan de ahorro en formato ISO 8601. |
Funciones
| is |
Typeguard para RestError |
| restore |
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito. |
Variables
| Rest |
Tipo de error personalizado para solicitudes de canalización con error. |
Detalles de la función
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parámetros
- e
-
unknown
Algo capturado por una cláusula catch.
Devoluciones
e
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.
function restorePoller<TResponse, TResult>(client: AzureReservationAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parámetros
- client
- AzureReservationAPI
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluciones
PollerLike<OperationState<TResult>, TResult>
Detalles de variables
RestError
Tipo de error personalizado para solicitudes de canalización con error.
RestError: RestErrorConstructor