Product List - List By Subscription
Список продуктов для подписки.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language={language}&excludePublicOffersAndPublicPlans={excludePublicOffersAndPublicPlans}&$filter={$filter}&$select={$select}&$expand={$expand}&$orderBy={$orderBy}&$search={$search}
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID). |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
|
$expand
|
query |
string |
Расширяет встроенные связанные сущности |
|
|
$filter
|
query |
string |
Фильтрует результаты на основе логического условия. Пример: $filter=productType eq 'VirtualMachine'. Поля, по которым можно отфильтровать:
|
|
|
$order
|
query |
string |
Упорядочивание выражения для получения результатов с использованием нотации OData. Избегайте использования orderby, если в этом нет необходимости, так как это может повлиять на задержку вашего запроса. Пример: $orderby=displayName desc. Этот API поддерживает упорядочивание только по одному полю. Поля, которые можно упорядочить, следующие:
|
|
|
$search
|
query |
string |
Необязательный поиск по отображаемому имени, отображаемому имени издателя или ключевым словам. Пример $search=Microsoft |
|
|
$select
|
query |
string |
Выбирает свойства для включения в результаты. Пример: $select=displayName |
|
|
exclude
|
query |
boolean |
Следует ли исключать из ответа публичные предложения и публичные планы. Значение по умолчанию равно false, что означает, что в ответ включены публичные предложения и публичные планы. Если установлено значение true, будут возвращены только частные планы. |
|
|
language
|
query |
string |
Язык для поиска, двухбуквенный код ISO 639-1, возможные значения - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. По умолчанию используется "en" |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
ProductList_ListBySubscription
Образец запроса
GET https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$filter=productType eq 'SaaS'&$select=displayName,uniqueProductId,productType,publisherDisplayName
Пример ответа
{
"value": [
{
"uniqueProductId": "microsoft.managedinstance_standard",
"displayName": "Azure SQL Managed Instance",
"publisherDisplayName": "Microsoft",
"productType": "SaaS"
}
],
"nextLink": "https://management.azure.com/subscriptions/f47ac10b-58cc-4372-a567-0e02b2c3d479/providers/Microsoft.Marketplace/products?api-version=2025-05-01&language=en&$select=displayName,uniqueProductId,productType,publisherDisplayName&$filter=productType eq 'SaaS'&$skiptoken=W3sid..."
}
Определения
| Имя | Описание |
|---|---|
| Attribute |
Представляет атрибут SKU, который состоит из ключа и значения. Атрибуты могут отличаться в зависимости от службы. |
|
Discovery |
Сведения об ошибке, возвращенные в DiscoveryErrorPayload |
|
Discovery |
Полезные данные об ошибках, возвращаемые API-интерфейсами Marketplace Discovery |
|
Plan |
Дополнительные метаданные |
|
Plan |
Возвращает подмножество атрибутов Plan |
|
Product |
Возвращает подмножество атрибутов Product |
|
Product |
Пользовательский ответ на операцию списка. |
Attribute
Представляет атрибут SKU, который состоит из ключа и значения. Атрибуты могут отличаться в зависимости от службы.
| Имя | Тип | Описание |
|---|---|---|
| key |
string |
Ключ атрибута |
| value |
string |
Значение атрибута |
DiscoveryErrorDetails
Сведения об ошибке, возвращенные в DiscoveryErrorPayload
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки HTTP |
| message |
string |
Сообщение об ошибке |
DiscoveryErrorPayload
Полезные данные об ошибках, возвращаемые API-интерфейсами Marketplace Discovery
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект сведений об ошибке |
PlanMetadata
Дополнительные метаданные
| Имя | Тип | Описание |
|---|---|---|
| altStackReference |
string |
Указание на planId, который содержит альтернативную ссылку на стек |
| generation |
string |
Создание образа виртуальной машины (применимо только к продуктам виртуальных машин) |
PlanSummary
Возвращает подмножество атрибутов Plan
| Имя | Тип | Описание |
|---|---|---|
| altArchitectureReference |
string |
Справочник по альтернативной архитектуре |
| altStackReference |
string |
Справочник по альтернативному стеку |
| categoryIds |
string[] |
Идентификаторы категорий тарифных планов |
| cspState |
string |
Контролирует доступность планов и доступ партнеров в рамках программы Microsoft Cloud Solution Provider (CSP).
|
| description |
string |
План / описание артикула |
| displayName |
string |
Отображаемое название плана / артикул |
| displayRank |
string |
Порядок выполнения плана отображается в таблице "Планы" |
| hasProtectedArtifacts |
boolean |
Установите значение true, если в плане есть артефакты, которые должны быть скрыты для неаутентифицированных пользователей |
| hasRi |
boolean |
Указание на то, поддерживает ли SKU резервирование |
| isPrivate |
boolean |
Указание на то, что тарифный план доступен только для ограниченной аудитории |
| metadata |
Расширены метаданные плана/SKU. |
|
| planId |
string |
Идентификатор плана |
| planType |
string |
Указывает основную модель развертывания и архитектуру размещения для продукта Marketplace. В настоящее время поддерживаются следующие значения:
|
| pricingTypes |
string[] |
Указывает модели выставления счетов и структуры затрат, доступные для плана.
|
| skuId |
string |
Идентификатор SKU |
| stackType |
string |
Тип стека : Классический, Gen1, Gen2 |
| summary |
string |
Текст резюме плана |
| uniquePlanId |
string |
Уникальный идентификатор плана, который имеет префикс путем объединения uniqueProductId и PlanId без разделителя между ними |
| vmArchitectureType |
string |
Указывает архитектуру и поколение процессора виртуальной машины. Применяется исключительно к типам продуктов виртуальных машин.
|
| vmSecuritytypes |
string[] |
Определяет уровень повышения безопасности для развертываний виртуальных машин. Применяется исключительно к типам продуктов виртуальных машин.
|
ProductSummary
Возвращает подмножество атрибутов Product
| Имя | Тип | Описание |
|---|---|---|
| applicableProducts |
string[] |
Категории товаров, к которым относится предложение |
| attributes |
Набор атрибутов товаров |
|
| azureBenefit |
string |
Указывает, учитываются ли покупки продуктов в рамках обязательств по потреблению Azure для корпоративных клиентов.
|
| badges |
string[] |
Отображает значки сертификации и квалификации, полученные продуктом, для видимости на рынке.
|
| categoryIds |
string[] |
Массив категорий товаров |
| cspLegalTermsUri |
string |
Юридические условия продукта для CSP |
| description |
string |
Текст описания товара |
| displayName |
string |
Отображаемое название продукта |
| hasMarketplaceFootprint |
boolean |
Указание на то, есть ли у товара представительство на рынке |
| hasRiPlans |
boolean |
Указание наличия у товара тарифных планов с оговорками |
| industryIds |
string[] |
Список отраслевых идентификаторов, к которым принадлежит товар |
| lastModifiedDateTime |
string |
Дата последнего обновления продукта |
| locations |
string[] |
Список местоположений, доступных в SKU |
| longSummary |
string |
Общий текст продукта |
| operatingSystems |
string[] |
Информация об операционной системе для этого продукта |
| plans |
Полный набор атрибутов плана/SKU |
|
| popularity |
number (double) |
Популярность продукта |
| pricingTypes |
string[] |
Указывает модели выставления счетов и структуры затрат, доступные для плана.
|
| privacyPolicyUri |
string |
Политика конфиденциальности продукта |
| productFamily |
string |
Семейство продуктов |
| productId |
string |
Уникальный идентификатор товара |
| productSubType |
string |
Подтип продукта |
| productType |
string |
Указывает основную модель развертывания и архитектуру размещения для продукта Marketplace, хранящегося в каталоге Marketplace.
|
| publisherDisplayName |
string |
Отображаемое имя издателя |
| publisherId |
string |
Идентификатор издателя |
| publisherType |
string |
Определяет отношения издателя с корпорацией Майкрософт для классификации поддержки и партнерства.
|
| publishingStage |
string |
Указывает состояние доступности продукта и уровень доступа клиентов в Azure Marketplace.
|
| ratingAverage |
number (double) |
Средний рейтинг по офферу |
| ratingBuckets |
string[] |
Классифицирует продукты по пороговым значениям рейтинга клиентов для фильтрации и обнаружения на маркетплейсе.
|
| ratingCount |
integer (int32) |
Общее количество оценок по офферу |
| service |
string |
Название службы продукта, например "Виртуальные машины" |
| serviceFamily |
string |
Семейство служб продукта, например "Вычисления" |
| smallIconUri |
string |
URI к маленькому значку продукта |
| summary |
string |
Краткая информация о продукте |
| supportedProducts |
string[] |
Карты со списком совместимых продуктов |
| uniqueProductId |
string |
Уникальный идентификатор продукта |
ProductSummaryListResult
Пользовательский ответ на операцию списка.
| Имя | Тип | Описание |
|---|---|---|
| nextLink |
string |
Ссылка на следующую страницу элементов |
| value |
Элементы на этой странице |