@azure/arm-reservations package
Classes
AzureReservationAPI |
Interfaces
AppliedReservationList |
Lista paginada de reservas aplicadas |
AppliedReservations |
A resposta para a API de reservas aplicadas |
AppliedScopeProperties |
Propriedades específicas para o tipo de escopo aplicado. Não é necessário se não for aplicável. Obrigatório e precisa fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup |
AvailableScopeProperties |
A resposta da API de escopo disponível que contém escopos e suas qualificações. |
AvailableScopeRequest |
Escopo disponível |
AvailableScopeRequestProperties |
Propriedades de solicitação de escopo disponíveis |
AzureReservationAPIOptionalParams |
Parâmetros opcionais. |
BillingInformation |
informações de cobrança |
CalculateExchange |
Interface que representa um CalculateExchange. |
CalculateExchangeOperationResultResponse |
Resultado da operação CalculateExchange |
CalculateExchangePostHeaders |
Define cabeçalhos para CalculateExchange_post operação. |
CalculateExchangePostOptionalParams |
Parâmetros opcionais. |
CalculateExchangeRequest |
Calcular solicitação de troca |
CalculateExchangeRequestProperties |
Calcular propriedades de solicitação de troca |
CalculateExchangeResponseProperties |
Calcular propriedades de resposta do Exchange |
CalculatePriceResponse |
A resposta de calcular o preço da reserva. |
CalculatePriceResponseProperties |
Propriedades para calcular a resposta de preço |
CalculatePriceResponsePropertiesBillingCurrencyTotal |
Conversor de Moedas e o valor que o cliente será cobrado na moeda local do cliente. O imposto não está incluído. |
CalculatePriceResponsePropertiesPricingCurrencyTotal |
Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. |
CalculateRefund |
Interface que representa um CalculateRefund. |
CalculateRefundPostOptionalParams |
Parâmetros opcionais. |
CalculateRefundRequest |
Solicitação que contém informações necessárias para calcular o reembolso. |
CalculateRefundRequestProperties |
Propriedades necessárias para calcular o reembolso, incluindo o escopo e a reserva a ser retornada. |
CalculateRefundResponse |
A resposta de calcular o reembolso que contém informações de reembolso da reserva |
Catalog |
Detalhes do produto de um tipo de recurso. |
CatalogMsrp |
Informações de preços sobre o sku |
CatalogsResult |
A lista de catálogos e informações de paginação. |
ChangeDirectoryRequest |
Corpo da solicitação para o diretório de alteração de uma reserva. |
ChangeDirectoryResponse |
Alterar resposta do diretório |
ChangeDirectoryResult |
Alterar o resultado do diretório para ordem de reserva ou reserva |
Commitment |
Compromisso com o benefício. |
CreateGenericQuotaRequestParameters |
Informações de solicitações de alteração de cota. |
CurrentQuotaLimit |
Limites de cota atuais. |
CurrentQuotaLimitBase |
Propriedades de cota. |
ErrorDetails |
Os detalhes do erro. |
ErrorModel |
Informações de erro |
ErrorResponse |
A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro. |
ExceptionResponse |
O erro da API. |
Exchange |
Interface que representa um Exchange. |
ExchangeOperationResultResponse |
Resultado da operação do Exchange |
ExchangePolicyError |
detalhes do erro |
ExchangePolicyErrors |
Erros de política do Exchange |
ExchangePostHeaders |
Define cabeçalhos para Exchange_post operação. |
ExchangePostOptionalParams |
Parâmetros opcionais. |
ExchangeRequest |
Solicitação do Exchange |
ExchangeRequestProperties |
Propriedades da solicitação do Exchange |
ExchangeResponseProperties |
Propriedades de resposta do Exchange |
ExtendedErrorInfo |
Informações de erro estendidas, incluindo código de erro e mensagem de erro |
ExtendedStatusInfo | |
GetAppliedReservationListOptionalParams |
Parâmetros opcionais. |
GetCatalogNextOptionalParams |
Parâmetros opcionais. |
GetCatalogOptionalParams |
Parâmetros opcionais. |
MergeRequest |
A solicitação de mesclagem de reserva |
Operation |
Interface que representa uma Operação. |
OperationDisplay |
Informações sobre uma operação |
OperationList |
Lista paginada de operações |
OperationListNextOptionalParams |
Parâmetros opcionais. |
OperationListOptionalParams |
Parâmetros opcionais. |
OperationResponse |
A resposta que contém informações de operação |
OperationResultError |
Obrigatório se o status == falhou ou o status == foi cancelado. |
Patch |
A solicitação de patch de reserva |
PatchPropertiesRenewProperties | |
PaymentDetail |
Informações sobre o pagamento relacionado a um pedido de reserva. |
Price |
Informações de preço que contêm o valor e o código de moeda |
ProxyResource |
A definição do modelo de recurso para um recurso de proxy de Resource Manager do Azure. Ele não terá marcas e um local |
PurchaseRequest |
A solicitação de compra de reserva |
PurchaseRequestPropertiesReservedResourceProperties |
Propriedades específicas para cada tipo de recurso reservado. Não é necessário se não for aplicável. |
Quota |
Interface que representa uma Cota. |
QuotaCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
QuotaGetHeaders |
Define cabeçalhos para Quota_get operação. |
QuotaGetOptionalParams |
Parâmetros opcionais. |
QuotaLimits |
Limites de cota. |
QuotaLimitsResponse |
Cotas (limites de serviço) na resposta da solicitação. |
QuotaListHeaders |
Define cabeçalhos para Quota_list operação. |
QuotaListNextHeaders |
Define cabeçalhos para Quota_listNext operação. |
QuotaListNextOptionalParams |
Parâmetros opcionais. |
QuotaListOptionalParams |
Parâmetros opcionais. |
QuotaProperties |
Propriedades de cota para o recurso. |
QuotaRequestDetails |
Detalhes da solicitação de cota. |
QuotaRequestDetailsList |
Detalhes da solicitação de cota. |
QuotaRequestOneResourceSubmitResponse |
Resposta para a solicitação de envio de cota. |
QuotaRequestProperties |
Os detalhes da solicitação de cota. |
QuotaRequestStatus |
Interface que representa um QuotaRequestStatus. |
QuotaRequestStatusGetOptionalParams |
Parâmetros opcionais. |
QuotaRequestStatusListNextOptionalParams |
Parâmetros opcionais. |
QuotaRequestStatusListOptionalParams |
Parâmetros opcionais. |
QuotaRequestSubmitResponse |
Resposta para a solicitação de envio de cota. |
QuotaRequestSubmitResponse201 |
Resposta com a ID da solicitação em que a solicitação de cota foi aceita. |
QuotaUpdateOptionalParams |
Parâmetros opcionais. |
RefundBillingInformation |
informações de cobrança |
RefundPolicyError |
detalhes do erro |
RefundPolicyResult |
Resultado da política de reembolso |
RefundPolicyResultProperty |
Propriedade de resultado da política de reembolso |
RefundRequest |
Solicitação que contém informações necessárias para retornar a reserva. |
RefundRequestProperties |
Propriedades necessárias para solicitação de reembolso, incluindo a ID da sessão de calcular o reembolso, o escopo, a reserva a ser retornada e o motivo da devolução. |
RefundResponse |
A resposta da solicitação de reembolso que contém informações de reembolso da reserva |
RefundResponseProperties |
As propriedades de reembolso da reserva |
RenewPropertiesResponse |
As propriedades de renovação de uma reserva. |
RenewPropertiesResponseBillingCurrencyTotal |
Conversor de Moedas e o valor que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído. |
RenewPropertiesResponsePricingCurrencyTotal |
Valor que a Microsoft usa para registro. Usado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Esse preço é bloqueado 30 dias antes da expiração. |
Reservation |
Interface que representa uma Reserva. |
ReservationArchiveOptionalParams |
Parâmetros opcionais. |
ReservationAvailableScopesOptionalParams |
Parâmetros opcionais. |
ReservationGetOptionalParams |
Parâmetros opcionais. |
ReservationList |
Lista de |
ReservationListAllNextOptionalParams |
Parâmetros opcionais. |
ReservationListAllOptionalParams |
Parâmetros opcionais. |
ReservationListNextOptionalParams |
Parâmetros opcionais. |
ReservationListOptionalParams |
Parâmetros opcionais. |
ReservationListRevisionsNextOptionalParams |
Parâmetros opcionais. |
ReservationListRevisionsOptionalParams |
Parâmetros opcionais. |
ReservationMergeHeaders |
Define cabeçalhos para Reservation_merge operação. |
ReservationMergeOptionalParams |
Parâmetros opcionais. |
ReservationMergeProperties |
Propriedades da mesclagem de reserva |
ReservationOrder |
Interface que representa um ReservationOrder. |
ReservationOrderBillingPlanInformation |
Informações que descrevem o tipo de plano de cobrança para essa reserva. |
ReservationOrderCalculateOptionalParams |
Parâmetros opcionais. |
ReservationOrderChangeDirectoryOptionalParams |
Parâmetros opcionais. |
ReservationOrderGetOptionalParams |
Parâmetros opcionais. |
ReservationOrderList |
Lista de |
ReservationOrderListNextOptionalParams |
Parâmetros opcionais. |
ReservationOrderListOptionalParams |
Parâmetros opcionais. |
ReservationOrderPurchaseHeaders |
Define cabeçalhos para ReservationOrder_purchase operação. |
ReservationOrderPurchaseOptionalParams |
Parâmetros opcionais. |
ReservationOrderResponse |
Detalhes de um pedido de reserva sendo retornado. |
ReservationResponse |
A definição da reserva. |
ReservationSplitHeaders |
Define cabeçalhos para Reservation_split operação. |
ReservationSplitOptionalParams |
Parâmetros opcionais. |
ReservationSplitProperties |
Propriedades da divisão de reserva |
ReservationSummary |
O resumo da contagem cumulativo de reservas em cada estado |
ReservationSwapProperties |
Propriedades da troca de reserva |
ReservationToExchange |
Detalhes do reembolso da reserva |
ReservationToPurchaseCalculateExchange |
Detalhes da compra de reserva |
ReservationToPurchaseExchange |
Detalhes da compra de reserva |
ReservationToReturn |
Reserva a ser retornada |
ReservationToReturnForExchange |
Detalhes do reembolso da reserva |
ReservationUnarchiveOptionalParams |
Parâmetros opcionais. |
ReservationUpdateHeaders |
Define cabeçalhos para Reservation_update operação. |
ReservationUpdateOptionalParams |
Parâmetros opcionais. |
ReservationUtilizationAggregates |
Os valores agregados da utilização da reserva |
ReservationsListResult |
A lista de reservas e o resumo da contagem de distribuição de reservas em cada estado. |
ReservationsProperties |
As propriedades das reservas |
ReservationsPropertiesUtilization |
Utilização de reserva |
Resource |
Campos comuns retornados na resposta para todos os recursos de Resource Manager do Azure |
ResourceName |
Nome do recurso fornecido pelo provedor de recursos. Use essa propriedade para o parâmetro quotaRequest. |
Return |
Interface que representa um Return. |
ReturnPostHeaders |
Define cabeçalhos para Return_post operação. |
ReturnPostOptionalParams |
Parâmetros opcionais. |
SavingsPlanPurchaseRequest |
Corpo da solicitação para compra do plano de economia |
SavingsPlanToPurchaseCalculateExchange |
Detalhes de compra do plano de economia |
SavingsPlanToPurchaseExchange |
Detalhes de compra do plano de economia |
ScopeProperties |
O escopo e se ele é válido. |
ServiceError |
Os detalhes do erro da API. |
ServiceErrorDetail |
Os detalhes do erro. |
SkuCapability |
Capacidade de um sku. |
SkuName |
O nome do sku |
SkuProperty |
Propriedade de um sku. |
SkuRestriction |
Restrição de um sku. |
SplitRequest |
A solicitação de divisão de reserva |
SubRequest |
A subprojeta enviada com a solicitação de cota. |
SubscriptionScopeProperties |
Os escopos verificados pela API de escopo disponível. |
SystemData |
Metadados relativos à criação e à última modificação do recurso. |
Aliases de tipo
AppliedScopeType |
Define valores para AppliedScopeType. Valores conhecidos compatíveis com o serviçoSingle |
BillingPlan |
Define valores para BillingPlan. Valores conhecidos compatíveis com o serviçoP1M |
CalculateExchangeOperationResultStatus |
Define valores para CalculateExchangeOperationResultStatus. Valores conhecidos compatíveis com o serviçoÊxito |
CalculateExchangePostResponse |
Contém dados de resposta para a operação de postagem. |
CalculateRefundPostResponse |
Contém dados de resposta para a operação de postagem. |
CommitmentGrain |
Define valores para CommitmentGrain. Valores conhecidos compatíveis com o serviçoA cada hora |
CreatedByType |
Define valores para CreatedByType. Valores conhecidos compatíveis com o serviçoUsuário |
DisplayProvisioningState |
Define valores para DisplayProvisioningState. Valores conhecidos compatíveis com o serviçoÊxito |
ErrorResponseCode |
Define valores para ErrorResponseCode. Valores conhecidos compatíveis com o serviçoNotSpecified |
ExchangeOperationResultStatus |
Define valores para ExchangeOperationResultStatus. Valores conhecidos compatíveis com o serviçoÊxito |
ExchangePostResponse |
Contém dados de resposta para a operação de postagem. |
GetAppliedReservationListResponse |
Contém dados de resposta para a operação getAppliedReservationList. |
GetCatalogNextResponse |
Contém dados de resposta para a operação getCatalogNext. |
GetCatalogResponse |
Contém dados de resposta para a operação getCatalog. |
InstanceFlexibility |
Define valores para InstanceFlexibility. Valores conhecidos compatíveis com o serviçoAtivado |
Location |
Define valores para Location. Valores conhecidos compatíveis com o serviçowestus |
OperationListNextResponse |
Contém dados de resposta para a operação listNext. |
OperationListResponse |
Contém dados de resposta para a operação de lista. |
OperationStatus |
Define valores para OperationStatus. Valores conhecidos compatíveis com o serviçoÊxito |
PaymentStatus |
Define valores para PaymentStatus. Valores conhecidos compatíveis com o serviçoÊxito |
ProvisioningState |
Define valores para ProvisioningState. Valores conhecidos compatíveis com o serviçoCriando |
QuotaCreateOrUpdateResponse |
Contém dados de resposta para a operação createOrUpdate. |
QuotaGetResponse |
Contém dados de resposta para a operação get. |
QuotaListNextResponse |
Contém dados de resposta para a operação listNext. |
QuotaListResponse |
Contém dados de resposta para a operação de lista. |
QuotaRequestState |
Define valores para QuotaRequestState. Valores conhecidos compatíveis com o serviçoAceito |
QuotaRequestStatusGetResponse |
Contém dados de resposta para a operação get. |
QuotaRequestStatusListNextResponse |
Contém dados de resposta para a operação listNext. |
QuotaRequestStatusListResponse |
Contém dados de resposta para a operação de lista. |
QuotaUpdateResponse |
Contém dados de resposta para a operação de atualização. |
ReservationAvailableScopesResponse |
Contém dados de resposta para a operação availableScopes. |
ReservationBillingPlan |
Define valores para ReservationBillingPlan. Valores conhecidos compatíveis com o serviçoUpfront |
ReservationGetResponse |
Contém dados de resposta para a operação get. |
ReservationListAllNextResponse |
Contém dados de resposta para a operação listAllNext. |
ReservationListAllResponse |
Contém dados de resposta para a operação listAll. |
ReservationListNextResponse |
Contém dados de resposta para a operação listNext. |
ReservationListResponse |
Contém dados de resposta para a operação de lista. |
ReservationListRevisionsNextResponse |
Contém dados de resposta para a operação listRevisionsNext. |
ReservationListRevisionsResponse |
Contém dados de resposta para a operação listRevisions. |
ReservationMergeResponse |
Contém dados de resposta para a operação de mesclagem. |
ReservationOrderCalculateResponse |
Contém dados de resposta para a operação de cálculo. |
ReservationOrderChangeDirectoryResponse |
Contém dados de resposta para a operação changeDirectory. |
ReservationOrderGetResponse |
Contém dados de resposta para a operação get. |
ReservationOrderListNextResponse |
Contém dados de resposta para a operação listNext. |
ReservationOrderListResponse |
Contém dados de resposta para a operação de lista. |
ReservationOrderPurchaseResponse |
Contém dados de resposta para a operação de compra. |
ReservationSplitResponse |
Contém dados de resposta para a operação de divisão. |
ReservationStatusCode |
Define valores para ReservationStatusCode. Valores conhecidos compatíveis com o serviçoNenhuma |
ReservationTerm |
Define valores para ReservationTerm. Valores conhecidos compatíveis com o serviçoP1Y |
ReservationUpdateResponse |
Contém dados de resposta para a operação de atualização. |
ReservedResourceType |
Define valores para ReservedResourceType. Valores conhecidos compatíveis com o serviçoVirtualMachines |
ResourceType |
Define valores para ResourceType. Valores conhecidos compatíveis com o serviçostandard |
ReturnPostResponse |
Contém dados de resposta para a operação de postagem. |
SavingsPlanTerm |
Define valores para SavingsPlanTerm. Valores conhecidos compatíveis com o serviçoP1Y |
UserFriendlyAppliedScopeType |
Define valores para UserFriendlyAppliedScopeType. Valores conhecidos compatíveis com o serviçoNenhuma |
UserFriendlyRenewState |
Define valores para UserFriendlyRenewState. Valores conhecidos compatíveis com o serviçoAtivado |
Enumerações
KnownAppliedScopeType |
Valores conhecidos de AppliedScopeType que o serviço aceita. |
KnownBillingPlan |
Valores conhecidos de BillingPlan que o serviço aceita. |
KnownCalculateExchangeOperationResultStatus |
Valores conhecidos de CalculateExchangeOperationResultStatus que o serviço aceita. |
KnownCommitmentGrain |
Valores conhecidos de CommitmentGrain que o serviço aceita. |
KnownCreatedByType |
Valores conhecidos de CreatedByType que o serviço aceita. |
KnownDisplayProvisioningState |
Valores conhecidos de DisplayProvisioningState que o serviço aceita. |
KnownErrorResponseCode |
Valores conhecidos de ErrorResponseCode que o serviço aceita. |
KnownExchangeOperationResultStatus |
Valores conhecidos de ExchangeOperationResultStatus que o serviço aceita. |
KnownInstanceFlexibility |
Valores conhecidos de InstanceFlexibility que o serviço aceita. |
KnownLocation |
Valores conhecidos de Localização que o serviço aceita. |
KnownOperationStatus |
Valores conhecidos de OperationStatus que o serviço aceita. |
KnownPaymentStatus |
Valores conhecidos de PaymentStatus que o serviço aceita. |
KnownProvisioningState |
Valores conhecidos de ProvisioningState que o serviço aceita. |
KnownQuotaRequestState |
Valores conhecidos de QuotaRequestState que o serviço aceita. |
KnownReservationBillingPlan |
Valores conhecidos de ReservationBillingPlan que o serviço aceita. |
KnownReservationStatusCode |
Valores conhecidos de ReservationStatusCode que o serviço aceita. |
KnownReservationTerm |
Valores conhecidos de ReservationTerm que o serviço aceita. |
KnownReservedResourceType |
Valores conhecidos de ReservedResourceType que o serviço aceita. |
KnownResourceType |
Valores conhecidos de ResourceType que o serviço aceita. |
KnownSavingsPlanTerm |
Valores conhecidos de SavingsPlanTerm que o serviço aceita. |
KnownUserFriendlyAppliedScopeType |
Valores conhecidos de UserFriendlyAppliedScopeType que o serviço aceita. |
KnownUserFriendlyRenewState |
Valores conhecidos de UserFriendlyRenewState que o serviço aceita. |
Funções
get |
Dado o último |
Detalhes da função
getContinuationToken(unknown)
Dado o último .value
produzido pelo byPage
iterador, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.
function getContinuationToken(page: unknown): string | undefined
Parâmetros
- page
-
unknown
Um objeto de acesso value
no IteratorResult de um byPage
iterador.
Retornos
string | undefined
O token de continuação que pode ser passado porPage() durante chamadas futuras.