@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 do tipo de âmbito aplicado. Não é necessário se não for aplicável. Necessário e necessário para fornecer tenantId e managementGroupId se AppliedScopeType for ManagementGroup |
AvailableScopeProperties |
A resposta da API de âmbito disponível que contém âmbitos e respetivas elegibilidades. |
AvailableScopeRequest |
Âmbito disponível |
AvailableScopeRequestProperties |
Propriedades de pedido de âmbito disponíveis |
AzureReservationAPIOptionalParams |
Parâmetros opcionais. |
BillingInformation |
informações de faturação |
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 pedido de troca |
CalculateExchangeRequestProperties |
Calcular as propriedades do pedido de troca |
CalculateExchangeResponseProperties |
Propriedades de resposta CalculateExchange |
CalculatePriceResponse |
A resposta do preço de cálculo da reserva. |
CalculatePriceResponseProperties |
Propriedades para calcular a resposta ao preço |
CalculatePriceResponsePropertiesBillingCurrencyTotal |
Moeda e montante que o cliente será cobrado na moeda local do cliente. O imposto não está incluído. |
CalculatePriceResponsePropertiesPricingCurrencyTotal |
Montante que a Microsoft utiliza para registo. Utilizado 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 |
Pedido que contém as informações necessárias para calcular o reembolso. |
CalculateRefundRequestProperties |
Propriedades necessárias para calcular o reembolso, incluindo o âmbito e a reserva a devolver. |
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 do pedido para alterar o diretório de uma reserva. |
ChangeDirectoryResponse |
Alterar resposta do diretório |
ChangeDirectoryResult |
Alterar o resultado do diretório para a encomenda de reserva ou reserva |
Commitment |
Compromisso com o benefício. |
CreateGenericQuotaRequestParameters |
Informações sobre pedidos de alteração de quota. |
CurrentQuotaLimit |
Limites de quota atuais. |
CurrentQuotaLimitBase |
Propriedades de quota. |
ErrorDetails |
Os detalhes do erro. |
ErrorModel |
Informações de erro |
ErrorResponse |
A resposta de erro indica que o serviço não consegue processar o pedido recebido. 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 |
Pedido do Exchange |
ExchangeRequestProperties |
Propriedades do pedido do Exchange |
ExchangeResponseProperties |
Propriedades de resposta do Exchange |
ExtendedErrorInfo |
Informações de erro expandidas, incluindo código de erro e mensagem de erro |
ExtendedStatusInfo | |
GetAppliedReservationListOptionalParams |
Parâmetros opcionais. |
GetCatalogNextOptionalParams |
Parâmetros opcionais. |
GetCatalogOptionalParams |
Parâmetros opcionais. |
MergeRequest |
O pedido de impressão em série de reservas |
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 as informações da operação |
OperationResultError |
Necessário se o estado == falhou ou o estado == foi cancelado. |
Patch |
O pedido de patch de reserva |
PatchPropertiesRenewProperties | |
PaymentDetail |
Informações sobre o pagamento relacionados com uma encomenda de reserva. |
Price |
Informações de preços que contêm o montante e o código de moeda |
ProxyResource |
A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Não terá etiquetas nem uma localização |
PurchaseRequest |
O pedido de compra de reserva |
PurchaseRequestPropertiesReservedResourceProperties |
Propriedades específicas de cada tipo de recurso reservado. Não é necessário se não for aplicável. |
Quota |
Interface que representa uma Quota. |
QuotaCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
QuotaGetHeaders |
Define cabeçalhos para Quota_get operação. |
QuotaGetOptionalParams |
Parâmetros opcionais. |
QuotaLimits |
Limites de quota. |
QuotaLimitsResponse |
Quotas (limites de serviço) na resposta do pedido. |
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 quota para o recurso. |
QuotaRequestDetails |
Detalhes do pedido de quota. |
QuotaRequestDetailsList |
Detalhes do pedido de quota. |
QuotaRequestOneResourceSubmitResponse |
Resposta para o pedido de submissão de quota. |
QuotaRequestProperties |
Os detalhes do pedido de quota. |
QuotaRequestStatus |
Interface que representa uma QuotaRequestStatus. |
QuotaRequestStatusGetOptionalParams |
Parâmetros opcionais. |
QuotaRequestStatusListNextOptionalParams |
Parâmetros opcionais. |
QuotaRequestStatusListOptionalParams |
Parâmetros opcionais. |
QuotaRequestSubmitResponse |
Resposta para o pedido de submissão de quota. |
QuotaRequestSubmitResponse201 |
Resposta com o ID do pedido a indicar que o pedido de quota foi aceite. |
QuotaUpdateOptionalParams |
Parâmetros opcionais. |
RefundBillingInformation |
informações de faturação |
RefundPolicyError |
detalhes do erro |
RefundPolicyResult |
Resultado da política de reembolso |
RefundPolicyResultProperty |
Propriedade do resultado da política de reembolso |
RefundRequest |
Pedido que contém as informações necessárias para devolver a reserva. |
RefundRequestProperties |
Propriedades necessárias para o pedido de reembolso, incluindo o ID da sessão de calcular o reembolso, o âmbito, a reserva a devolver e o motivo da devolução. |
RefundResponse |
A resposta do pedido 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 |
Moeda e montante a que o cliente será cobrado na moeda local do cliente para compra de renovação. O imposto não está incluído. |
RenewPropertiesResponsePricingCurrencyTotal |
Montante que a Microsoft utiliza para registo. Utilizado durante o reembolso para calcular o limite de reembolso. O imposto não está incluído. Este preço está bloqueado 30 dias antes de expirar. |
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 intercalação de reservas |
ReservationOrder |
Interface que representa uma ReservationOrder. |
ReservationOrderBillingPlanInformation |
Informações que descrevem o tipo de plano de faturação para esta 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 uma encomenda de reserva a ser devolvida. |
ReservationResponse |
A definição da reserva. |
ReservationSplitHeaders |
Define cabeçalhos para Reservation_split operação. |
ReservationSplitOptionalParams |
Parâmetros opcionais. |
ReservationSplitProperties |
Propriedades da divisão da reserva |
ReservationSummary |
O resumo da contagem de roll-up das reservas em cada estado |
ReservationSwapProperties |
Propriedades da troca de reserva |
ReservationToExchange |
Detalhes do reembolso da reserva |
ReservationToPurchaseCalculateExchange |
Detalhes da compra da reserva |
ReservationToPurchaseExchange |
Detalhes da compra da reserva |
ReservationToReturn |
Reserva a devolver |
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 implementações de reservas em cada estado. |
ReservationsProperties |
As propriedades das reservas |
ReservationsPropertiesUtilization |
Utilização da reserva |
Resource |
Campos comuns que são devolvidos na resposta para todos os recursos do Azure Resource Manager |
ResourceName |
Nome do recurso fornecido pelo fornecedor de recursos. Utilize esta propriedade para o parâmetro quotaRequest. |
Return |
Interface que representa uma Devolução. |
ReturnPostHeaders |
Define cabeçalhos para Return_post operação. |
ReturnPostOptionalParams |
Parâmetros opcionais. |
SavingsPlanPurchaseRequest |
Corpo do pedido para compra do plano de poupança |
SavingsPlanToPurchaseCalculateExchange |
Detalhes da compra do plano de poupança |
SavingsPlanToPurchaseExchange |
Detalhes da compra do plano de poupança |
ScopeProperties |
O âmbito e se é 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 |
O pedido de divisão da reserva |
SubRequest |
O sub-pedido submetido com o pedido de quota. |
SubscriptionScopeProperties |
Os âmbitos verificados pela aPI de âmbito disponível. |
SystemData |
Metadados relativos à criação e última modificação do recurso. |
Aliases de Tipo
AppliedScopeType |
Define valores para AppliedScopeType. Valores conhecidos suportados pelo serviçoÚnico |
BillingPlan |
Define valores para BillingPlan. Valores conhecidos suportados pelo serviçoP1M |
CalculateExchangeOperationResultStatus |
Define valores para CalculateExchangeOperationResultStatus. Valores conhecidos suportados pelo serviçoCom êxito |
CalculateExchangePostResponse |
Contém dados de resposta para a operação pós-publicação. |
CalculateRefundPostResponse |
Contém dados de resposta para a operação pós-publicação. |
CommitmentGrain |
Define valores para CommitmentGrain. Valores conhecidos suportados pelo serviçoHora a hora |
CreatedByType |
Define valores para CreatedByType. Valores conhecidos suportados pelo serviçoUtilizador |
DisplayProvisioningState |
Define valores para DisplayProvisioningState. Valores conhecidos suportados pelo serviçoCom êxito |
ErrorResponseCode |
Define valores para ErrorResponseCode. Valores conhecidos suportados pelo serviçoNão Indicado |
ExchangeOperationResultStatus |
Define valores para ExchangeOperationResultStatus. Valores conhecidos suportados pelo serviçoCom êxito |
ExchangePostResponse |
Contém dados de resposta para a operação pós-publicação. |
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 suportados pelo serviçoAtivado |
Location |
Define valores para Localização. Valores conhecidos suportados pelo 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 suportados pelo serviçoCom êxito |
PaymentStatus |
Define valores para PaymentStatus. Valores conhecidos suportados pelo serviçoCom êxito |
ProvisioningState |
Define valores para ProvisioningState. Valores conhecidos suportados pelo serviçoCriação |
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 suportados pelo serviçoAceite |
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 suportados pelo serviçoAntecipadamente |
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 intercalação. |
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 suportados pelo serviçoNenhuma |
ReservationTerm |
Define valores para ReservationTerm. Valores conhecidos suportados pelo serviçoP1Y |
ReservationUpdateResponse |
Contém dados de resposta para a operação de atualização. |
ReservedResourceType |
Define valores para ReservedResourceType. Valores conhecidos suportados pelo serviçoVirtualMachines |
ResourceType |
Define valores para ResourceType. Valores conhecidos suportados pelo serviçopadrão |
ReturnPostResponse |
Contém dados de resposta para a operação pós-publicação. |
SavingsPlanTerm |
Define valores para SavingsPlanTerm. Valores conhecidos suportados pelo serviçoP1Y |
UserFriendlyAppliedScopeType |
Define valores para UserFriendlyAppliedScopeType. Valores conhecidos suportados pelo serviçoNenhuma |
UserFriendlyRenewState |
Define valores para UserFriendlyRenewState. Valores conhecidos suportados pelo 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 de Função
getContinuationToken(unknown)
Dado o último .value
produzido pelo byPage
iterador, devolve um token de continuação que pode ser utilizado para começar 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 a partir de um byPage
iterador.
Devoluções
string | undefined
O token de continuação que pode ser transmitido para byPage() durante futuras chamadas.