@azure/arm-consumption package

Classes

ConsumptionManagementClient

Interfaces

AggregatedCost

Interface que representa um AggregatedCost.

AggregatedCostGetByManagementGroupOptionalParams

Parâmetros opcionais.

AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams

Parâmetros opcionais.

Amount

O valor mais a moeda .

AmountWithExchangeRate

O valor com taxa de câmbio.

Balance

Um recurso de equilíbrio.

BalancePropertiesAdjustmentDetailsItem
BalancePropertiesNewPurchasesDetailsItem
Balances

Interface que representa um Balances.

BalancesGetByBillingAccountOptionalParams

Parâmetros opcionais.

BalancesGetForBillingPeriodByBillingAccountOptionalParams

Parâmetros opcionais.

Budget

Um recurso de orçamento.

BudgetComparisonExpression

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

BudgetFilter

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

BudgetFilterProperties

As Dimensões ou marcas pelas quais filtrar um orçamento.

BudgetTimePeriod

A data de início e término de um orçamento.

Budgets

Interface que representa um Budgets.

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. Ele contém uma lista de orçamentos disponíveis no escopo fornecido.

ChargeSummary

Um recurso de resumo de encargos.

Charges

Interface que representa um Charges.

ChargesListOptionalParams

Parâmetros opcionais.

ChargesListResult

Resultado da listagem de resumo da cobrança.

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

A quantidade atual de custo que está sendo controlada para um orçamento.

DownloadProperties

As propriedades do download da tabela de preços.

ErrorDetails

Os detalhes do 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.

Algumas respostas de erro:

  • 429 TooManyRequests – A solicitação é limitada. Tente novamente 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. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".

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á sendo rastreado para um orçamento.

HighCasedErrorDetails

Os detalhes do erro.

HighCasedErrorResponse

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.

Algumas respostas de erro:

  • 429 TooManyRequests - A solicitação é limitada. Tente novamente 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. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".

LegacyChargeSummary

Resumo da cobrança herdada.

LegacyReservationRecommendation

Recomendação de reserva herdada.

LegacyReservationRecommendationProperties

As propriedades da recomendação de reserva.

LegacyReservationTransaction

Recurso de transação de reserva herdado.

LegacySharedScopeReservationRecommendationProperties

As propriedades da recomendação de reserva herdada para escopo compartilhado.

LegacySingleScopeReservationRecommendationProperties

As propriedades da recomendação de reserva herdada para escopo único.

LegacyUsageDetail

Detalhes de uso herdados.

LotSummary

Muito recurso de resumo.

Lots

Resultado do resumo do lote de listagem.

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 do grupo de gerenciamento.

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. Ele contém uma lista de marketplaces disponíveis em ordem cronológica inversa por período de cobrança.

MeterDetails

As propriedades dos detalhes do medidor.

MeterDetailsResponse

As propriedades dos detalhes do medidor.

ModernChargeSummary

Resumo de encargos moderno.

ModernReservationRecommendation

Recomendação de reserva moderna.

ModernReservationTransaction

Recurso de transação de reserva moderna.

ModernReservationTransactionsListResult

Resultado da listagem de recomendações de reserva.

ModernUsageDetail

Detalhes de uso moderno.

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. Ele contém uma lista de operações e um link 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 um PriceSheet.

PriceSheetGetByBillingPeriodOptionalParams

Parâmetros opcionais.

PriceSheetGetOptionalParams

Parâmetros opcionais.

PriceSheetProperties

As propriedades da tabela de preços.

PriceSheetResult

Um recurso de folha de preços.

ProxyResource

A definição do modelo de recurso.

Reseller

As propriedades do revendedor.

ReservationDetail

recurso de detalhes de reserva.

ReservationDetailsListResult

Resultado da listagem de detalhes da reserva.

ReservationRecommendation

Um recurso de recomendação de reserva.

ReservationRecommendationDetails

Interface que representa um ReservationRecommendationDetails.

ReservationRecommendationDetailsCalculatedSavingsProperties

Detalhes da economia estimada.

ReservationRecommendationDetailsGetOptionalParams

Parâmetros opcionais.

ReservationRecommendationDetailsModel

Detalhes da recomendação de reserva.

ReservationRecommendationDetailsResourceProperties

Detalhes do recurso.

ReservationRecommendationDetailsSavingsProperties

Detalhes da economia estimada.

ReservationRecommendationDetailsUsageProperties

Detalhes sobre dados históricos de uso que foram usados para calcular a recomendação.

ReservationRecommendations

Interface que representa uma ReservationRecommendations.

ReservationRecommendationsListNextOptionalParams

Parâmetros opcionais.

ReservationRecommendationsListOptionalParams

Parâmetros opcionais.

ReservationRecommendationsListResult

Resultado da listagem de recomendações de reserva.

ReservationSummariesListResult

Resultado da listagem de resumos de reserva.

ReservationSummary

recurso de resumo de reserva.

ReservationTransaction

Recurso de transação de reserva.

ReservationTransactionResource

A definição do 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 reserva.

ReservationsDetails

Interface que representa um 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 um 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 do modelo de recurso.

ResourceAttributes

A definição do modelo de recurso.

SkuProperty

A propriedade Sku

Tag

O recurso de marca.

Tags

Interface que representa uma marca.

TagsGetOptionalParams

Parâmetros opcionais.

TagsResult

Um recurso listando todas as marcas.

UsageDetail

Um recurso de detalhes de uso.

UsageDetails

Interface que representa um UsageDetails.

UsageDetailsListNextOptionalParams

Parâmetros opcionais.

UsageDetailsListOptionalParams

Parâmetros opcionais.

UsageDetailsListResult

Resultado da listagem de detalhes de uso. Ele contém uma lista de detalhes de uso disponíveis em ordem cronológica inversa por período de cobrança.

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 usado de forma intercambiável com BillingFrequency, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Mês
Trimestre
Year

BudgetOperatorType

Define valores para BudgetOperatorType.
KnownBudgetOperatorType pode ser usado de forma intercambiável com BudgetOperatorType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

In

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 usado intercambiável com CategoryType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Custo

ChargeSummaryKind

Define valores para ChargeSummaryKind.
KnownChargeSummaryKind pode ser usado intercambiável com ChargeSummaryKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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.
KnownCultureCode pode ser usado intercambiável com CultureCode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

en-US
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 usado intercambiável com Datagrain, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

diariamente: granularidade diária de dados
mensalmente: granularidade mensal de dados

EventType

Define valores para EventType.
KnownEventType pode ser usado de forma intercambiável com EventType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

SettledCharges
PendingCharges
PendingAdjustments
PendingNewCredit
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 usado de forma intercambiável com LookBackPeriod. Essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

LotSource

Define valores para LotSource.
KnownLotSource pode ser usado de forma intercambiável com LotSource, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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 usado de forma intercambiável com Metrictype, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

actualcost: dados de custo real.
amortizedcost: dados de custo amortizados.
usage: dados de uso.

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 usado intercambiável com OperatorType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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 usado de forma intercambiável com PricingModelType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Sob Demanda
Reserva
Local

ReservationRecommendationDetailsGetResponse

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

ReservationRecommendationKind

Define valores para ReservationRecommendationKind.
KnownReservationRecommendationKind pode ser usado intercambiável com ReservationRecommendationKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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 Escopo.
KnownScope pode ser usado intercambiável com Escopo, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Single
Compartilhado

Status

Define valores para Status.
KnownStatus pode ser usado intercambiável com Status, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Nenhuma
Ativo
Inativa
Expirada
Concluir
Cancelado

TagsGetResponse

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

Term

Define valores para Term.
KnownTerm pode ser usado intercambiável com Term, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

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

ThresholdType

Define valores para ThresholdType.
KnownThresholdType pode ser usado intercambiável com ThresholdType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Real
Previsto

TimeGrainType

Define valores para TimeGrainType.
KnownTimeGrainType pode ser usado intercambiável com TimeGrainType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Mensalmente
Trimestral
Anualmente
BillingMonth
BillingQuarter
BillingAnnual

UsageDetailUnion
UsageDetailsKind

Define valores para UsageDetailsKind.
KnownUsageDetailsKind pode ser usado intercambiável com UsageDetailsKind, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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 do Datagrain que o serviço aceita.

KnownEventType

Valores conhecidos de EventType que o serviço aceita.

KnownLookBackPeriod

Valores conhecidos de LookBackPeriod que o serviço aceita.

KnownLotSource

Valores conhecidos de 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 de Escopo que o serviço aceita.

KnownStatus

Valores conhecidos de Status 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, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

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.