@azure/arm-consumption package

Interfaces

AggregatedCostGetByManagementGroupOptionalParams

Parâmetros opcionais.

AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams

Parâmetros opcionais.

AggregatedCostOperations

Interface representando operações de Custo Agregado.

Amount

O valor mais a moeda.

AmountWithExchangeRate

O valor com taxa de câmbio.

Balance

Um recurso de balanceamento.

BalanceProperties

As propriedades do equilíbrio.

BalancePropertiesAdjustmentDetailsItem

Interface do modelo BalançoPropriedadesAjusteDetalhesItem

BalancePropertiesNewPurchasesDetailsItem

interface do modelo SaldoPropriedadesNovaComprasDetalhesItem

BalancesGetByBillingAccountOptionalParams

Parâmetros opcionais.

BalancesGetForBillingPeriodByBillingAccountOptionalParams

Parâmetros opcionais.

BalancesOperations

Interface representando operações de balanceamento.

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 para filtrar um orçamento.

BudgetProperties

As propriedades do orçamento.

BudgetTimePeriod

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

BudgetsCreateOrUpdateOptionalParams

Parâmetros opcionais.

BudgetsDeleteOptionalParams

Parâmetros opcionais.

BudgetsGetOptionalParams

Parâmetros opcionais.

BudgetsListOptionalParams

Parâmetros opcionais.

BudgetsOperations

Interface representando operações de orçamento.

ChargeSummary

Um recurso de resumo de encargos.

ChargesListOptionalParams

Parâmetros opcionais.

ChargesListResult

Resultado do resumo da cobrança de listagem.

ChargesOperations

Interface representando uma operação de Charges.

ConsumptionManagementClientOptionalParams

Parâmetros opcionais para o cliente.

CreditBalanceSummary

Resumo dos saldos de crédito.

CreditSummary

Um recurso de resumo de crédito.

CreditSummaryProperties

As propriedades do resumo de crédito.

CreditsGetOptionalParams

Parâmetros opcionais.

CreditsOperations

Interface representando uma operação de créditos.

CurrentSpend

O valor atual do custo que está sendo acompanhado para um orçamento.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas.

EventProperties

As propriedades do evento.

EventSummary

Um recurso de resumo de eventos.

EventsOperationsListByBillingAccountOptionalParams

Parâmetros opcionais.

EventsOperationsListByBillingProfileOptionalParams

Parâmetros opcionais.

EventsOperationsOperations

Interface representando uma operação EventsOperations.

ExtensionResource

O recurso de extensão base.

ForecastSpend

O custo previsto que está sendo acompanhado 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. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

LegacyChargeSummary

Resumo de encargos herdado.

LegacyChargeSummaryProperties

As propriedades do resumo de cobranças legado.

LegacyReservationRecommendation

Recomendação de reserva herdada.

LegacyReservationRecommendationProperties

As propriedades da recomendação de reserva.

LegacyReservationTransactionProperties

As propriedades de uma transação de reserva legada.

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.

LegacyUsageDetailProperties

As propriedades do uso legado detalham.

LotProperties

As propriedades do lote.

LotSummary

Muito recurso de resumo.

LotsOperationsListByBillingAccountOptionalParams

Parâmetros opcionais.

LotsOperationsListByBillingProfileOptionalParams

Parâmetros opcionais.

LotsOperationsListByCustomerOptionalParams

Parâmetros opcionais.

LotsOperationsOperations

Interface representando uma operação LotsOperations.

ManagementGroupAggregatedCostProperties

As propriedades do Grupo de Gestão Custo Agregado.

ManagementGroupAggregatedCostResult

Um recurso de custo agregado do grupo de gerenciamento.

Marketplace

Um recurso do marketplace.

MarketplaceProperties

As propriedades do mercado detalham o uso.

MarketplacesListOptionalParams

Parâmetros opcionais.

MarketplacesOperations

Interface representando as operações de um Marketplace.

MeterDetails

As propriedades do detalhe do medidor.

MeterDetailsResponse

As propriedades do detalhe do medidor.

ModernChargeSummary

Resumo de encargos moderno.

ModernChargeSummaryProperties

As propriedades do resumo moderno da carga.

ModernReservationRecommendation

Recomendação de reserva moderna.

ModernReservationRecommendationProperties

As propriedades da recomendação de reserva.

ModernReservationTransaction

Recurso de transação de reserva moderna.

ModernReservationTransactionProperties

As propriedades de uma transação moderna de reservas.

ModernSharedScopeReservationRecommendationProperties

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

ModernSingleScopeReservationRecommendationProperties

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

ModernUsageDetail

Detalhes de uso moderno.

ModernUsageDetailProperties

As propriedades do uso detalham.

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.

OperationStatus

O status da operação de execução prolongada.

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface que representa operações de operações.

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.

PriceSheetDownloadByBillingAccountPeriodOptionalParams

Parâmetros opcionais.

PriceSheetGetByBillingPeriodOptionalParams

Parâmetros opcionais.

PriceSheetGetOptionalParams

Parâmetros opcionais.

PriceSheetModel

Resultado da tabela de preços. Ele contém a planilha de preços associada ao período de cobrança

PriceSheetOperations

Interface representando operações do PriceSheet.

PriceSheetProperties

As propriedades da tabela de preços.

PriceSheetResult

Um recurso de planilha de preços.

PricesheetDownloadProperties

As propriedades do download da tabela de preços.

ProxyResource

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local

Reseller

As propriedades do revendedor.

ReservationDetail

recurso de detalhes de reserva.

ReservationDetailProperties

As propriedades da reserva detalham.

ReservationRecommendation

Um recurso de recomendação de reserva.

ReservationRecommendationDetailsCalculatedSavingsProperties

Detalhes da economia estimada. Os custos e a economia são estimados para o prazo.

ReservationRecommendationDetailsGetOptionalParams

Parâmetros opcionais.

ReservationRecommendationDetailsModel

Detalhes da recomendação de reserva.

ReservationRecommendationDetailsOperations

Interface representando uma operação ReservationRecommendationDetails.

ReservationRecommendationDetailsProperties

As propriedades da recomendação de reserva.

ReservationRecommendationDetailsResourceProperties

Detalhes do recurso.

ReservationRecommendationDetailsSavingsProperties

Detalhes da economia estimada.

ReservationRecommendationDetailsUsageProperties

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

ReservationRecommendationsListOptionalParams

Parâmetros opcionais.

ReservationRecommendationsOperations

Interface representando uma operação de ReservationRecommendations.

ReservationSummary

recurso de resumo de reserva.

ReservationSummaryProperties

As propriedades do resumo da reserva.

ReservationTransaction

Recurso de transação de reserva.

ReservationTransactionsListByBillingProfileOptionalParams

Parâmetros opcionais.

ReservationTransactionsListOptionalParams

Parâmetros opcionais.

ReservationTransactionsOperations

Interface representando uma operação ReservationTransactions.

ReservationsDetailsListByReservationOrderAndReservationOptionalParams

Parâmetros opcionais.

ReservationsDetailsListByReservationOrderOptionalParams

Parâmetros opcionais.

ReservationsDetailsListOptionalParams

Parâmetros opcionais.

ReservationsDetailsOperations

Interface representando uma operação ReservationsDetails.

ReservationsSummariesListByReservationOrderAndReservationOptionalParams

Parâmetros opcionais.

ReservationsSummariesListByReservationOrderOptionalParams

Parâmetros opcionais.

ReservationsSummariesListOptionalParams

Parâmetros opcionais.

ReservationsSummariesOperations

Interface representando uma operação de ReservationsSummaries.

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

RestorePollerOptions
SavingsPlan

As propriedades do SavingsPlan.

SkuProperty

A propriedade Sku

SystemData

Metadados relativos à criação e última modificação do recurso.

Tag

O recurso de marca.

TagProperties

As propriedades da tag.

TagsGetOptionalParams

Parâmetros opcionais.

TagsOperations

Interface representando operações de Tags.

TagsResult

Um recurso listando todas as marcas.

UsageDetail

Um recurso de detalhes de uso.

UsageDetailsListOptionalParams

Parâmetros opcionais.

UsageDetailsOperations

Interface representando uma operação UsageDetails.

Aliases de tipo

AzureSupportedClouds

Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres

BillingFrequency

A frequência de cobrança.
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
ano

BudgetOperatorType

O operador a ser usado para comparação.
KnownBudgetOperatorType podem ser usados 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

em

CategoryType

A categoria do orçamento, independentemente de o orçamento controlar o custo ou o uso.
KnownCategoryType pode ser usado de forma 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

de Custo do

ChargeSummaryKind

Especifica o tipo de resumo de encargos.
KnownChargeSummaryKind podem ser usados de forma 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

herdado
moderna

ChargeSummaryUnion

Nome de ChargeSummaryUnion

ContinuablePage

Uma interface que descreve uma página de resultados.

CreatedByType

O tipo de entidade que criou o recurso.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

User: a entidade foi criada por um usuário.
Application: a entidade foi criada por um aplicativo.
ManagedIdentity: a entidade foi criada por uma identidade gerenciada.
Key: a entidade foi criada por uma chave.

CultureCode

Idioma no qual o destinatário receberá a notificação
KnownCultureCode pode ser usado de forma intercambiável com o 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

Tipo de Datagrain

EventType

Identifica o tipo do evento.
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
sem conhecimento
newcredit
CréditoExpirado

LegacyReservationRecommendationPropertiesUnion

Nome de LegadoRecomendaçãoReservaPropertiesUnion

LookBackPeriod

Tipo de LookBackPeriod

LotSource

A origem do lote.
KnownLotSource pode ser usado de forma intercambiável com o 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
do PromotionalCredit
consumptionCommitment

Metrictype

Tipo de Tipo de Métrica

ModernReservationRecommendationPropertiesUnion

Alias para ModernReservationRecommendationPropertiesUnion

OperationStatusType

O status da operação de execução prolongada.
KnowOperationStatusType pode ser usado de forma intercambiável com OperationStatusType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

Em execução
Completed
Falha

OperatorType

O operador de comparação.
KnownOperatorType pode ser usado de forma 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: O alerta será acionado se o custo avaliado for igual ao valor limite. Observação: não é recomendável usar esse OperatorType, pois há pouca chance de o custo ser exatamente o mesmo que o valor limite, levando à falta do alerta. Este OperatorType será preterido no futuro.
GreaterThan: O alerta será acionado se o custo avaliado for maior que o valor limiar. Observação: este é o OperatorType recomendado ao configurar o Alerta de Orçamento.
MaiorQueQueOuIgualA: O alerta será acionado se o custo avaliado for maior ou igual ao valor limiar.

OrganizationType

O tipo de organização do lote.
KnownOrganizationType pode ser usado de forma intercambiável com OrganizationType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

Primária: Tipo de organização primária para o compromisso de consumo de Multi-Entidade.
Contribuidor: Tipo de organização de contribuinte para compromisso de consumo de Multi-Entidade.

PricingModelType

Identificador que indica como o medidor é cobrado.
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
de Reserva
Spot

ReservationRecommendationKind

Especifica o tipo de recomendação de reserva.
KnownReservationRecommendationKind podem ser usados de forma 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

herdado
moderna

ReservationRecommendationUnion

Nome de Reserva Recomendação União

Scope

Tipo de Escopo

Status

O status do lote.
KnownStatus pode ser usado de forma 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

Nenhum
Active
Inativo
expirado
Concluir
Cancelada

Term

Tipo de Termo

ThresholdType

O tipo de limiar
KnownThresholdType pode ser usado de forma 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

Atual: Alertas orçamentários de custos reais notificam quando o custo real acumulado excede o orçamento alocado.
Previsão: Os alertas orçamentários de custos previstos fornecem notificações antecipadas de que suas tendências de gastos provavelmente superarão o orçamento alocado, pois dependem das previsões de custos previstas.

TimeGrainType

O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo. BillingMonth, BillingQuarter e BillingAnnual são suportados apenas por clientes WD
KnownTimeGrainType pode ser usado de forma 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

Mensal
Trimestral
anualmente
BillingMonth
BillingQuarter
BillingAnnual

UsageDetailUnion

Alias para UsageDetailUnion

UsageDetailsKind

Especifica o tipo de detalhes de uso.
KnownUsageDetailsKind podem ser usados de forma 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

herdado
moderna

Enumerações

AzureClouds

Um enum para descrever ambientes de nuvem Azure.

KnownBillingFrequency

A frequência de cobrança.

KnownBudgetOperatorType

O operador a ser usado para comparação.

KnownCategoryType

A categoria do orçamento, independentemente de o orçamento controlar o custo ou o uso.

KnownChargeSummaryKind

Especifica o tipo de resumo de encargos.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownCultureCode

Idioma no qual o destinatário receberá a notificação

KnownDatagrain

Valores conhecidos de Datagrain que o serviço aceita.

KnownEventType

Identifica o tipo do evento.

KnownLookBackPeriod

Valores conhecidos de LookBackPeriod que o serviço aceita.

KnownLotSource

A origem do lote.

KnownMetrictype

Valores conhecidos de Metrictype que o serviço aceita.

KnownOperationStatusType

O status da operação de execução prolongada.

KnownOperatorType

O operador de comparação.

KnownOrganizationType

O tipo de organização do lote.

KnownPricingModelType

Identificador que indica como o medidor é cobrado.

KnownReservationRecommendationKind

Especifica o tipo de recomendação de reserva.

KnownScope

Valores conhecidos de Escopo que o serviço aceita.

KnownStatus

O status do lote.

KnownTerm

Valores conhecidos de Term que o serviço aceita.

KnownThresholdType

O tipo de limite

KnownTimeGrainType

O tempo coberto por um orçamento. O acompanhamento da quantidade será redefinido com base na granulação de tempo. BillingMonth, BillingQuarter e BillingAnnual só têm suporte para clientes do WD

KnownUsageDetailsKind

Especifica o tipo de detalhes de uso.

KnownVersions

As versões de API disponíveis.

Funções

isRestError(unknown)

Typeguard para RestError

restorePoller<TResponse, TResult>(ConsumptionManagementClient, 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.

Variáveis

RestError

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>(ConsumptionManagementClient, 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: ConsumptionManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parâmetros

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Retornos

PollerLike<OperationState<TResult>, TResult>

Detalhes da variável

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo