Transactions - Get

Referência

Serviço:: Billing

Versão da API:: 2019-10-01-preview

Obtém uma transação por ID. A operação tem suporte para contas de cobrança com o tipo de contrato Microsoft Customer Agreement ou Contrato de Parceiro da Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions/{transactionName}?periodStartDate={periodStartDate}&periodEndDate={periodEndDate}&api-version=2019-10-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
billingAccountName	path	True	string	A ID que identifica exclusivamente uma conta de cobrança.
billingProfileName	path	True	string	A ID que identifica exclusivamente um perfil de cobrança.
transactionName	path	True	string	A ID que identifica exclusivamente uma transação.
api-version	query	True	string	A versão da API a ser usada com a solicitação do cliente. A versão atual é 2019-10-01-preview.
periodEndDate	query	True	string	A data de término para buscar as transações. A data deve ser especificada no formato MM-DD-YYYY.
periodStartDate	query	True	string	A data de início para buscar as transações. A data deve ser especificada no formato MM-DD-YYYY.

Respostas

Nome	Tipo	Description
200 OK	Transaction	OKEY. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

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

Transaction

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions/{transactionName}?periodStartDate=2018-04-01&periodEndDate=2018-05-30&api-version=2019-10-01-preview

Resposta de exemplo

Código de status:: 200

{
  "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/transactions/{transactionName}",
  "name": "{transactionName}",
  "type": "Microsoft.Billing/billingAccounts/billingProfiles/transactions",
  "properties": {
    "kind": "all",
    "date": "2018-05-01T00:00:00Z",
    "invoice": "2344233",
    "productFamily": "Storage",
    "productTypeId": "A12345",
    "productType": "Reserved VM Instance",
    "productDescription": "Standard D1, US West 3",
    "transactionType": "Purchase",
    "transactionAmount": {
      "currency": "USD",
      "value": 5000
    },
    "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
    "invoiceSectionDisplayName": "Contoso operations invoiceSection",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso operations billing",
    "azureCreditApplied": {
      "currency": "USD",
      "value": 2000
    },
    "billingCurrency": "USD",
    "discount": 0.1,
    "effectivePrice": {
      "currency": "USD",
      "value": 10
    },
    "exchangeRate": 1,
    "marketPrice": {
      "currency": "USD",
      "value": 20
    },
    "pricingCurrency": "USD",
    "quantity": 1,
    "servicePeriodStartDate": "2018-05-01T00:00:00Z",
    "servicePeriodEndDate": "2018-09-30T00:00:00Z",
    "subTotal": {
      "currency": "USD",
      "value": 4500
    },
    "tax": {
      "currency": "USD",
      "value": 500
    },
    "unitOfMeasure": "1 Minute",
    "units": 11.25,
    "unitType": "1 Runtime Minute"
  }
}

Definições

Nome	Description
Amount	O valor.
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.
ErrorSubDetails
ReservationType	O tipo de transação.
Transaction	Uma transação.
TransactionTypeKind	O tipo de transação. As opções são todas ou reservas.

Amount

Objeto

O valor.

Nome	Tipo	Description
currency	string	A moeda do valor do valor.
value	number	Valor da quantidade.

ErrorDetails

Objeto

Os detalhes do erro.

Nome	Tipo	Description
code	string	Código de erro.
details	ErrorSubDetails[]	Os sub-detalhes do erro.
message	string	Mensagem de erro indicando por que a operação falhou.
target	string	O destino do erro específico.

ErrorResponse

Objeto

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.

Nome	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ErrorSubDetails

Objeto

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.
target	string	O destino do erro específico.

ReservationType

Enumeração

O tipo de transação.

Valor	Description
Purchase
Usage Charge

Transaction

Objeto

Uma transação.

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.azureCreditApplied	Amount	O valor de todos os créditos do Azure aplicados automaticamente a essa transação.
properties.billingCurrency	string	O código ISO 4217 para a moeda na qual essa transação é cobrada.
properties.billingProfileDisplayName	string	O nome do perfil de cobrança que será cobrado pela transação.
properties.billingProfileId	string	A ID do perfil de cobrança que será cobrada pela transação.
properties.customerDisplayName	string	O nome do cliente para o qual a transação ocorreu. O campo é aplicável somente para a conta de cobrança do Contrato de Parceiro da Microsoft.
properties.customerId	string	A ID do cliente para o qual a transação ocorreu. O campo é aplicável somente para a conta de cobrança do Contrato de Parceiro da Microsoft.
properties.date	string (date-time)	A data da transação.
properties.discount	number	O desconto percentual, se houver, aplicado a essa transação.
properties.effectivePrice	Amount	O preço do produto após a aplicação de descontos.
properties.exchangeRate	number	A taxa de câmbio usada para converter o valor cobrado em moeda de cobrança, se aplicável.
properties.invoice	string	Fatura na qual a transação foi cobrada ou 'pendente' se a transação não for cobrada.
properties.invoiceSectionDisplayName	string	O nome da seção da fatura que será cobrada pela transação.
properties.invoiceSectionId	string	A ID da seção da fatura que será cobrada pela transação.
properties.kind	TransactionTypeKind	O tipo de transação. As opções são todas ou reservas.
properties.marketPrice	Amount	O preço de varejo do produto.
properties.orderId	string	A ID do pedido da reserva. O campo só é aplicável para a transação de reserva de tipo.
properties.orderName	string	O nome da ordem de reserva. O campo só é aplicável para transações de reserva de tipo.
properties.pricingCurrency	string	O código ISO 4217 para a moeda na qual o produto é precificado.
properties.productDescription	string	A descrição do produto para o qual a transação ocorreu.
properties.productFamily	string	A família do produto para o qual a transação ocorreu.
properties.productType	string	O tipo do produto para o qual a transação ocorreu.
properties.productTypeId	string	A ID do tipo de produto para o qual a transação ocorreu.
properties.quantity	integer (int32)	A quantidade comprada na transação.
properties.servicePeriodEndDate	string (date-time)	A data de término do termo do produto ou a data de término do mês em que o uso terminou.
properties.servicePeriodStartDate	string (date-time)	A data da compra do produto ou a data de início do mês em que o uso foi iniciado.
properties.subTotal	Amount	O valor cobrado previamente pela transação.
properties.subscriptionId	string	A ID da assinatura que foi usada para a transação. O campo só é aplicável para a transação de reserva de tipo.
properties.subscriptionName	string	O nome da assinatura que foi usada para a transação. O campo só é aplicável para a transação de reserva de tipo.
properties.tax	Amount	O valor do imposto aplicado à transação.
properties.transactionAmount	Amount	O encargo associado à transação.
properties.transactionType	ReservationType	O tipo de transação.
properties.unitOfMeasure	string	A unidade de medida usada para cobrar pelo produto. Por exemplo, os serviços de computação são cobrados por hora.
properties.unitType	string	A descrição da unidade de medida para um determinado produto.
properties.units	number	O número de unidades usadas para um determinado produto.
type	string	Tipo de recurso.

TransactionTypeKind

Enumeração

O tipo de transação. As opções são todas ou reservas.

Valor	Description
all
reservation

Compartilhar via

Transactions - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Transaction

Solicitação de exemplo

Resposta de exemplo

Definições

Amount

ErrorDetails

ErrorResponse

ErrorSubDetails

ReservationType

Transaction

TransactionTypeKind