Compartilhar via

Reservation Transactions - List

Serviço:
Consumption
Versão da API:
2024-08-01

Lista de transações para instâncias reservadas no escopo da conta de cobrança. Observação: as transações de reembolso são postadas junto com sua transação de compra (ou seja, no mês de cobrança da compra). Por exemplo, o reembolso é solicitado em maio de 2021. Essa transação de reembolso terá data de evento como maio de 2021, mas o mês de cobrança como abril de 2020, quando a compra da reserva foi feita. Observação: o ARM tem um limite de tamanho de carga de 12 MB, portanto, atualmente, os chamadores recebem 400 quando o tamanho da resposta excede o limite do ARM. Nesses casos, a chamada à API deve ser feita com intervalos de datas menores.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01
Com parâmetros opcionais: 
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01&$filter={$filter}&useMarkupIfPartner={useMarkupIfPartner}&previewMarkupPercentage={previewMarkupPercentage}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
billingAccountId
 path True

string

ID da conta de cobrança
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.
$filter
 query

string

Filtrar transações de reserva por intervalo de datas. As propriedades/EventDate para data de início e data de término. O filtro dá suporte a 'le' e 'ge'. Observação: a API retorna dados para todo o mês de cobrança da data de início e da data de término. Por exemplo, as propriedades de filtro/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 incluirão dados para todo o mês de dezembro de 2020 (ou seja, conterão registros para datas de 30 e 31 de dezembro)
previewMarkupPercentage
 query

number (decimal)

Porcentagem de marcação de visualização a ser aplicada.
useMarkupIfPartner
 query

boolean

Aplica a marcação às transações se o chamador for um parceiro.

Respostas

Nome Tipo Description
200 OK

ReservationTransactionsListResult

A solicitação foi bem-sucedida.
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ReservationTransactionsByEnrollmentNumber

Solicitação de exemplo

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01&$filter=properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30&useMarkupIfPartner=True&previewMarkupPercentage=15.5

Resposta de exemplo

Código de status:
200 
{
  "value": [
    {
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "properties": {
        "description": "Standard_DS1_v2 westus 1 Year",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "amount": -21,
        "armSkuName": "Standard_DS1_v2",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "costCenter": "",
        "currency": "USD",
        "currentEnrollment": "123456",
        "departmentName": "Unassigned",
        "eventDate": "2019-09-09T19:19:04Z",
        "eventType": "Refund",
        "monetaryCommitment": 523123.9,
        "overage": 23234.49,
        "purchasingEnrollment": "123456",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "quantity": 1,
        "region": "westus",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderName": "Transaction-DS1_v2",
        "term": "P1Y"
      },
      "tags": []
    },
    {
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "properties": {
        "description": "Standard_DS1_v2 westus 1 Year",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "amount": 21,
        "armSkuName": "Standard_DS1_v2",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "costCenter": "",
        "currency": "USD",
        "currentEnrollment": "123456",
        "departmentName": "Unassigned",
        "eventDate": "2019-09-09T19:19:04Z",
        "eventType": "Purchase",
        "monetaryCommitment": 523123.9,
        "overage": 23234.49,
        "purchasingEnrollment": "123456",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "quantity": 1,
        "region": "westus",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderName": "Transaction-DS1_v2",
        "term": "P1Y"
      },
      "tags": []
    }
  ]
}

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
ReservationTransaction

Recurso de transação de reserva.
ReservationTransactionsListResult

Resultado da listagem de recomendações de reserva.
systemData

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

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

ReservationTransaction

Objeto

Recurso de transação de reserva.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.accountName

string

O nome da conta que faz a transação.
properties.accountOwnerEmail

string

O email do proprietário da conta que faz a transação.
properties.amount

number (decimal)

O encargo da transação.
properties.armSkuName

string

Este é o nome do ARM Sku. Ele pode ser usado para ingressar no campo serviceType em informações adicionais nos registros de uso.
properties.billingFrequency

string

A frequência de cobrança, que pode ser única ou recorrente.
properties.billingMonth

integer (int32)

O mês de cobrança (yyyyyMMdd), no qual o evento foi iniciado.
properties.costCenter

string

O centro de custo deste departamento se for um departamento e um centro de custo for fornecido.
properties.currency

string

A moeda ISO na qual a transação é cobrada, por exemplo, USD.
properties.currentEnrollment

string

O registro atual.
properties.departmentName

string

O nome do departamento.
properties.description

string

A descrição da transação.
properties.eventDate

string (date-time)

A data da transação
properties.eventType

string

O tipo da transação (Compra, Cancelamento ou Reembolso).
properties.monetaryCommitment

number (decimal)

O valor do compromisso monetário no escopo do registro.
properties.overage

number (decimal)

O valor excedente no escopo do registro.
properties.purchasingEnrollment

string

O registro de compra.
properties.purchasingSubscriptionGuid

string (uuid)

O guid de assinatura que faz a transação.
properties.purchasingSubscriptionName

string

O nome da assinatura que faz a transação.
properties.quantity

number (decimal)

A quantidade da transação.
properties.region

string

A região da transação.
properties.reservationOrderId

string

A ID do pedido de reserva é o identificador de uma compra de reserva. Cada ID de pedido de reserva representa uma única transação de compra. Um pedido de reserva contém reservas. A ordem de reserva especifica o tamanho e a região da VM para as reservas.
properties.reservationOrderName

string

O nome da ordem de reserva.
properties.term

string

Esse é o termo da transação.
systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags

string[]

Marcas de recurso.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ReservationTransactionsListResult

Objeto

Resultado da listagem de recomendações de reserva.

Nome Tipo Description
nextLink

string

O link (url) para a próxima página de resultados.
value

ReservationTransaction[]

A lista de recomendações de reserva.

systemData

Objeto

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

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.