@azure/arm-reservations package
Classes
| AzureReservationAPI |
Interfaces
| AppliedReservationList |
Lista paginada de reservas aplicadas |
| AppliedReservations |
A resposta para a API de reservas aplicadas |
| AppliedReservationsProperties |
Propriedades para reservas aplicadas retornadas |
| AppliedScopeProperties |
Propriedades específicas para o tipo de escopo 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 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 para o cliente. |
| BillingInformation |
informações de cobrança |
| CalculateExchangeOperationResultResponse |
Calcular o resultado da operação Doxchange |
| CalculateExchangeOperations |
Interface representando operações do CalculateExchange. |
| 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 |
Moeda e 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. |
| CalculateRefundOperations |
Interface representando operações do CalculateRefund. |
| CalculateRefundPostOptionalParams |
Parâmetros opcionais. |
| CalculateRefundRequest |
Solicitação contendo 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 do cálculo do reembolso que contém informações de reembolso da reserva |
| Catalog |
Detalhes do produto de um tipo de recurso. |
| CatalogMsrp |
Informações sobre preços sobre o sku |
| ChangeDirectoryRequest |
Corpo da solicitação para alterar o diretório de uma reserva. |
| ChangeDirectoryResponse |
Alterar a resposta do diretório |
| ChangeDirectoryResult |
Alterar o resultado do diretório para ordem de reserva ou reserva |
| Commitment |
Compromisso com o benefício. |
| 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. |
| ExchangeOperationResultResponse |
Resultado da operação do Exchange |
| ExchangeOperations |
Interface representando operações de Exchange. |
| ExchangePolicyError |
detalhes do erro |
| ExchangePolicyErrors |
Erros de política do Exchange |
| ExchangePostOptionalParams |
Parâmetros opcionais. |
| ExchangeRequest |
Solicitação do Exchange |
| ExchangeRequestProperties |
Propriedades de 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 |
interface de modelo EstendidaInformaçãoStatusT |
| GetAppliedReservationListOptionalParams |
Parâmetros opcionais. |
| GetCatalogOptionalParams |
Parâmetros opcionais. |
| MergeProperties |
Propriedades para fusão de reservas |
| MergeRequest |
A solicitação de mesclagem de reserva |
| OperationDisplay |
Informações sobre uma operação |
| OperationListOptionalParams |
Parâmetros opcionais. |
| OperationOperations |
Interface representando operações de operação. |
| OperationResponse |
A resposta que contém informações de operação |
| OperationResultError |
Obrigatório se o status == falhou ou o status == cancelado. |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página. |
| Patch |
A solicitação de patch de reserva |
| PatchProperties |
Propriedades para o patch de reserva |
| PatchPropertiesRenewProperties |
interface do modelo PatchPropertiesRenewProperties |
| PaymentDetail |
Informações sobre o pagamento relacionadas a um pedido de reserva. |
| Price |
Informações de preços que contêm o valor e o código de moeda |
| ProxyResource |
A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local |
| PurchaseRequest |
A solicitação de compra de reserva |
| PurchaseRequestProperties |
Propriedades da 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. |
| QuotaCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| QuotaGetOptionalParams |
Parâmetros opcionais. |
| QuotaListOptionalParams |
Parâmetros opcionais. |
| QuotaOperations |
Interface que representa uma operação de cota. |
| QuotaProperties |
Propriedades de cota para o recurso. |
| QuotaRequestDetails |
Detalhes da solicitação de cota. |
| QuotaRequestProperties |
Os detalhes da solicitação de cota. |
| QuotaRequestStatusGetOptionalParams |
Parâmetros opcionais. |
| QuotaRequestStatusListOptionalParams |
Parâmetros opcionais. |
| QuotaRequestStatusOperations |
Interface que representa uma operação QuotaRequestStatus. |
| 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 do retorno. |
| RefundResponseProperties |
As propriedades de reembolso da reserva |
| RenewPropertiesResponse |
As propriedades de renovação de uma reserva. |
| RenewPropertiesResponseBillingCurrencyTotal |
Moeda e 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. |
| ReservationArchiveOptionalParams |
Parâmetros opcionais. |
| ReservationAvailableScopesOptionalParams |
Parâmetros opcionais. |
| ReservationGetOptionalParams |
Parâmetros opcionais. |
| ReservationListAllOptionalParams |
Parâmetros opcionais. |
| ReservationListOptionalParams |
Parâmetros opcionais. |
| ReservationListRevisionsOptionalParams |
Parâmetros opcionais. |
| ReservationMergeOptionalParams |
Parâmetros opcionais. |
| ReservationMergeProperties |
Propriedades da mesclagem de reserva |
| ReservationOperations |
Interface representando uma operação de Reserva. |
| 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. |
| ReservationOrderListOptionalParams |
Parâmetros opcionais. |
| ReservationOrderOperations |
Interface representando operações de Ordem de Reserva. |
| ReservationOrderProperties |
Propriedades de uma ordem de reserva. |
| ReservationOrderPurchaseOptionalParams |
Parâmetros opcionais. |
| ReservationOrderResponse |
Detalhes de um pedido de reserva sendo retornado. |
| ReservationResponse |
A definição da reserva. |
| 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 da reserva |
| ReservationToPurchaseExchange |
Detalhes da compra da reserva |
| ReservationToReturn |
Reserva a ser retornada |
| ReservationToReturnForExchange |
Detalhes do reembolso da reserva |
| ReservationUnarchiveOptionalParams |
Parâmetros opcionais. |
| ReservationUpdateOptionalParams |
Parâmetros opcionais. |
| ReservationUtilizationAggregates |
Os valores agregados da utilização da reserva |
| ReservationsProperties |
As propriedades das reservas |
| ReservationsPropertiesUtilization |
Utilização da reserva |
| Resource |
Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager |
| ResourceName |
Nome do recurso fornecido pelo provedor de recursos. Use essa propriedade para o parâmetro quotaRequest. |
| RestorePollerOptions | |
| ReturnOperations |
Interface representando uma operação de retorno. |
| ReturnPostOptionalParams |
Parâmetros opcionais. |
| SavingsPlanPurchaseRequest |
Corpo da solicitação para compra do plano de poupança |
| SavingsPlanPurchaseRequestProperties |
Propriedades de um plano de poupança para compra |
| SavingsPlanToPurchaseCalculateExchange |
Detalhes da compra do plano de poupança |
| SavingsPlanToPurchaseExchange |
Detalhes da compra do plano de poupança |
| ScopeProperties |
O escopo e se ele é válido. |
| ServiceError |
Os detalhes do erro da API. |
| ServiceErrorDetail |
Os detalhes do erro. |
| SimplePollerLike |
Um sondador simples que pode ser usado para sondar uma operação de longa execução. |
| SkuCapability |
Funcionalidade de um sku. |
| SkuName |
O nome do sku |
| SkuProperty |
Propriedade de um sku. |
| SkuRestriction |
Restrição de um sku. |
| SplitProperties |
Propriedades para divisão de reservas |
| 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 |
Tipo do Escopo Aplicado. Valores conhecidos compatíveis com o serviço
Single: Single |
| AzureSupportedClouds |
Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres |
| BillingPlan |
Representa o plano de cobrança no formato ISO 8601. Necessário apenas para planos de cobrança mensais. Valores conhecidos compatíveis com o serviçoP1M: P1M |
| CalculateExchangeOperationResultStatus |
Status da operação. Valores conhecidos compatíveis com o serviço
Sucesso: Sucessor |
| CommitmentGrain |
Grãos de compromisso. Valores conhecidos compatíveis com o serviçoHorista: Horista |
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| CreatedByType |
O tipo de entidade que criou o recurso. Valores conhecidos compatíveis com o serviço
User: a entidade foi criada por um usuário. |
| ErrorResponseCode |
Código de erro descrevendo o motivo pelo qual o serviço não consegue processar a solicitação recebida Valores conhecidos compatíveis com o serviço
NotSspecificified: NotSpecified |
| ExchangeOperationResultStatus |
Status da operação. Valores conhecidos compatíveis com o serviço
Sucesso: Sucessor |
| InstanceFlexibility |
Ativar isso aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines. Valores conhecidos compatíveis com o serviço
Ligado: Ligado |
| OperationStatus |
Status da operação individual. Valores conhecidos compatíveis com o serviço
Sucesso: Sucessor |
| PaymentStatus |
Descreve se o pagamento foi concluído, com falha, cancelado ou agendado no futuro. Valores conhecidos compatíveis com o serviço
Sucesso: Sucessor |
| ProvisioningState |
Represente o estado atual da Reserva. Valores conhecidos compatíveis com o serviço
Criando: Criando |
| QuotaRequestState |
O status da solicitação de cota. Valores conhecidos compatíveis com o serviço
Aceito: Aceito |
| ReservationBillingPlan |
Represente os planos de cobrança. Valores conhecidos compatíveis com o serviço
Direto: Direto |
| ReservationStatusCode |
Tipo de Código de Status de Reserva |
| ReservationTerm |
Represente o termo de reserva. Valores conhecidos compatíveis com o serviço
P1Y: P1Y |
| ReservedResourceType |
O tipo do recurso que está sendo reservado. Além dos tipos abaixo, também adicionamos o seguinte: OpenAIPTU, MDC, Sentinel. Valores conhecidos compatíveis com o serviço
Máquinas Virtuais: Máquinas Virtuais |
| ResourceType |
Os tipos de recursos. Valores conhecidos compatíveis com o serviço
Padrão: Padrão |
| SavingsPlanTerm |
Represente o termo do plano de poupança no formato ISO 8601. Valores conhecidos compatíveis com o serviço
P1Y: P1Y |
Enumerações
| AzureClouds |
Um enumeração para descrever os ambientes de nuvem do Azure. |
| KnownAppliedScopeType |
Tipo do Escopo Aplicado. |
| KnownBillingPlan |
Representa o plano de cobrança no formato ISO 8601. Necessário apenas para planos de cobrança mensais. |
| KnownCalculateExchangeOperationResultStatus |
Status da operação. |
| KnownCommitmentGrain |
Grãos de compromisso. |
| KnownCreatedByType |
O tipo de entidade que criou o recurso. |
| KnownErrorResponseCode |
Código de erro que descreve o motivo pelo qual o serviço não é capaz de processar a solicitação de entrada |
| KnownExchangeOperationResultStatus |
Status da operação. |
| KnownInstanceFlexibility |
Ativar isso aplicará o desconto de reserva a outras VMs no mesmo grupo de tamanho de VM. Especifique apenas para o tipo de recurso reservado VirtualMachines. |
| KnownOperationStatus |
Status da operação individual. |
| KnownPaymentStatus |
Descreve se o pagamento foi concluído, com falha, cancelado ou agendado no futuro. |
| KnownProvisioningState |
Represente o estado atual da Reserva. |
| KnownQuotaRequestState |
O status da solicitação de cota. |
| KnownReservationBillingPlan |
Represente os planos de cobrança. |
| KnownReservationStatusCode |
Valores conhecidos de ReservationStatusCode que o serviço aceita. |
| KnownReservationTerm |
Represente o termo de reserva. |
| KnownReservedResourceType |
O tipo do recurso que está sendo reservado. Além dos tipos abaixo, também adicionamos o seguinte: OpenAIPTU, MDC, Sentinel. |
| KnownResourceType |
Os tipos de recursos. |
| KnownSavingsPlanTerm |
Represente o termo do plano de poupança no formato ISO 8601. |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes da função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parâmetros
- e
-
unknown
Algo pego por uma cláusula catch.
Retornos
e
restorePoller<TResponse, TResult>(AzureReservationAPI, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um sondador do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondadores em um host diferente ou um sondador precisa ser construído depois que o original não estiver no escopo.
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>
Retornos
PollerLike<OperationState<TResult>, TResult>
Detalhes da variável
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor