@azure/arm-consumption package

Interfaces

AggregatedCostGetByManagementGroupOptionalParams

Parâmetros opcionais.

AggregatedCostGetForBillingPeriodByManagementGroupOptionalParams

Parâmetros opcionais.

AggregatedCostOperations

Interface representando operações de Custo Agregado.

Amount

O montante mais a moeda .

AmountWithExchangeRate

O valor com taxa de câmbio.

Balance

Um recurso de equilíbrio.

BalanceProperties

As propriedades da balança.

BalancePropertiesAdjustmentDetailsItem

Interface do modelo EquilíbrioPropriedadesAjusteDetalhesItem

BalancePropertiesNewPurchasesDetailsItem

Interface do modelo BalançoPropriedadesNovaComprasDetalhesItem

BalancesGetByBillingAccountOptionalParams

Parâmetros opcionais.

BalancesGetForBillingPeriodByBillingAccountOptionalParams

Parâmetros opcionais.

BalancesOperations

Interface representando operações de balanceamento.

Budget

Um recurso orçamental.

BudgetComparisonExpression

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

BudgetFilter

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

BudgetFilterProperties

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

BudgetProperties

As propriedades do orçamento.

BudgetTimePeriod

As datas de início e fim de um orçamento.

BudgetsCreateOrUpdateOptionalParams

Parâmetros opcionais.

BudgetsDeleteOptionalParams

Parâmetros opcionais.

BudgetsGetOptionalParams

Parâmetros opcionais.

BudgetsListOptionalParams

Parâmetros opcionais.

BudgetsOperations

Interface que representa as operações de um orçamento.

ChargeSummary

Um recurso de resumo de cobrança.

ChargesListOptionalParams

Parâmetros opcionais.

ChargesListResult

Resultado do resumo da taxa de listagem.

ChargesOperations

Interface representando uma operação de Charges.

ConsumptionManagementClientOptionalParams

Parâmetros opcionais para o cliente.

CreditBalanceSummary

Resumo dos saldos credor.

CreditSummary

Um recurso de resumo de crédito.

CreditSummaryProperties

As propriedades do resumo de crédito.

CreditsGetOptionalParams

Parâmetros opcionais.

CreditsOperations

Interface representando operações de créditos.

CurrentSpend

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

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para 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 de base.

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 está limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiçoIndisponível - O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

LegacyChargeSummary

Resumo da cobrança herdada.

LegacyChargeSummaryProperties

As propriedades do histórico de carga de crédito.

LegacyReservationRecommendation

Recomendação de reserva legada.

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

Um recurso de resumo de lote.

LotsOperationsListByBillingAccountOptionalParams

Parâmetros opcionais.

LotsOperationsListByBillingProfileOptionalParams

Parâmetros opcionais.

LotsOperationsListByCustomerOptionalParams

Parâmetros opcionais.

LotsOperationsOperations

Interface que representa operações LotsOperations.

ManagementGroupAggregatedCostProperties

As propriedades do Grupo de Gestão Custo Agregado.

ManagementGroupAggregatedCostResult

Um recurso de custo agregado do grupo de gerenciamento.

Marketplace

Um recurso de mercado.

MarketplaceProperties

As propriedades do mercado detalham a utilização.

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 carga moderno.

ModernChargeSummaryProperties

As propriedades do resumo moderno de cargas.

ModernReservationRecommendation

Recomendação de reserva moderna.

ModernReservationRecommendationProperties

As propriedades da recomendação de reserva.

ModernReservationTransaction

Recurso moderno de transação de reserva.

ModernReservationTransactionProperties

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

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

Detalhe de uso moderno.

ModernUsageDetailProperties

As propriedades do uso detalham.

Notification

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

Operation

Uma operação da API REST de consumo.

OperationDisplay

O objeto que representa a operação.

OperationStatus

O status da operação de longa duração.

OperationsListOptionalParams

Parâmetros opcionais.

OperationsOperations

Interface que representa uma operação de Operações.

PageSettings

Opções para o método byPage

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável até a conclusão e por página.

PriceSheetDownloadByBillingAccountPeriodOptionalParams

Parâmetros opcionais.

PriceSheetGetByBillingPeriodOptionalParams

Parâmetros opcionais.

PriceSheetGetOptionalParams

Parâmetros opcionais.

PriceSheetModel

Resultado da tabela de preços. Contém a folha de preços associada ao período de faturação

PriceSheetOperations

Interface representando operações do PriceSheet.

PriceSheetProperties

As propriedades da folha de preços.

PriceSheetResult

Um recurso de folha de preços.

PricesheetDownloadProperties

As propriedades do download da folha de preços.

ProxyResource

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

Reseller

As propriedades do revendedor.

ReservationDetail

recurso de detalhe de reserva.

ReservationDetailProperties

As propriedades da reserva detalham.

ReservationRecommendation

Um recurso de recomendação de reserva.

ReservationRecommendationDetailsCalculatedSavingsProperties

Detalhes das economias estimadas. Os custos e economias 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

Pormenores das poupanças estimadas.

ReservationRecommendationDetailsUsageProperties

Detalhes sobre dados históricos de uso 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 Resumos de Reservas.

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 referentes à criação e última modificação do recurso.

Tag

O recurso de tag.

TagProperties

As propriedades da etiqueta.

TagsGetOptionalParams

Parâmetros opcionais.

TagsOperations

Interface representando operações de etiquetas.

TagsResult

Um recurso listando todas as tags.

UsageDetail

Um recurso de detalhes de uso.

UsageDetailsListOptionalParams

Parâmetros opcionais.

UsageDetailsOperations

Interface representando uma operação UsageDetails.

Aliases de Tipo

AzureSupportedClouds

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

BillingFrequency

A frequência de faturação.
KnownBillingFrequency pode ser usado de forma intercambiável com BillingFrequency, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Mês
Trimestre
Ano

BudgetOperatorType

O operador a utilizar para comparação.
KnownBudgetOperatorType pode ser usado de forma intercambiável com BudgetOperatorType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

em

CategoryType

A categoria do orçamento, se o orçamento controla o custo ou o uso.
KnownCategoryType pode ser usado de forma intercambiável com CategoryType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Custo

ChargeSummaryKind

Especifica o tipo de resumo de cobrança.
KnownChargeSummaryKind pode ser usado de forma intercambiável com ChargeSummaryKind, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

legado
moderno

ChargeSummaryUnion

Alias para 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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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

Linguagem em que o destinatário receberá a notificação
KnownCultureCode pode ser usado de forma intercambiável com CultureCode, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo 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 de evento.
KnownEventType pode ser usado de forma intercambiável com EventType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

SettledCharges
PendingCharges
PendingAdjustments
PendingNewCredit
PendingExpiredCredit
desconhecido
NewCredit
CréditoExpirado

LegacyReservationRecommendationPropertiesUnion

Alias para LegadoReservaRecomendaçãoPropriedadesUnion

LookBackPeriod

Tipo de LookBackPeriod

LotSource

A origem do lote.
KnownLotSource pode ser usado de forma intercambiável com LotSource, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

PurchasedCredit
de Crédito Promocional
ConsumoCompromisso

Metrictype

Tipo de Metrictype

ModernReservationRecommendationPropertiesUnion

Alias para ModernReservaRecomendaçãoPropertiesUnion

OperationStatusType

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

Valores conhecidos suportados pelo serviço

Em curso
Completed
Falha

OperatorType

O operador de comparação.
KnownOperatorType pode ser usado de forma intercambiável com OperatorType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

EqualTo: O alerta será acionado se o custo avaliado for igual ao valor limiar. Nota: Não é recomendado usar este OperatorType, pois há baixa chance de o custo ser exatamente o mesmo que o valor limite, levando à falta do seu alerta. Este OperatorType será preterido no futuro.
GreaterThan: O alerta será acionado se o custo avaliado for superior ao valor limiar. Nota: Este é o OperatorType recomendado durante a configuração do Budget Alert.
GreaterThanOrEqualTo: 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, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Principal: Principal tipo de organização para o compromisso de consumo de Multi-Entidade.
Contribuidor: Tipo de organização de contribuinte para compromisso de consumo multi-entidade.

PricingModelType

Identificador que indica como é definido o preço do medidor.
KnownPricingModelType pode ser usado de forma intercambiável com PricingModelType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Sob Demanda
de Reservas
Spot

ReservationRecommendationKind

Especifica o tipo de recomendação de reserva.
KnownReservationRecommendationKind pode ser usado de forma intercambiável com ReservationRecommendationKind, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

legado
moderno

ReservationRecommendationUnion

Pseudónimo para ReservationRecommendationUnion

Scope

Tipo de Âmbito

Status

O status do lote.
KnownStatus pode ser usado de forma intercambiável com Status, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Nenhum
Ativo
Inativo
Expirado
Completo
Cancelado

Term

Tipo de Termo

ThresholdType

O tipo de limiar
KnownThresholdType pode ser usado de forma intercambiável com ThresholdType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Atual: Os alertas orçamentais de custos reais notificam quando o custo real acumulado excede o orçamento alocado.
Previsão: Os alertas orçamentais de custos previstos fornecem notificações antecipadas de que as suas tendências de despesa provavelmente ultrapassarão o orçamento alocado, pois dependem das previsões de custos previstas.

TimeGrainType

O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo. BillingMonth, BillingQuarter e BillingAnnual são apenas suportados por clientes WD
KnownTimeGrainType pode ser usado de forma intercambiável com TimeGrainType, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Mensal
Trimestral
Anualmente
FaturamentoMês
BillingQuarter
FaturamentoAnual

UsageDetailUnion

Alias para UsageDetailUnion

UsageDetailsKind

Especifica o tipo de detalhes de uso.
KnownUsageDetailsKind pode ser usado de forma intercambiável com UsageDetailsKind, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

legado
moderno

Enumerações

AzureClouds

Um enum para descrever ambientes Azure Cloud.

KnownBillingFrequency

A frequência de faturação.

KnownBudgetOperatorType

O operador a utilizar para comparação.

KnownCategoryType

A categoria do orçamento, se o orçamento controla o custo ou o uso.

KnownChargeSummaryKind

Especifica o tipo de resumo de cobrança.

KnownCreatedByType

O tipo de entidade que criou o recurso.

KnownCultureCode

Língua em que o destinatário receberá a notificação

KnownDatagrain

Os valores conhecidos de Datagrain que o serviço aceita.

KnownEventType

Identifica o tipo de evento.

KnownLookBackPeriod

Os valores conhecidos de LookBackPeriod que o serviço aceita.

KnownLotSource

A origem do lote.

KnownMetrictype

Os valores conhecidos de Metrictype que o serviço aceita.

KnownOperationStatusType

O status da operação de longa duração.

KnownOperatorType

O operador de comparação.

KnownOrganizationType

O tipo de organização do lote.

KnownPricingModelType

Identificador que indica como é definido o preço do medidor.

KnownReservationRecommendationKind

Especifica o tipo de recomendação de reserva.

KnownScope

Os valores conhecidos de Escopo que o serviço aceita.

KnownStatus

O status do lote.

KnownTerm

Valores conhecidos de Termo que o serviço aceita.

KnownThresholdType

O tipo de limiar

KnownTimeGrainType

O tempo coberto por um orçamento. O rastreamento do valor será redefinido com base no grão de tempo. BillingMonth, BillingQuarter e BillingAnnual são suportados apenas por clientes 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 poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Variáveis

RestError

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

Detalhes de Função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula de captura.

Devoluções

e

restorePoller<TResponse, TResult>(ConsumptionManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está 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>

Devoluções

PollerLike<OperationState<TResult>, TResult>

Detalhes das variáveis

RestError

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

RestError: RestErrorConstructor

Tipo