Products - Get By Customer

Служба:: Billing

Версия API:: 2019-10-01-preview

Возвращает продукт по идентификатору. Эта операция поддерживается только для учетных записей выставления счетов с типом соглашения Microsoft Partner Agreement.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}?api-version=2019-10-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
billingAccountName	path	True	string	Идентификатор, который однозначно идентифицирует учетную запись выставления счетов.
customerName	path	True	string	Идентификатор, который однозначно идентифицирует клиента.
productName	path	True	string	Идентификатор, который однозначно идентифицирует продукт.
api-version	query	True	string	Версия API, используемая с клиентским запросом. Текущая версия — 2019-10-01-preview.

Ответы

Имя	Тип	Описание
200 OK	Product	ХОРОШО. Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Product

Образец запроса

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}?api-version=2019-10-01-preview

Пример ответа

Код состояния:: 200

{
  "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/customers/{customerName}/products/{productName}",
  "name": "{productName}",
  "type": "Microsoft.Billing/billingAccounts/customers/products",
  "properties": {
    "productTypeId": "A12345",
    "productType": "Subscription",
    "displayName": "AIP Dev",
    "status": "Active",
    "purchaseDate": "2018-05-01T17:32:28Z",
    "lastCharge": {
      "currency": "USD",
      "value": 5000
    },
    "lastChargeDate": "2018-06-15T17:32:28Z",
    "billingFrequency": "Monthly",
    "quantity": 4,
    "skuId": "0001",
    "skuDescription": "Enterprise Agreement Development",
    "availabilityId": "AvailabilityId1",
    "parentProductId": "45000000-0000-0000-0000-0000000001242",
    "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}",
    "customerDisplayName": "Customer 1",
    "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
    "billingProfileDisplayName": "Contoso operations billing",
    "reseller": {
      "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19",
      "description": "Reseller2"
    }
  }
}

Определения

Имя	Описание
Amount	Сумма.
BillingFrequency	Частота выставления счетов за продукт.
ErrorDetails	Сведения об ошибке.
ErrorResponse	Ответ на ошибку указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.
ErrorSubDetails
Product	Продукт.
ProductStatusType	Текущее состояние продукта.
Reseller	Сведения о торговом посреднике.

Amount

Object

Сумма.

Имя	Тип	Описание
currency	string	Валюта для значения суммы.
value	number	Значение суммы.

BillingFrequency

Перечисление

Частота выставления счетов за продукт.

Значение	Описание
OneTime
Monthly
UsageBased

ErrorDetails

Object

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

Имя	Тип	Описание
code	string	Код ошибки.
details	ErrorSubDetails[]	Вложенная информация об ошибке.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.
target	string	Целевой объект конкретной ошибки.

ErrorResponse

Object

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

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке.

ErrorSubDetails

Object

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.
target	string	Целевой объект конкретной ошибки.

Product

Object

Продукт.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.availabilityId	string	Доступность продукта.
properties.billingFrequency	BillingFrequency	Частота выставления счетов за продукт.
properties.billingProfileDisplayName	string	Имя профиля выставления счетов, в котором выставляется счет за продукт.
properties.billingProfileId	string	Идентификатор профиля выставления счетов, в котором выставляется счет за продукт.
properties.customerDisplayName	string	Имя клиента, для которого приобретен продукт. Поле применимо только для учетной записи выставления счетов соглашения с партнером Майкрософт.
properties.customerId	string	Идентификатор клиента, для которого был приобретен продукт. Поле применимо только для учетной записи выставления счетов соглашения с партнером Майкрософт.
properties.displayName	string	Отображаемое имя продукта.
properties.endDate	string (date-time)	Дата продления или отмены продукта.
properties.invoiceSectionDisplayName	string	Имя раздела счета, в котором выставляется счет.
properties.invoiceSectionId	string	Идентификатор раздела счета, в котором выставляется счет.
properties.lastCharge	Amount	Плата за последний месяц.
properties.lastChargeDate	string (date-time)	Дата последнего платежа.
properties.parentProductId	string	Идентификатор родительского продукта.
properties.productType	string	Описание типа продукта.
properties.productTypeId	string	Идентификатор типа продукта.
properties.purchaseDate	string (date-time)	Дата покупки продукта.
properties.quantity	number	Количество приобретенных для продукта.
properties.reseller	Reseller	Торговый посредник для этого продукта.
properties.skuDescription	string	Описание SKU продукта.
properties.skuId	string	Идентификатор sku продукта.
properties.status	ProductStatusType	Текущее состояние продукта.
properties.tenantId	string	Идентификатор клиента, в котором используется продукт.
type	string	Тип ресурса.

ProductStatusType

Перечисление

Текущее состояние продукта.

Значение	Описание
Active
Inactive
PastDue
Expiring
Expired
Disabled
Cancelled
AutoRenew

Reseller

Object

Сведения о торговом посреднике.

Имя	Тип	Описание
description	string	Имя торгового посредника.
resellerId	string	Идентификатор MPN торгового посредника.