Reservation Transactions - List

Referência

Serviço:: Consumption

Versão da API:: 2023-05-01

Lista de transações para instâncias reservadas no âmbito da conta de faturação. Nota: as transações de reembolso são publicadas juntamente com a transação de compra (ou seja, no mês de faturação da compra). Por exemplo, o reembolso é pedido em maio de 2021. Esta transação de reembolso terá a data do evento como maio de 2021, mas o mês de faturação em abril de 2020, quando a compra da reserva foi efetuada. Nota: o ARM tem um limite de tamanho de payload de 12 MB, pelo que os autores de chamadas atualmente recebem 400 quando o tamanho da resposta excede o limite do ARM. Nestes casos, a chamada à API deve ser feita com intervalos de datas mais pequenos.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2023-05-01

Com parâmetros opcionais:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?$filter={$filter}&api-version=2023-05-01&useMarkupIfPartner={useMarkupIfPartner}&previewMarkupPercentage={previewMarkupPercentage}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente. A versão atual é 2023-03-01.
$filter	query		string	Filtre as transações de reserva por intervalo de datas. As propriedades/EventDate para data de início e data de fim. O filtro suporta "le" e "ge". Nota: a API devolve dados para todo o mês de faturação da data de início e da data de fim. Por exemplo, as propriedades do 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á registos para as datas de 30 e 31 de dezembro)
previewMarkupPercentage	query		number decimal	Percentagem de marcação de pré-visualização a aplicar.
useMarkupIfPartner	query		boolean	Aplica a marcação às transações se o autor da chamada for um parceiro.

Respostas

Name	Tipo	Description
200 OK	ReservationTransactionsListResult	OK. O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ReservationTransactionsByEnrollmentNumber

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
ErrorDetails	Os detalhes do erro.
ErrorResponse	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”.
ReservationTransaction	Recurso de transação de reserva.
ReservationTransactionsListResult	Resultado da listagem de recomendações de reservas.

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.

ErrorResponse

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”.

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.