@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

Тип примененной области.
KnownAppliedScopeType можно использовать взаимозаменяемо с AppliedScopeType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Сингл: Сингл
Поделились: Общие
Управленческая группа: Управленческая группа

AzureSupportedClouds

Поддерживаемые значения для настройки облака в виде строкового литерала

BillingPlan

Представляет план выставления счетов в формате ISO 8601. Требуется только для ежемесячных планов выставления счетов.
KnownBillingPlan можно использовать взаимозаменяемо с BillingPlan, в этом перечислении содержатся известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

P1M: P1M

CalculateExchangeOperationResultStatus

Статус операции.
KnownCalculateExchangeOperationResultStatus можно использовать взаимозаменяемо с CalculateExchangeOperationResultStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Удалось: Успешно
Failed: Неудача
Отменено: Отменено
Ожидается: Ожидается

CommitmentGrain

Зерно обязательств.
KnownCommitmentGrain можно использовать взаимозаменяемо с CommitmentGrain, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Почасово: Ежечасно

ContinuablePage

Интерфейс, описывающий страницу результатов.

CreatedByType

Тип сущности, создающей ресурс.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user: сущность была создана пользователем.
приложения: сущность была создана приложением.
ManagedIdentity: сущность была создана управляемым удостоверением.
ключ: сущность была создана ключом.

ErrorResponseCode

Код ошибки, описывающий причину, по которой сервис не может обработать входящий запрос
KnownErrorResponseCode можно использовать взаимозаменяемо с ErrorResponseCode, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

NotSpecificified: NotSpecified
InternalServerError: InternalServerError
ServerTimeout: ServerTimeout
АвторизацияНеудача: АвторизацияНеудача
BadRequest: BadRequest
ClientCertificateThumbprintNotSet: ClientCertificateThumbprintNotSet
InvalidRequestContent: InvalidRequestContent
ОперацияНеудача: ОперацияНеудача
HttpMethodNotSupported: HttpMethodNotsupported
InvalidRequestUri: InvalidRequestUri
MissingTenantId: MissingTenantId
InvalidTenantId: InvalidTenantId
InvalidReservationOrderId: InvalidReservationOrderId
InvalidReservationId: InvalidReservationId
Порядок резервацииIdNotInReservation: ReservationIdNotInReservationOrder
Заказ на бронированиеНенайденный: Заказ на бронированиеНенайденный
InvalidSubscriptionId: InvalidSubscriptionId
InvalidAccessToken: InvalidAccessToken
InvalidLocationId: InvalidLocationId
НеаутентифицированныеЗапросыОграничены: НеаутентифицированныеЗапросыОграничены.
InvalidHealthCheckType: InvalidHealthCheckType
Запрещено: Запрещено
BillingScopeIdCannotBeChanged: BillingScopeIdCannotBeChanged
AppliedScopesNotAssociatedWithCommerceAccount: AppliedScopesNotAssociatedWithCommerceAccount
PatchValuesSameAsExisting: PatchValuesSameAsExisting
РольНазначениеСозданиеНеудача: РольНазначениеСозданиеНеудача
РезервированиеПриказСозданиеНеудача: РезервированиеЗаказСозданиеНеудачное
ReservationOrderNotEnabled: ReservationOrderNotEnabled
CapacityUpdateScopesFailed: CapacityUpdateScopesFailed
НеподдерживаемоеРезервированиеСрок: НеподдерживаемоеРезервированиеТермин
РезервацияПорядокЯ УжеСуществует: ЗаказРезервацияЯ УжеСуществует
RiskCheckFail: RiskCheckFail
СоздатьQuoteFail: CreateQuoteFail
АктивироватьQuoteFailed: ActivateQuoteFailed
NonsupportedAccountId: NonsupportedAccountId
ПлатежИнструментНеНайденный: ПлатежИнструментНеНайденный
MissingAppliedScopesForSingle: MissingAppliedScopesForSingle
NoValidReservationsToReRate: NoValidReservationsToReRate
ReRateOnlyAllowedForEA: ReRateOnlyAllowedForEA
ОперацияНеМожет Быть ВыполненаВ Текущем Состоянии: ОперацияНеМожет Быть ВыполненаВ Текущем Состоянии
InvalidSingleAppliedScopesCount: InvalidSingleAppliedScopesCount
InvalidFulfillmentRequestParameters: InvalidFulfillmentRequestParameters
НеПоддерживаемСтрана: НеПоддерживаемСтрана
InvalidRefundQuantity: InvalidRefundQuantity
ПокупкаОшибка: ПокупкаОшибка
BillingCustomerInputОшибка: BillingCustomerInputError
BillingPaymentInstrumentSoftError: BillingPaymentInstrumentSoftError
BillingPaymentInstrumentHardError: BillingPaymentInstrumentHardError
BillingTransientError: BillingTransientError
BillingError: BillingError
FulfillmentConfigurationError: FulfillmentConfigurationError
FulfillmentOutOfStockError: FulfillmentOutOfStockError
FulfillmentTransientError: FulfillmentTransientError
FulfillmentError: FulfillmentError
РассчитатьЦенаНеудача: РассчитатьЦенаНеудача
AppliedScopesSameAsExisting: AppliedScopesSameAsExisting
СамообслуживаниеВозвратНеПоддерживается: СамообслуживаниеВозвратНеПоддерживаетсяНе Поддерживается.
Лимит возвратаПревышен: Лимит возвратаПревышен

ExchangeOperationResultStatus

Статус операции.
KnownExchangeOperationResultStatus можно использовать взаимозаменяемо с ExchangeOperationResultStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Удалось: Успешно
Failed: Неудача
Отменено: Отменено
Ожидание возвратов: Ожидание возвратов
Ожидаемые покупки: Ожидающие покупки

InstanceFlexibility

Включение этого параметра применит скидку на резервирование к другим виртуальным машинам в той же группе размеров виртуальной машины. Укажите только зарезервированный тип ресурса VirtualMachines.
knownInstanceFlexibility можно использовать взаимозаменяемо с ЭкземпляромFlexibility, эта перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Включено: На
Выключено: Выключено

OperationStatus

Состояние отдельной операции.
KnownOperationStatus можно использовать взаимозаменяемо с OperationStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Удалось: Успешно
Failed: Неудача
Отменено: Отменено
Ожидается: Ожидается

PaymentStatus

Описывает, завершен ли платеж, сбой, отмена или планирование в будущем.
KnownPaymentStatus можно использовать взаимозаменяемо с PaymentStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Удалось: Успешно
Failed: Неудача
Расписание: Запланировано
Отменено: Отменено

ProvisioningState

Представляет текущее состояние резервирования.
KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Создание: Создание
Ожидание РесурсДержание: Ожидание РесурсДержать
ПодтвержденоResourceHold: ПодтвержденоResourceHold
В ожидании счетов: В ожидании счетов
ПодтвержденоВыставление счетов: ПодтвержденоВыставление счетов
Создано: Создано
Удалось: Успешно
Отменено: Отменено
Просрочено: Просрочено
Выставление счетовПровал: Выставление счетов Неудача
Failed: Неудача
Раскол: Раскол
Объединён: Объединён

QuotaRequestState

Состояние запроса квоты.
KnownQuotaRequestState можно использовать взаимозаменяемо с QuotaRequestState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Принято: Принято
Недействительно: Недопустимо
Удалось: Успешно
Failed: Неудача
В процессе: В процессе

ReservationBillingPlan

Представляет планы выставления счетов.
KnownReservationBillingPlan можно использовать взаимозаменяемо с ReservationBillingPlan, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Вперед: Вперед
Ежемесячно: Ежемесячно

ReservationStatusCode

Тип резервацииСтатусКод

ReservationTerm

Представляет срок резервирования.
KnownReservationTerm можно использовать взаимозаменяемо с ReservationTerm, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

P1Y: P1Y
P3Y: P3Y
P5Y: P5Y

ReservedResourceType

Тип зарезервированного ресурса. В дополнение к нижеперечисленным типам мы также добавили следующие: OpenAIPTU, MDC, Sentinel.
KnownReservedResourceType можно использовать взаимозаменяемо с ReservedResourceType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

VirtualMachines: VirtualMachines
SqlDatabases: SqlDatabases
SuseLinux: SuseLinux
CosmosDb: CosmosDb
RedHat: RedHat
SqlDataWarehouse: SqlDataWarehouse
VMwareCloudSimple: VMwareCloudSimple
RedHatOsa: RedHatOsa
Databricks: Databricks
AppService: AppService
ManagedDisk: ManagedDisk
BlockBlob: BlockBlob
RedisCache: RedisCache
AzureDataExplorer: AzureDataExplorer
MySql: MySql
MariaDb: MariaDb
PostgreSql: PostgreSql
Преданный ведущий: ПреданныйХост
Сапхана: Сапхана
SqlAzureHybridBenefit: SqlAzureHybridBenefit
AVS: AVS
DataFactory: DataFactory
NetAppStorage: NetAppStorage
AzureFiles: AzureFiles
SqlEdge: SqlEdge
VirtualMachineSoftware: VirtualMachineSoftware

ResourceType

Типы ресурсов.
KnownResourceType можно использовать взаимозаменяемо с ResourceType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Стандарт: стандарт
Посвящённый: Преданный
lowPriority: lowPriority
Поделились: поделились
serviceSpecific: serviceSpecific

SavingsPlanTerm

Представляет термин плана экономии в формате ISO 8601.
KnownSavingsPlanTerm можно использовать взаимозаменяемо с SavingsPlanTerm, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

P1Y: P1Y
P3Y: P3Y

Перечисления

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.

Функции

isRestError(unknown)

Typeguard для RestError

restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

Переменные

RestError

Настраиваемый тип ошибки для неудачных запросов конвейера.

Сведения о функции

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>

Параметры

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Возвращаемое значение

PollerLike<OperationState<TResult>, TResult>

Сведения об переменной

RestError

Настраиваемый тип ошибки для неудачных запросов конвейера.

RestError: RestErrorConstructor

Тип