@azure/arm-reservations package
Классы
| AzureReservationAPI |
Интерфейсы
| AppliedReservationList |
Список примененных резервирований с разбивкой на страницы |
| AppliedReservations |
Ответ на api примененных резервирований |
| AppliedReservationsProperties |
Возвращённые объекты недвижимости для применённых резерваций |
| AppliedScopeProperties |
Свойства, относящиеся к примененным типу области. Не требуется, если применимо. Требуется и необходимо предоставить идентификатор клиента и managementGroupId, если AppliedScopeType — ManagementGroup |
| AvailableScopeProperties |
Ответ доступного API области, содержащего области и их права. |
| AvailableScopeRequest |
Доступная область |
| AvailableScopeRequestProperties |
Доступные свойства запроса области |
| AzureReservationAPIOptionalParams |
Необязательные параметры для клиента. |
| BillingInformation |
Сведения о выставлении счетов |
| CalculateExchangeOperationResultResponse |
Результат операции CalculateExchange |
| CalculateExchangeOperations |
Интерфейс, представляющий операции CalculateExchange. |
| CalculateExchangePostOptionalParams |
Необязательные параметры. |
| CalculateExchangeRequest |
Вычисление запроса exchange |
| CalculateExchangeRequestProperties |
Вычисление свойств запроса exchange |
| CalculateExchangeResponseProperties |
Свойства ответа CalculateExchange |
| CalculatePriceResponse |
Ответ на вычисление цены для резервирования. |
| CalculatePriceResponseProperties |
Свойства для вычисления ответа на цену |
| CalculatePriceResponsePropertiesBillingCurrencyTotal |
Валюта и сумма, которые клиент будет взиматься в локальной валюте клиента. Налог не включен. |
| CalculatePriceResponsePropertiesPricingCurrencyTotal |
Сумма, которую корпорация Майкрософт использует для записи. Используется во время возврата средств для расчета лимита возврата. Налог не включен. |
| CalculateRefundOperations |
Интерфейс, представляющий операции CalculateRefund. |
| CalculateRefundPostOptionalParams |
Необязательные параметры. |
| CalculateRefundRequest |
Запрос, содержащий сведения, необходимые для вычисления возврата средств. |
| CalculateRefundRequestProperties |
Свойства, необходимые для расчета возмещения, включая область и возвращаемое резервирование. |
| CalculateRefundResponse |
Ответ на вычислимый возврат, содержащий сведения о возврате средств резервирования |
| Catalog |
Сведения о продукте типа ресурса. |
| CatalogMsrp |
Сведения о ценах на номер SKU |
| ChangeDirectoryRequest |
Текст запроса на изменение каталога резервирования. |
| ChangeDirectoryResponse |
Изменение ответа каталога |
| ChangeDirectoryResult |
Изменение результата каталога для заказа резервирования или резервирования |
| Commitment |
Приверженность преимуществам. |
| CurrentQuotaLimitBase |
Свойства квоты. |
| ErrorDetails |
Сведения об ошибке. |
| ErrorModel |
Сведения об ошибке |
| ErrorResponse |
Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. |
| ExceptionResponse |
Ошибка API. |
| ExchangeOperationResultResponse |
Результат операции Exchange |
| ExchangeOperations |
Интерфейс, представляющий операции Exchange. |
| ExchangePolicyError |
сведения об ошибке |
| ExchangePolicyErrors |
Ошибки политики Exchange |
| ExchangePostOptionalParams |
Необязательные параметры. |
| ExchangeRequest |
Запрос Exchange |
| ExchangeRequestProperties |
Свойства запроса Exchange |
| ExchangeResponseProperties |
Свойства ответа Exchange |
| ExtendedErrorInfo |
Расширенные сведения об ошибках, включая код ошибки и сообщение об ошибке |
| ExtendedStatusInfo |
model interface ExtendedStatusInfo |
| GetAppliedReservationListOptionalParams |
Необязательные параметры. |
| GetCatalogOptionalParams |
Необязательные параметры. |
| MergeProperties |
Объекты для объединения резерваций |
| MergeRequest |
Запрос на слияние резервирования |
| OperationDisplay |
Сведения об операции |
| OperationListOptionalParams |
Необязательные параметры. |
| OperationOperations |
Интерфейс, представляющий операционные операции. |
| OperationResponse |
Ответ, содержащий сведения об операции |
| OperationResultError |
Требуется, если состояние == не удалось или состояние == отменено. |
| PageSettings |
Параметры метода byPage |
| PagedAsyncIterableIterator |
Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам. |
| Patch |
Запрос на обновление резервирования |
| PatchProperties |
Объекты для бронирования |
| PatchPropertiesRenewProperties |
интерфейс модели PatchPropertiesRenewProperties |
| PaymentDetail |
Сведения об оплате, связанной с заказом на резервирование. |
| Price |
Сведения о ценах, содержащие сумму и код валюты |
| ProxyResource |
Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение |
| PurchaseRequest |
Запрос на покупку резервирования |
| PurchaseRequestProperties |
Свойства запроса на покупку резервирования |
| PurchaseRequestPropertiesReservedResourceProperties |
Свойства, относящиеся к каждому зарезервированного типа ресурса. Не требуется, если применимо. |
| QuotaCreateOrUpdateOptionalParams |
Необязательные параметры. |
| QuotaGetOptionalParams |
Необязательные параметры. |
| QuotaListOptionalParams |
Необязательные параметры. |
| QuotaOperations |
Интерфейс, представляющий операции Quota. |
| QuotaProperties |
Свойства квоты для ресурса. |
| QuotaRequestDetails |
Сведения о запросе квоты. |
| QuotaRequestProperties |
Сведения о запросе квоты. |
| QuotaRequestStatusGetOptionalParams |
Необязательные параметры. |
| QuotaRequestStatusListOptionalParams |
Необязательные параметры. |
| QuotaRequestStatusOperations |
Интерфейс, представляющий операции QuotaRequestStatus. |
| QuotaUpdateOptionalParams |
Необязательные параметры. |
| RefundBillingInformation |
Сведения о выставлении счетов |
| RefundPolicyError |
сведения об ошибке |
| RefundPolicyResult |
Результат политики возврата |
| RefundPolicyResultProperty |
Свойство результата политики возврата |
| RefundRequest |
Запрос, содержащий сведения, необходимые для возврата резервирования. |
| RefundRequestProperties |
Свойства, необходимые для запроса на возврат средств, включая идентификатор сеанса от вычисления возврата, область, резервирования, возвращаемую и причину возврата. |
| RefundResponseProperties |
Свойства возврата резервирования |
| RenewPropertiesResponse |
Свойства продления резервирования. |
| RenewPropertiesResponseBillingCurrencyTotal |
Валюта и сумма, которые клиент будет взиматься в местную валюту клиента за покупку продления. Налог не включен. |
| RenewPropertiesResponsePricingCurrencyTotal |
Сумма, которую корпорация Майкрософт использует для записи. Используется во время возврата средств для расчета лимита возврата. Налог не включен. Эта цена заблокирована за 30 дней до истечения срока действия. |
| ReservationArchiveOptionalParams |
Необязательные параметры. |
| ReservationAvailableScopesOptionalParams |
Необязательные параметры. |
| ReservationGetOptionalParams |
Необязательные параметры. |
| ReservationListAllOptionalParams |
Необязательные параметры. |
| ReservationListOptionalParams |
Необязательные параметры. |
| ReservationListRevisionsOptionalParams |
Необязательные параметры. |
| ReservationMergeOptionalParams |
Необязательные параметры. |
| ReservationMergeProperties |
Свойства слияния резервирования |
| ReservationOperations |
Интерфейс, представляющий операции резервирования. |
| ReservationOrderBillingPlanInformation |
Сведения о типе плана выставления счетов для этого резервирования. |
| ReservationOrderCalculateOptionalParams |
Необязательные параметры. |
| ReservationOrderChangeDirectoryOptionalParams |
Необязательные параметры. |
| ReservationOrderGetOptionalParams |
Необязательные параметры. |
| ReservationOrderListOptionalParams |
Необязательные параметры. |
| ReservationOrderOperations |
Интерфейс, представляющий операции ReservationOrder. |
| ReservationOrderProperties |
Свойства приказа о резервировании. |
| ReservationOrderPurchaseOptionalParams |
Необязательные параметры. |
| ReservationOrderResponse |
Сведения о возвращаемом заказе на резервирование. |
| ReservationResponse |
Определение резервирования. |
| ReservationSplitOptionalParams |
Необязательные параметры. |
| ReservationSplitProperties |
Свойства разделения резервирования |
| ReservationSummary |
Сводная сводка по количеству резервирований в каждом состоянии |
| ReservationSwapProperties |
Свойства переключения резервирования |
| ReservationToExchange |
Сведения о возврате резервирования |
| ReservationToPurchaseCalculateExchange |
Сведения о покупке резервирования |
| ReservationToPurchaseExchange |
Сведения о покупке резервирования |
| ReservationToReturn |
Резервирование для возврата |
| ReservationToReturnForExchange |
Сведения о возврате резервирования |
| ReservationUnarchiveOptionalParams |
Необязательные параметры. |
| ReservationUpdateOptionalParams |
Необязательные параметры. |
| ReservationUtilizationAggregates |
Агрегированные значения использования резервирования |
| ReservationsProperties |
Свойства резервирования |
| ReservationsPropertiesUtilization |
Использование резервирования |
| Resource |
Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager |
| ResourceName |
Имя ресурса, предоставленное поставщиком ресурсов. Используйте это свойство для параметра quotaRequest. |
| RestorePollerOptions | |
| ReturnOperations |
Интерфейс, представляющий операцию возврата. |
| ReturnPostOptionalParams |
Необязательные параметры. |
| SavingsPlanPurchaseRequest |
Текст запроса на покупку плана экономии |
| SavingsPlanPurchaseRequestProperties |
Свойства покупки сберегательного плана |
| SavingsPlanToPurchaseCalculateExchange |
Сведения о покупке плана экономии |
| SavingsPlanToPurchaseExchange |
Сведения о покупке плана экономии |
| ScopeProperties |
Область и допустимо ли она. |
| ServiceError |
Сведения об ошибке API. |
| ServiceErrorDetail |
Сведения об ошибке. |
| SimplePollerLike |
Простой опросщик, который можно использовать для опроса длительной операции. |
| SkuCapability |
Возможность SKU. |
| SkuName |
Имя SKU |
| SkuProperty |
Свойство SKU. |
| SkuRestriction |
Ограничение номера SKU. |
| SplitProperties |
Объекты для разделения резерваций |
| SplitRequest |
Запрос на разделение резервирования |
| SubRequest |
Вложенный запрос, отправленный с запросом квоты. |
| SubscriptionScopeProperties |
Области, проверенные api доступных областей. |
| SystemData |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
Псевдонимы типа
| AppliedScopeType |
Тип примененной области. Известные значения, поддерживаемые службой
Сингл: Сингл |
| AzureSupportedClouds |
Поддерживаемые значения для настройки облака в виде строкового литерала |
| BillingPlan |
Представляет план выставления счетов в формате ISO 8601. Требуется только для ежемесячных планов выставления счетов. Известные значения, поддерживаемые службойP1M: P1M |
| CalculateExchangeOperationResultStatus |
Статус операции. Известные значения, поддерживаемые службой
Удалось: Успешно |
| CommitmentGrain |
Зерно обязательств. Известные значения, поддерживаемые службойПочасово: Ежечасно |
| ContinuablePage |
Интерфейс, описывающий страницу результатов. |
| CreatedByType |
Тип сущности, создающей ресурс. Известные значения, поддерживаемые службой
user: сущность была создана пользователем. |
| ErrorResponseCode |
Код ошибки, описывающий причину, по которой сервис не может обработать входящий запрос Известные значения, поддерживаемые службой
NotSpecificified: NotSpecified |
| ExchangeOperationResultStatus |
Статус операции. Известные значения, поддерживаемые службой
Удалось: Успешно |
| InstanceFlexibility |
Включение этого параметра применит скидку на резервирование к другим виртуальным машинам в той же группе размеров виртуальной машины. Укажите только зарезервированный тип ресурса VirtualMachines. Известные значения, поддерживаемые службой
Включено: На |
| OperationStatus |
Состояние отдельной операции. Известные значения, поддерживаемые службой
Удалось: Успешно |
| PaymentStatus |
Описывает, завершен ли платеж, сбой, отмена или планирование в будущем. Известные значения, поддерживаемые службой
Удалось: Успешно |
| ProvisioningState |
Представляет текущее состояние резервирования. Известные значения, поддерживаемые службой
Создание: Создание |
| QuotaRequestState |
Состояние запроса квоты. Известные значения, поддерживаемые службой
Принято: Принято |
| ReservationBillingPlan |
Представляет планы выставления счетов. Известные значения, поддерживаемые службой
Вперед: Вперед |
| ReservationStatusCode |
Тип резервацииСтатусКод |
| ReservationTerm |
Представляет срок резервирования. Известные значения, поддерживаемые службой
P1Y: P1Y |
| ReservedResourceType |
Тип зарезервированного ресурса. В дополнение к нижеперечисленным типам мы также добавили следующие: OpenAIPTU, MDC, Sentinel. Известные значения, поддерживаемые службой
VirtualMachines: VirtualMachines |
| ResourceType |
Типы ресурсов. Известные значения, поддерживаемые службой
Стандарт: стандарт |
| SavingsPlanTerm |
Представляет термин плана экономии в формате ISO 8601. Известные значения, поддерживаемые службой
P1Y: P1Y |
Перечисления
| AzureClouds |
Перечисление для описания облачных сред Azure. |
| KnownAppliedScopeType |
Тип примененной области. |
| KnownBillingPlan |
Представляет план выставления счетов в формате ISO 8601. Требуется только для ежемесячных планов выставления счетов. |
| KnownCalculateExchangeOperationResultStatus |
Статус операции. |
| KnownCommitmentGrain |
Зерно обязательств. |
| KnownCreatedByType |
Тип сущности, создающей ресурс. |
| KnownErrorResponseCode |
Код ошибки, описывающий причину, по которой служба не может обработать входящий запрос |
| KnownExchangeOperationResultStatus |
Статус операции. |
| KnownInstanceFlexibility |
Включение этого параметра применит скидку на резервирование к другим виртуальным машинам в той же группе размеров виртуальной машины. Укажите только зарезервированный тип ресурса VirtualMachines. |
| KnownOperationStatus |
Состояние отдельной операции. |
| KnownPaymentStatus |
Описывает, завершен ли платеж, сбой, отмена или планирование в будущем. |
| KnownProvisioningState |
Представляет текущее состояние резервирования. |
| KnownQuotaRequestState |
Состояние запроса квоты. |
| KnownReservationBillingPlan |
Представляет планы выставления счетов. |
| KnownReservationStatusCode |
Известные значения ReservationStatusCode, которые служба принимает. |
| KnownReservationTerm |
Представляет срок резервирования. |
| KnownReservedResourceType |
Тип зарезервированного ресурса. В дополнение к нижеперечисленным типам мы также добавили следующие: OpenAIPTU, MDC, Sentinel. |
| KnownResourceType |
Типы ресурсов. |
| KnownSavingsPlanTerm |
Представляет термин плана экономии в формате ISO 8601. |
Функции
| is |
Typeguard для RestError |
| restore |
Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области. |
Переменные
| Rest |
Настраиваемый тип ошибки для неудачных запросов конвейера. |
Сведения о функции
isRestError(unknown)
Typeguard для RestError
function isRestError(e: unknown): e
Параметры
- e
-
unknown
Что-то поймано предложением catch.
Возвращаемое значение
e
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.
function restorePoller<TResponse, TResult>(client: AzureReservationAPI, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- AzureReservationAPI
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
Сведения об переменной
RestError
Настраиваемый тип ошибки для неудачных запросов конвейера.
RestError: RestErrorConstructor