Выставленные счета и неоплачиваемые ежедневные оценки API выверки использования версии 2 (GA)

Область применения: Центр партнеров (недоступно в Azure для государственных организаций или Azure China 21Vianet.)

Наш новый асинхронный API предлагает более быстрый и эффективный способ доступа к данным выставления счетов и выверки через большие двоичные объекты Azure. Вместо того, чтобы держать подключение открытым в течение нескольких часов или обрабатывать пакеты из 2000 элементов строки, теперь можно упростить рабочий процесс.

Новые API-интерфейсы выверки использования ежедневной коммерции используют расширенные методы, такие как ключ valet и асинхронные шаблоны ответа на запросы. Эти API предоставляют маркер подписанного URL-адреса (SAS), который можно использовать для доступа ко всем атрибутам или подмножества ежедневных данных сверки использования.

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

Эти API можно использовать только для общедоступного или глобального облака MS Graph. Они пока недоступны для Azure для государственных организаций или Azure China 21Vianet.

Обзор API

Для асинхронного получения выставленных счетов за новую коммерческую торговлю ежедневно оцененных элементов линии использования мы предлагаем две ключевые конечные точки API. Ниже приведено упрощенное руководство по началу работы:

Конечная точка элемента строки использования

Во-первых, используйте этот API для получения новых элементов линии использования ежедневной коммерческой торговли . При выполнении запроса вы получаете состояние HTTP 202 и заголовок расположения с URL-адресом. Регулярно опросите этот URL-адрес, пока не получите состояние успешного выполнения и URL-адрес манифеста.

Конечная точка состояния операции

Затем продолжайте проверять состояние операции, вызывая этот API через регулярные интервалы. Если данные не готовы, ответ включает заголовок Retry-After , указывающий, как долго ждать, прежде чем повторить попытку. После завершения операции вы получите ресурс манифеста со ссылкой на папку хранилища, чтобы скачать данные об использовании. Ответ сегментирует файлы, чтобы повысить пропускную способность и разрешить параллелизм ввода-вывода.

Выполнив следующие действия, вы можете эффективно управлять процессом выверки счетов.

Схема последовательностей

Ниже приведена схема последовательности, на которую показано, как скачать данные выверки.

Последовательность действий пользователя

Чтобы получить новые элементы линии выверки использования ежедневной коммерческой торговли , выполните следующие действия.

Шаг 1. Отправка запроса

Отправьте запрос POST в конечную точку API.

Получение необясченных ежедневных строк использования

Получение новых элементов линии ежедневного использования для текущего или последнего календарного месяца или периода выставления счетов.

Запрос API

POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/unbilled/export

Accept: application/json

Content-Type: application/json

{

"currencyCode": "USD",

"billingPeriod": "current",

"attributeSet": "basic"

}

Текст запроса

Заголовки запросов

Чтобы запросить заголовки API, см. сведения о надежности и поддержке.

Ответ API

HTTP/1.1 202 Accepted  
Location: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

API обычно отвечает с состоянием HTTP 202. Вы также можете столкнуться с другими состояниями в зависимости от ваших запросов. Эти состояния перечислены в разделе состояния ответа API "Стандартный".

Получение оплачиваемых ежедневных строк использования

Получение новых выставленных счетов за ежедневное выставление счетов за выставление счетов за закрытый период выставления счетов.

Запрос API

POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/billed/export

{  
"invoiceId": "G00012345",  
"attributeSet": "full"  
}

Параметры запроса

Н/П

Текст запроса

Заголовок запроса

Заголовок запроса для API. Дополнительные сведения см. в статье о надежности и поддержке.

Ответ API

Принято HTTP/1.1 202
Расположение: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

При использовании API обычно возвращается состояние HTTP 202. Сведения о других возможных состояниях на основе запросов см. в разделе "Состояния".

Шаг 2. Проверка состояния запроса

Чтобы отслеживать состояние запроса, убедитесь, что вы получите ответ HTTP 200, указывающий на "успешно" или "неудачно". В случае успешного выполнения вы найдете URL-адрес манифеста в атрибуте resourceLocation. Этот атрибут предоставляет конечную точку для доступа к необходимым сведениям.

Получение состояния операции

Извлекает состояние запроса.

Запрос API

GET https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14

Параметры запроса

Заголовок запроса

Чтобы запросить заголовки API, см. сведения о надежности и поддержке.

Текст запроса

Недоступно

Состояние ответа

Помимо стандартных состояний HTTP, перечисленных в состояниях ответа API уровня "Стандартный", API также может возвращать следующее состояние HTTP:

Полезные данные ответа

Полезные данные ответа API включают следующие атрибуты:

Объект расположения ресурсов

Запрос API

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

Ответ API

Ответ рекомендует ждать 10 секунд, прежде чем повторить попытку при обработке данных.

HTTP/1.1 200 OK  
Retry-After: 10  
{  
"id": "9ab9cb54-d07f-4f52-9ea6-a09d7de52c14",  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime": "2022-06-1T10-01-05Z",  
"status": "running"  
}

Запрос API

(через 10 секунд после предыдущего запроса...)

GET <https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14>

Ответ API

API возвращает состояние "успешно" и универсальный код ресурса (URI) для resourceLocation.

HTTP/1.1 200 OK  
Content-Type: application/json  
{

    "@odata.context": "https://graph.microsoft.com/v1.0/\$metadata#reports/partners/billing/operations/\$entity",

    "@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation",

    "id": "f2170b13-6a8e-47d6-b481-6988490dc0cb",

    "createdDateTime": "2023-12-05T21:17:29Z",

    "lastActionDateTime": "2023-12-05T21:18:00.8897902Z",

    "status": "succeeded",

    "resourceLocation": {

        "id": "44e8500b-ab92-490e-8ac3-90500a1d3427",

        "createdDateTime": "2023-11-06T19:58:47.513Z",

        "schemaVersion": "2",

        "dataFormat": "compressedJSON",

        "partitionType": "default",

        "eTag": "RwDrn7fbiTXy6UULE",

        "partnerTenantId": "0e195b37-4574-4539-bc42-0e539b9684c0",

        "rootDirectory": "https://adlsreconbuprodeastus201.blob.core.windows.net/path_id",

        "sasToken": "{token}",

        "blobCount": 1,

        "blobs": \[

            {

                "name": "part-00123-5a93fa5d-749f-48bc-a372-9b021d93c3fa.c000.json.gz",

                "partitionValue": "default"

            }

        \]

    }

}

Шаг 3. Скачивание ежедневных элементов сверки использования из хранилища BLOB-объектов Azure

Сначала необходимо получить маркер подписанного URL-адреса (SAS) и расположение хранилища BLOB-объектов. Эти сведения можно найти в свойствах sasToken и rootDirectory ответа API полезных данных манифеста. Затем, чтобы скачать и распаковать файл БОЛЬШОго двоичного объекта, используйте пакет SDK или средство служба хранилища Azure. Он находится в формате JSONLines .

Стандартные состояния ответа API

Эти состояния HTTP можно получить из ответа API:

Сравнение версий бета-версии и общедоступной версии

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

Атрибуты элементов линии выверки ежедневного оценки использования

Чтобы сравнить атрибуты, возвращаемые API выверки выставленного счета для наборов атрибутов full или basic, см. в следующей таблице. Дополнительные сведения об этих атрибутах см. в этой документации.

Пример кода

Чтобы использовать этот API, см. следующую ссылку, включающую пример кода C#.

Примеры API Центра партнеров: получение данных о рекогносцировке выставления счетов.