Events - List By Billing Profile

Ссылка

Service:: Consumption

API Version:: 2021-10-01

Список событий, которые уменьшает кредиты Azure или Microsoft Azure обязательства по использованию для учетной записи выставления счетов или профиля выставления счетов для заданной даты начала и окончания.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events?api-version=2021-10-01&startDate={startDate}&endDate={endDate}

Параметры URI

Name	In	Required	Type	Description
billingAccountId	path	True	string	Идентификатор BillingAccount
billingProfileId	path	True	string	Идентификатор профиля выставления счетов Azure.
api-version	query	True	string	Версия API, используемая с клиентским запросом. Текущая версия — 2021-10-01.
endDate	query	True	string	Дата окончания
startDate	query	True	string	Дата начала

Ответы

Name	Type	Description
200 OK	Events	Все в порядке. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

EventsListByBillingProfile

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events?api-version=2021-10-01&startDate=2019-09-01&endDate=2019-10-31

import com.azure.core.util.Context;

/** Samples for EventsOperation ListByBillingProfile. */
public final class Main {
    /*
     * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/EventsListByBillingProfile.json
     */
    /**
     * Sample code: EventsListByBillingProfile.
     *
     * @param manager Entry point to ConsumptionManager.
     */
    public static void eventsListByBillingProfile(com.azure.resourcemanager.consumption.ConsumptionManager manager) {
        manager.eventsOperations().listByBillingProfile("1234:5678", "4268", "2019-09-01", "2019-10-31", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armconsumption_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/consumption/armconsumption"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/EventsListByBillingProfile.json
func ExampleEventsClient_NewListByBillingProfilePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armconsumption.NewEventsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByBillingProfilePager("1234:5678",
		"4268",
		"2019-09-01",
		"2019-10-31",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

const { ConsumptionManagementClient } = require("@azure/arm-consumption");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.
 *
 * @summary Lists the events that decrements Azure credits or Microsoft Azure consumption commitment for a billing account or a billing profile for a given start and end date.
 * x-ms-original-file: specification/consumption/resource-manager/Microsoft.Consumption/stable/2021-10-01/examples/EventsListByBillingProfile.json
 */
async function eventsListByBillingProfile() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountId = "1234:5678";
  const billingProfileId = "4268";
  const startDate = "2019-09-01";
  const endDate = "2019-10-31";
  const credential = new DefaultAzureCredential();
  const client = new ConsumptionManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.eventsOperations.listByBillingProfile(
    billingAccountId,
    billingProfileId,
    startDate,
    endDate
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

eventsListByBillingProfile().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event1",
      "name": "event1",
      "type": "Microsoft.Consumption/events",
      "properties": {
        "transactionDate": "2019-07-01T00:00:00Z",
        "description": "Settled invoice #312033",
        "creditCurrency": "USD",
        "reseller": {
          "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
          "resellerDescription": "Reseller information"
        },
        "billingCurrency": "USD",
        "newCredit": {
          "currency": "USD",
          "value": 0
        },
        "newCreditInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "adjustments": {
          "currency": "USD",
          "value": 0
        },
        "adjustmentsInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "creditExpired": {
          "currency": "USD",
          "value": 0
        },
        "creditExpiredInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "charges": {
          "currency": "USD",
          "value": 500
        },
        "chargesInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "closedBalance": {
          "currency": "USD",
          "value": 500
        },
        "closedBalanceInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "eventType": "SettledCharges",
        "invoiceNumber": "3301"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event2",
      "name": "event2",
      "type": "Microsoft.Consumption/events",
      "properties": {
        "transactionDate": "2019-08-01T00:00:00Z",
        "description": "New credits added",
        "creditCurrency": "USD",
        "reseller": {
          "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
          "resellerDescription": "Reseller information"
        },
        "billingCurrency": "USD",
        "newCredit": {
          "currency": "USD",
          "value": 400
        },
        "newCreditInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "canceledCredit": {
          "currency": "USD",
          "value": 5000
        },
        "adjustments": {
          "currency": "USD",
          "value": 0
        },
        "adjustmentsInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "creditExpired": {
          "currency": "USD",
          "value": 0
        },
        "creditExpiredInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "charges": {
          "currency": "USD",
          "value": 0
        },
        "chargesInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "closedBalance": {
          "currency": "USD",
          "value": 900
        },
        "closedBalanceInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "eventType": "NewCredit",
        "invoiceNumber": "3302"
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event3",
      "name": "event3",
      "type": "Microsoft.Consumption/events",
      "properties": {
        "transactionDate": "2019-09-01T00:00:00Z",
        "description": "Credits Expired",
        "creditCurrency": "USD",
        "reseller": {
          "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
          "resellerDescription": "Reseller information"
        },
        "billingCurrency": "USD",
        "newCredit": {
          "currency": "USD",
          "value": 0
        },
        "newCreditInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "canceledCredit": {
          "currency": "USD",
          "value": 5000
        },
        "adjustments": {
          "currency": "USD",
          "value": 0
        },
        "adjustmentsInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "creditExpired": {
          "currency": "USD",
          "value": 300
        },
        "creditExpiredInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "charges": {
          "currency": "USD",
          "value": 0
        },
        "chargesInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "closedBalance": {
          "currency": "USD",
          "value": 600
        },
        "closedBalanceInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "eventType": "ExpiredCredit",
        "invoiceNumber": ""
      }
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/4268/providers/Microsoft.Consumption/events/event4",
      "name": "event4",
      "type": "Microsoft.Consumption/events",
      "properties": {
        "transactionDate": "2021-10-01T00:00:00Z",
        "description": "Settled invoice #212033",
        "creditCurrency": "USD",
        "reseller": {
          "resellerId": "/providers/Microsoft.Billing/billingAccounts/1234:5678/billingProfiles/2468/providers/Microsoft.Consumption/reseller/reseller1",
          "resellerDescription": "Reseller information"
        },
        "billingCurrency": "USD",
        "newCredit": {
          "currency": "USD",
          "value": 300
        },
        "newCreditInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "canceledCredit": {
          "currency": "USD",
          "value": 5000
        },
        "adjustments": {
          "currency": "USD",
          "value": -200
        },
        "adjustmentsInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "creditExpired": {
          "currency": "USD",
          "value": 100
        },
        "creditExpiredInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "charges": {
          "currency": "USD",
          "value": 300
        },
        "chargesInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "closedBalance": {
          "currency": "USD",
          "value": 700
        },
        "closedBalanceInBillingCurrency": {
          "exchangeRate": 5000,
          "exchangeRateMonth": 1
        },
        "eventType": "SettledCharges",
        "invoiceNumber": "3303"
      }
    }
  ]
}

Определения

amount	Сумма плюс валюта.
AmountWithExchangeRate	Сумма с обменным курсом.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке. Некоторые ответы на ошибки: 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.
Events	Результат перечисления сводки событий.
EventSummary	Ресурс сводки событий.
EventType	Определяет тип события.
Reseller	Свойства торгового посредника.

amount

Сумма плюс валюта.

Name	Type	Description
currency	string	Сумма валюты.
value	number	Сумма.

AmountWithExchangeRate

Сумма с обменным курсом.

Name	Type	Description
currency	string	Сумма валюты.
exchangeRate	number	Обменный курс.
exchangeRateMonth	integer	Месяц обмена.
value	number	Сумма.

ErrorDetails

Сведения об ошибке.

Name	Type	Description
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

ErrorResponse

Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.

Name	Type	Description
error	ErrorDetails	Сведения об ошибке.

Events

Результат перечисления сводки событий.

Name	Type	Description
nextLink	string	Ссылка (URL-адрес) на следующую страницу результатов.
value	EventSummary[]	Список сводки событий.

EventSummary

Ресурс сводки событий.

Name	Type	Description
eTag	string	eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.adjustments	amount	Сумма корректировки баланса. Свойство недоступно для объекта ConsumptionCommitment.
properties.adjustmentsInBillingCurrency	AmountWithExchangeRate	Сумма корректировки баланса в валюте выставления счетов.
properties.billingCurrency	string	Валюта выставления счетов события.
properties.billingProfileDisplayName	string	Отображаемое имя профиля выставления счетов, для которого произошло событие. Свойство доступно только для учетной записи выставления счетов типа MicrosoftCustomerAgreement.
properties.billingProfileId	string	Идентификатор, однозначно определяющий профиль выставления счетов, для которого произошло событие. Свойство доступно только для учетной записи выставления счетов типа MicrosoftCustomerAgreement.
properties.canceledCredit	amount	Сумма отмененного кредита.
properties.charges	amount	Сумма расходов на события типа SettleCharges и PendingEligibleCharges.
properties.chargesInBillingCurrency	AmountWithExchangeRate	Сумма расходов за события типа SettleCharges и PendingEligibleCharges в валюте выставления счетов.
properties.closedBalance	amount	Сальдо после события.
properties.closedBalanceInBillingCurrency	AmountWithExchangeRate	Баланс в валюте выставления счетов после события.
properties.creditCurrency	string	Кредитная валюта события.
properties.creditExpired	amount	Сумма просроченного кредита или обязательства для события NewCredit или SettleCharges.
properties.creditExpiredInBillingCurrency	AmountWithExchangeRate	Сумма просроченного кредита или обязательства для события NewCredit или SettleCharges в валюте выставления счетов.
properties.description	string	Описание события.
properties.eTag	string	ETag для ресурса.
properties.eventType	EventType	Определяет тип события.
properties.invoiceNumber	string	Номер, однозначно определяющий счет, по которому выставляется счет. Этот параметр будет пустым для необясченных событий.
properties.lotId	string	Идентификатор, однозначно определяющий количество, для которого произошло событие.
properties.lotSource	string	Определяет источник количества, для которого произошло событие.
properties.newCredit	amount	Сумма нового кредита или обязательства для события NewCredit или SettleCharges.
properties.newCreditInBillingCurrency	AmountWithExchangeRate	Сумма нового кредита или обязательства для события NewCredit или SettleCharges в валюте выставления счетов.
properties.reseller	Reseller	Торговый посредник события.
properties.transactionDate	string	Дата события.
type	string	Тип ресурса.

EventType

Определяет тип события.

Name	Type	Description
CreditExpired	string
NewCredit	string
PendingAdjustments	string
PendingCharges	string
PendingExpiredCredit	string
PendingNewCredit	string
SettledCharges	string
UnKnown	string

Reseller

Свойства торгового посредника.

Name	Type	Description
resellerDescription	string	Описание свойства торгового посредника.
resellerId	string	Идентификатор свойства торгового посредника.