@azure/arm-consumption package

Classes

ConsumptionManagementClient

Interfaces

AggregatedCost

Interface que representa um AggregatedCost.

AggregatedCostGetByManagementGroupOptionalParams

Parâmetros opcionais.

AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams

Parâmetros opcionais.

Amount

O montante mais a moeda .

AmountWithExchangeRate

O montante com taxa de câmbio.

Balance

Um recurso de equilíbrio.

BalancePropertiesAdjustmentDetailsItem
BalancePropertiesNewPurchasesDetailsItem
Balances

Interface que representa um Saldos.

BalancesGetByBillingAccountOptionalParams

Parâmetros opcionais.

BalancesGetForBillingPeriodByBillingAccountOptionalParams

Parâmetros opcionais.

Budget

Um recurso orçamental.

BudgetComparisonExpression

A expressão de comparação a utilizar nos orçamentos.

BudgetFilter

Pode ser utilizado para filtrar orçamentos por grupo de recursos, recurso ou medidor.

BudgetFilterProperties

As Dimensões ou Etiquetas para filtrar um orçamento.

BudgetTimePeriod

A data de início e de fim de um orçamento.

Budgets

Interface que representa orçamentos.

BudgetsCreateOrUpdateOptionalParams

Parâmetros opcionais.

BudgetsDeleteOptionalParams

Parâmetros opcionais.

BudgetsGetOptionalParams

Parâmetros opcionais.

BudgetsListNextOptionalParams

Parâmetros opcionais.

BudgetsListOptionalParams

Parâmetros opcionais.

BudgetsListResult

Resultado da listagem de orçamentos. Contém uma lista de orçamentos disponíveis no âmbito fornecido.

ChargeSummary

Um recurso de resumo de custos.

Charges

Interface que representa um Custo.

ChargesListOptionalParams

Parâmetros opcionais.

ChargesListResult

Resultado da listagem do resumo dos custos.

ConsumptionManagementClientOptionalParams

Parâmetros opcionais.

CreditBalanceSummary

Resumo dos saldos de crédito.

CreditSummary

Um recurso de resumo de crédito.

Credits

Interface que representa um Créditos.

CreditsGetOptionalParams

Parâmetros opcionais.

CurrentSpend

O montante atual do custo que está a ser monitorizado para um orçamento.

DownloadProperties

As propriedades da transferência da folha de preços.

ErrorDetails

Os detalhes do erro.

ErrorResponse

A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 429 TooManyRequests - O pedido é limitado. Repita depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

EventSummary

Um recurso de resumo de eventos.

Events

Resultado da listagem do resumo do evento.

EventsListByBillingAccountNextOptionalParams

Parâmetros opcionais.

EventsListByBillingAccountOptionalParams

Parâmetros opcionais.

EventsListByBillingProfileNextOptionalParams

Parâmetros opcionais.

EventsListByBillingProfileOptionalParams

Parâmetros opcionais.

EventsOperations

Interface que representa um EventsOperations.

ForecastSpend

O custo previsto que está a ser controlado para um orçamento.

HighCasedErrorDetails

Os detalhes do erro.

HighCasedErrorResponse

A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

  • 429 TooManyRequests – o pedido é limitado. Repita depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

LegacyChargeSummary

Resumo dos custos legados.

LegacyReservationRecommendation

Recomendação de reserva legada.

LegacyReservationRecommendationProperties

As propriedades da recomendação de reserva.

LegacyReservationTransaction

Recurso de transação de Reserva Legada.

LegacySharedScopeReservationRecommendationProperties

As propriedades da recomendação de reserva legada para o âmbito partilhado.

LegacySingleScopeReservationRecommendationProperties

As propriedades da recomendação de reserva legada para o âmbito único.

LegacyUsageDetail

Detalhes de utilização legados.

LotSummary

Muitos recursos de resumo.

Lots

Resultado da listagem do resumo do lote.

LotsListByBillingAccountNextOptionalParams

Parâmetros opcionais.

LotsListByBillingAccountOptionalParams

Parâmetros opcionais.

LotsListByBillingProfileNextOptionalParams

Parâmetros opcionais.

LotsListByBillingProfileOptionalParams

Parâmetros opcionais.

LotsOperations

Interface que representa um LotsOperations.

ManagementGroupAggregatedCostResult

Um recurso de custo agregado de grupo de gestão.

Marketplace

Um recurso do marketplace.

Marketplaces

Interface que representa um Marketplaces.

MarketplacesListNextOptionalParams

Parâmetros opcionais.

MarketplacesListOptionalParams

Parâmetros opcionais.

MarketplacesListResult

Resultado da listagem de marketplaces. Contém uma lista de marketplaces disponíveis por ordem cronológica inversa por período de faturação.

MeterDetails

As propriedades do detalhe do medidor.

MeterDetailsResponse

As propriedades do detalhe do medidor.

ModernChargeSummary

Resumo dos custos modernos.

ModernReservationRecommendation

Recomendação de reserva moderna.

ModernReservationTransaction

Recurso de transação de Reserva Moderna.

ModernReservationTransactionsListResult

Resultado da listagem de recomendações de reservas.

ModernUsageDetail

Detalhes de utilização modernos.

Notification

A notificação associada a um orçamento.

Operation

Uma operação de API REST de Consumo.

OperationDisplay

O objeto que representa a operação.

OperationListResult

Resultado da listagem de operações de consumo. Contém uma lista de operações e uma ligação de URL para obter o próximo conjunto de resultados.

Operations

Interface que representa uma Operação.

OperationsListNextOptionalParams

Parâmetros opcionais.

OperationsListOptionalParams

Parâmetros opcionais.

PriceSheet

Interface que representa uma Folha de Preços.

PriceSheetGetByBillingPeriodOptionalParams

Parâmetros opcionais.

PriceSheetGetOptionalParams

Parâmetros opcionais.

PriceSheetProperties

As propriedades da folha de preços.

PriceSheetResult

Um recurso de folha de preços.

ProxyResource

A definição modelo de recurso.

Reseller

As propriedades do revendedor.

ReservationDetail

recurso de detalhe de reserva.

ReservationDetailsListResult

Resultado da listagem de detalhes da reserva.

ReservationRecommendation

Um recurso de recomendação de reserva.

ReservationRecommendationDetails

Interface que representa uma ReservationRecommendationDetails.

ReservationRecommendationDetailsCalculatedSavingsProperties

Detalhes das poupanças estimadas.

ReservationRecommendationDetailsGetOptionalParams

Parâmetros opcionais.

ReservationRecommendationDetailsModel

Detalhes da recomendação de reserva.

ReservationRecommendationDetailsResourceProperties

Detalhes do recurso.

ReservationRecommendationDetailsSavingsProperties

Detalhes das poupanças estimadas.

ReservationRecommendationDetailsUsageProperties

Detalhes sobre os dados de utilização histórica que foram utilizados para calcular a recomendação.

ReservationRecommendations

Interface que representa um ReservationRecommendations.

ReservationRecommendationsListNextOptionalParams

Parâmetros opcionais.

ReservationRecommendationsListOptionalParams

Parâmetros opcionais.

ReservationRecommendationsListResult

Resultado da listagem de recomendações de reservas.

ReservationSummariesListResult

Resultado da listagem de resumos de reservas.

ReservationSummary

recurso de resumo de reserva.

ReservationTransaction

Recurso de transação de reserva.

ReservationTransactionResource

A definição modelo de recurso.

ReservationTransactions

Interface que representa uma ReservationTransactions.

ReservationTransactionsListByBillingProfileNextOptionalParams

Parâmetros opcionais.

ReservationTransactionsListByBillingProfileOptionalParams

Parâmetros opcionais.

ReservationTransactionsListNextOptionalParams

Parâmetros opcionais.

ReservationTransactionsListOptionalParams

Parâmetros opcionais.

ReservationTransactionsListResult

Resultado da listagem de recomendações de reservas.

ReservationsDetails

Interface que representa uma ReservationsDetails.

ReservationsDetailsListByReservationOrderAndReservationNextOptionalParams

Parâmetros opcionais.

ReservationsDetailsListByReservationOrderAndReservationOptionalParams

Parâmetros opcionais.

ReservationsDetailsListByReservationOrderNextOptionalParams

Parâmetros opcionais.

ReservationsDetailsListByReservationOrderOptionalParams

Parâmetros opcionais.

ReservationsDetailsListNextOptionalParams

Parâmetros opcionais.

ReservationsDetailsListOptionalParams

Parâmetros opcionais.

ReservationsSummaries

Interface que representa uma ReservationsSummaries.

ReservationsSummariesListByReservationOrderAndReservationNextOptionalParams

Parâmetros opcionais.

ReservationsSummariesListByReservationOrderAndReservationOptionalParams

Parâmetros opcionais.

ReservationsSummariesListByReservationOrderNextOptionalParams

Parâmetros opcionais.

ReservationsSummariesListByReservationOrderOptionalParams

Parâmetros opcionais.

ReservationsSummariesListNextOptionalParams

Parâmetros opcionais.

ReservationsSummariesListOptionalParams

Parâmetros opcionais.

Resource

A definição modelo de recurso.

ResourceAttributes

A definição modelo de recurso.

SkuProperty

A propriedade SKU

Tag

O recurso de etiqueta.

Tags

Interface que representa etiquetas.

TagsGetOptionalParams

Parâmetros opcionais.

TagsResult

Um recurso que lista todas as etiquetas.

UsageDetail

Um recurso de detalhes de utilização.

UsageDetails

Interface que representa uma UsageDetails.

UsageDetailsListNextOptionalParams

Parâmetros opcionais.

UsageDetailsListOptionalParams

Parâmetros opcionais.

UsageDetailsListResult

Resultado da listagem de detalhes de utilização. Contém uma lista de detalhes de utilização disponíveis por ordem cronológica inversa por período de faturação.

Aliases de Tipo

AggregatedCostGetByManagementGroupResponse

Contém dados de resposta para a operação getByManagementGroup.

AggregatedCostGetForBillingPeriodByManagementGroupResponse

Contém dados de resposta para a operação getForBillingPeriodByManagementGroup.

BalancesGetByBillingAccountResponse

Contém dados de resposta para a operação getByBillingAccount.

BalancesGetForBillingPeriodByBillingAccountResponse

Contém dados de resposta para a operação getForBillingPeriodByBillingAccount.

BillingFrequency

Define valores para BillingFrequency.
KnownBillingFrequency pode ser utilizado alternadamente com BillingFrequency. Este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Mensal
Trimestre
Anual

BudgetOperatorType

Define valores para BudgetOperatorType.
KnownBudgetOperatorType pode ser utilizado alternadamente com BudgetOperatorType, esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Em

BudgetsCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

BudgetsGetResponse

Contém dados de resposta para a operação get.

BudgetsListNextResponse

Contém dados de resposta para a operação listNext.

BudgetsListResponse

Contém dados de resposta para a operação de lista.

CategoryType

Define valores para CategoryType.
KnownCategoryType pode ser utilizado alternadamente com CategoryType, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Custo

ChargeSummaryKind

Define valores para ChargeSummaryKind.
KnownChargeSummaryKind pode ser utilizado alternadamente com ChargeSummaryKind, esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

legado
moderno

ChargeSummaryUnion
ChargesListResponse

Contém dados de resposta para a operação de lista.

CreditsGetResponse

Contém dados de resposta para a operação get.

CultureCode

Define valores para CultureCode.
O KnownCultureCode pode ser utilizado alternadamente com o CultureCode. Esta enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

pt-pt
ja-jp
zh-cn
de-de
es-es
fr-fr
it-it
ko-kr
pt-br
ru-ru
zh-tw
cs-cz
pl-pl
tr-tr
da-dk
en-gb
hu-hu
nb-no
nl-nl
pt-pt
sv-se

Datagrain

Define valores para Datagrain.
KnownDatagrain pode ser utilizado alternadamente com Datagrain, esta enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

diariamente: Diariamente, um conjunto de dados
mensal: Conjunto mensal de dados

EventType

Define valores para EventType.
KnownEventType pode ser utilizado alternadamente com EventType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

SettledCharges
PendingCharges
PendingAdjustments
PendenteNovoCredit
PendingExpiredCredit
Desconhecido
NewCredit

EventsListByBillingAccountNextResponse

Contém dados de resposta para a operação listByBillingAccountNext.

EventsListByBillingAccountResponse

Contém dados de resposta para a operação listByBillingAccount.

EventsListByBillingProfileNextResponse

Contém dados de resposta para a operação listByBillingProfileNext.

EventsListByBillingProfileResponse

Contém dados de resposta para a operação listByBillingProfile.

LegacyReservationRecommendationPropertiesUnion
LookBackPeriod

Define valores para LookBackPeriod.
KnownLookBackPeriod pode ser utilizado alternadamente com LookBackPeriod. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Last7Days: Utilizar 7 dias de dados para obter recomendações
Last30Days: Utilizar 30 dias de dados para obter recomendações
Last60Days: Utilizar 60 dias de dados para obter recomendações

LotSource

Define valores para LotSource.
O KnownLotSource pode ser utilizado alternadamente com o LotSource. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

PurchasedCredit
Crédito Promocional
ConsumptionCommitment

LotsListByBillingAccountNextResponse

Contém dados de resposta para a operação listByBillingAccountNext.

LotsListByBillingAccountResponse

Contém dados de resposta para a operação listByBillingAccount.

LotsListByBillingProfileNextResponse

Contém dados de resposta para a operação listByBillingProfileNext.

LotsListByBillingProfileResponse

Contém dados de resposta para a operação listByBillingProfile.

MarketplacesListNextResponse

Contém dados de resposta para a operação listNext.

MarketplacesListResponse

Contém dados de resposta para a operação de lista.

Metrictype

Define valores para Metrictype.
KnownMetrictype pode ser utilizado alternadamente com Metrictype. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

actualcost: dados de custos reais.
amortizedcost: dados de custos amortizados.
utilização: dados de utilização.

OperationsListNextResponse

Contém dados de resposta para a operação listNext.

OperationsListResponse

Contém dados de resposta para a operação de lista.

OperatorType

Define valores para OperatorType.
KnownOperatorType pode ser utilizado alternadamente com OperatorType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

EqualTo
GreaterThan
GreaterThanOrEqualTo

PriceSheetGetByBillingPeriodResponse

Contém dados de resposta para a operação getByBillingPeriod.

PriceSheetGetResponse

Contém dados de resposta para a operação get.

PricingModelType

Define valores para PricingModelType.
KnownPricingModelType pode ser utilizado alternadamente com PricingModelType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

A Pedido
Reserva
Spot

ReservationRecommendationDetailsGetResponse

Contém dados de resposta para a operação get.

ReservationRecommendationKind

Define valores para ReservationRecommendationKind.
KnownReservationRecommendationKind pode ser utilizado alternadamente com ReservationRecommendationKind. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

legado
moderno

ReservationRecommendationUnion
ReservationRecommendationsListNextResponse

Contém dados de resposta para a operação listNext.

ReservationRecommendationsListResponse

Contém dados de resposta para a operação de lista.

ReservationTransactionsListByBillingProfileNextResponse

Contém dados de resposta para a operação listByBillingProfileNext.

ReservationTransactionsListByBillingProfileResponse

Contém dados de resposta para a operação listByBillingProfile.

ReservationTransactionsListNextResponse

Contém dados de resposta para a operação listNext.

ReservationTransactionsListResponse

Contém dados de resposta para a operação de lista.

ReservationsDetailsListByReservationOrderAndReservationNextResponse

Contém dados de resposta para a operação listByReservationOrderAndReservationNext.

ReservationsDetailsListByReservationOrderAndReservationResponse

Contém dados de resposta para a operação listByReservationOrderAndReservation.

ReservationsDetailsListByReservationOrderNextResponse

Contém dados de resposta para a operação listByReservationOrderNext.

ReservationsDetailsListByReservationOrderResponse

Contém dados de resposta para a operação listByReservationOrder.

ReservationsDetailsListNextResponse

Contém dados de resposta para a operação listNext.

ReservationsDetailsListResponse

Contém dados de resposta para a operação de lista.

ReservationsSummariesListByReservationOrderAndReservationNextResponse

Contém dados de resposta para a operação listByReservationOrderAndReservationNext.

ReservationsSummariesListByReservationOrderAndReservationResponse

Contém dados de resposta para a operação listByReservationOrderAndReservation.

ReservationsSummariesListByReservationOrderNextResponse

Contém dados de resposta para a operação listByReservationOrderNext.

ReservationsSummariesListByReservationOrderResponse

Contém dados de resposta para a operação listByReservationOrder.

ReservationsSummariesListNextResponse

Contém dados de resposta para a operação listNext.

ReservationsSummariesListResponse

Contém dados de resposta para a operação de lista.

Scope

Define valores para Âmbito.
KnownScope pode ser utilizado alternadamente com Âmbito. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Único
Partilhado

Status

Define valores para Estado.
KnownStatus pode ser utilizado alternadamente com o Estado. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Nenhuma
Ativo
Inativa
Expirada
Concluído
Cancelado

TagsGetResponse

Contém dados de resposta para a operação get.

Term

Define valores para Termo.
O KnownTerm pode ser utilizado alternadamente com o Termo. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

P1Y: período de reserva de 1 ano
P3Y: período de reserva de 3 anos

ThresholdType

Define valores para ThresholdType.
KnownThresholdType pode ser utilizado alternadamente com ThresholdType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Atual
Previsto

TimeGrainType

Define valores para TimeGrainType.
KnownTimeGrainType pode ser utilizado alternadamente com TimeGrainType. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Mensalmente
Trimestrais
Anualmente
Mês de Faturação
BillingQuarter
FaturaçãoAnnual

UsageDetailUnion
UsageDetailsKind

Define valores para UsageDetailsKind.
KnownUsageDetailsKind pode ser utilizado alternadamente com UsageDetailsKind. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

legado
moderno

UsageDetailsListNextResponse

Contém dados de resposta para a operação listNext.

UsageDetailsListResponse

Contém dados de resposta para a operação de lista.

Enumerações

KnownBillingFrequency

Valores conhecidos de BillingFrequency que o serviço aceita.

KnownBudgetOperatorType

Valores conhecidos de BudgetOperatorType que o serviço aceita.

KnownCategoryType

Valores conhecidos de CategoryType que o serviço aceita.

KnownChargeSummaryKind

Valores conhecidos de ChargeSummaryKind que o serviço aceita.

KnownCultureCode

Valores conhecidos de CultureCode que o serviço aceita.

KnownDatagrain

Valores conhecidos de Datagrain que o serviço aceita.

KnownEventType

Valores conhecidos de EventType que o serviço aceita.

KnownLookBackPeriod

Valores conhecidos do LookBackPeriod que o serviço aceita.

KnownLotSource

Valores conhecidos do LotSource que o serviço aceita.

KnownMetrictype

Valores conhecidos de Metrictype que o serviço aceita.

KnownOperatorType

Valores conhecidos de OperatorType que o serviço aceita.

KnownPricingModelType

Valores conhecidos de PricingModelType que o serviço aceita.

KnownReservationRecommendationKind

Valores conhecidos de ReservationRecommendationKind que o serviço aceita.

KnownScope

Valores conhecidos do Âmbito que o serviço aceita.

KnownStatus

Valores conhecidos de Estado que o serviço aceita.

KnownTerm

Valores conhecidos de Termo que o serviço aceita.

KnownThresholdType

Valores conhecidos de ThresholdType que o serviço aceita.

KnownTimeGrainType

Valores conhecidos de TimeGrainType que o serviço aceita.

KnownUsageDetailsKind

Valores conhecidos de UsageDetailsKind que o serviço aceita.

Funções

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.

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.