Products - List
Получите список коммерческих общедоступных продуктов.
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&storefront={storefront}&language={language}&locations={locations}&market={market}&hideKeys={hideKeys}&select={select}&filter={filter}&expand={expand}&orderby={orderby}
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Версия REST API, используемая для запроса. |
|
expand
|
query |
string[] |
Расширяет встроенные связанные сущности. Пример: "expand=startingPrice" |
|
|
filter
|
query |
string |
Фильтрует результаты на основе логического условия. Пример: filter=productType eq "VirtualMachine". Поля, которые можно фильтровать по:
|
|
|
hide
|
query |
string[] |
Этот ключ используется для получения предварительных версий продуктов и создается в Центре партнеров во время процесса публикации предложения. |
|
|
language
|
query |
string |
Язык для поиска, код ISO 639-1 с двумя буквами, возможные значения - "en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant". Значение по умолчанию — en |
|
|
locations
|
query |
string[] |
Возвращать продукты, доступные в выбранном расположении. Перечисление регионов центра обработки данных Azure. См. https://azure.microsoft.com/regions/ |
|
|
market
|
query |
string |
Стоимость рынка продукта (ответ будет включать только продукты, которые могут продаваться на указанном рынке) Возможные значения можно найти в https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Пример: "US" |
|
|
orderby
|
query |
string |
Выражение упорядочивания результатов с помощью нотации OData. Избегайте использования orderby, если это не может повлиять на задержку запроса. Пример: orderby=displayName desc. Этот API поддерживает только упорядочивание по одному полю. Поля, которые можно упорядочить, являются следующими:
|
|
|
select
|
query |
string[] |
Выбирает свойства, которые необходимо включить в результаты. Пример: 'select=displayName' |
|
|
storefront
|
query |
string |
Возвращайте продукты, доступные на портале Azure Portal Marketplace, AppSource или на портале Azure Marketplace. Возможные значения:
|
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| X-API-Key | True |
string |
Использование ключа API, предоставленного командой каталога Marketplace в качестве параметра, предоставленного в заголовке |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Возвращает список общедоступных или предварительных версий продуктов |
|
| Other Status Codes |
Ответы на ошибки:
Заголовки x-ms-error-code: string |
Примеры
List_Products
Образец запроса
GET https://catalogapi.azure.com/products?api-version=2023-05-01-preview&language=en&market=US
Пример ответа
{
"items": [
{
"displayName": "productDisplayName",
"popularity": 1,
"categoryIds": [
"monitoring-and-diagnostics",
"virtualMachine"
],
"industryIds": [
"consumer-goods",
"retailers"
],
"publisherId": "Microsoft",
"azureBenefit": "Eligible",
"badges": [
"ExternalPurchase"
],
"publisherType": "Microsoft",
"publishingStage": "Public",
"uniqueProductId": "uniqueProductId",
"productType": "VirtualMachine",
"productSubType": "Azure",
"operatingSystems": [
"windows.others"
],
"pricingTypes": [
"Payg"
],
"publisherDisplayName": "Microsoft",
"longSummary": "longSummary",
"summary": "summary",
"smallIconUri": "SomeIconUri",
"description": "productDescription",
"ratingBuckets": [
"AboveOne"
],
"ratingAverage": 0,
"ratingCount": 0,
"plans": [
{
"planId": "plan1Id",
"uniquePlanId": "uniquePlan1Id",
"displayName": "displayName",
"vmArchitectureType": "X64Gen1",
"cspState": "SelectiveOptIn",
"metadata": {
"generation": null,
"altStackReference": null
},
"altStackReference": "altStackReference",
"stackType": "Classic",
"altArchitectureReference": "altArchitectureReference",
"categoryIds": [],
"hasProtectedArtifacts": false,
"pricingTypes": [
"Payg"
],
"vmSecuritytypes": [
"None"
],
"summary": "PlanSummary",
"description": "plan description",
"skuId": "0001",
"planType": "VirtualMachine",
"displayRank": "2147483647",
"isPrivate": false
}
],
"supportedProducts": [
"suportedProduct1"
],
"applicableProducts": [
"applicableProduct1"
],
"locations": [
"EU North"
],
"serviceFamily": "service family",
"service": "service name",
"productId": "product id",
"hasMarketplaceFootprint": true,
"attributes": null,
"lastModifiedDateTime": "2022-02-14T23:31:25.5733368+00:00"
},
{
"displayName": "display name",
"popularity": 0,
"publisherId": "Microsoft",
"azureBenefit": "NotEligible",
"publisherType": "Microsoft",
"productType": "AzureServices",
"productSubType": "Azure",
"pricingTypes": [],
"publisherDisplayName": "Microsoft",
"description": "description",
"locations": [
"US West 2",
"UK South",
"BR South"
],
"serviceFamily": "Compute",
"service": "Virtual Machines",
"productId": "product id",
"hasMarketplaceFootprint": false,
"attributes": [
{
"key": "attr1",
"value": "val1"
}
]
}
],
"nextPageLink": "https://catalogapi.azure.com/products?api-version=2023-05-01-preview&$skiptoken=W3s..."
}
Определения
| Имя | Описание |
|---|---|
| Attribute |
Представляет атрибут SKU, состоящий из ключа и значения. Атрибуты могут отличаться между различными службами. |
|
Azure |
Право на получение преимущества обязательств по использованию Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Возможные значения:
|
| Badge |
Тип индикатора событий |
|
Catalog |
Страница ответа, состоящая из списка объектов Product (включая подмножество атрибутов продукта) вместе со следующей ссылкой на страницу. Обычно атрибуты продукта, возвращаемые в списке, используются для создания плиток продукта для коллекции Marketplace. Примечание.Примечание. Максимальное количество возвращаемых элементов на страницу равно 100. В конкретных случаях для оптимизации производительности обратитесь к группе microsoft Marketplace MKPL_Platform_API_DL@microsoft.com |
|
Csp |
Значение, показывающее, доступен ли план для покупки через канал CSP. Возможные значения:
|
|
Error |
Объект ответа об ошибке API |
|
Error |
Объект сведений об ответе об ошибке API |
| Metadata |
Расширенные метаданные плана или SKU. |
|
Plan |
Указание на связанный объект SKU |
|
Plan |
Возвращает подмножество атрибутов плана |
|
Plan |
Тип плана шаблона управляемого приложения или решения (применимо только к продукту приложений Azure). Возможные значения:
|
|
Pricing |
Тип ценообразования |
|
Product |
Возвращает подмножество атрибутов Product |
|
Product |
Метод доставки или модель развертывания. Возможные значения:
|
|
Publisher |
Значение, указывающее, является ли это продуктом Майкрософт или сторонним продуктом. Возможные значения:
|
|
Publishing |
Этап публикации продукта. Возможные значения:
|
|
Rating |
Сегмент оценки |
| Sku |
Артикул |
|
Starting |
Розничная цена самого дешевого плана продукта |
|
Vm |
Тип архитектуры виртуальной машины. Применимо только к продуктам виртуальной машины. Возможные значения:
|
|
Vm |
Тип безопасности виртуальной машины. Применимо только к продуктам виртуальной машины. Возможные значения:
|
Attribute
Представляет атрибут SKU, состоящий из ключа и значения. Атрибуты могут отличаться между различными службами.
| Имя | Тип | Описание |
|---|---|---|
| key |
string |
Ключ атрибута |
| value |
string |
Значение атрибута |
AzureBenefit
Право на получение преимущества обязательств по использованию Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Возможные значения:
-
Eligible. Продукт имеет право на преимущество использования Azure -
NotEligible. Продукт не имеет права на преимущество обязательства по использованию Azure
| Значение | Описание |
|---|---|
| Eligible | |
| NotEligible |
Badge
Тип индикатора событий
| Значение | Описание |
|---|---|
| PreferredSolution | |
| PowerBICertified | |
| AdditionalPurchaseRequirement |
CatalogApiResponse
Страница ответа, состоящая из списка объектов Product (включая подмножество атрибутов продукта) вместе со следующей ссылкой на страницу. Обычно атрибуты продукта, возвращаемые в списке, используются для создания плиток продукта для коллекции Marketplace. Примечание.Примечание. Максимальное количество возвращаемых элементов на страницу равно 100. В конкретных случаях для оптимизации производительности обратитесь к группе microsoft Marketplace MKPL_Platform_API_DL@microsoft.com
| Имя | Тип | Описание |
|---|---|---|
| items |
Список возвращаемых элементов |
|
| nextPageLink |
string (uri) |
Ссылка на следующую страницу, где запрос возвращает более одной страницы результатов |
CspState
Значение, показывающее, доступен ли план для покупки через канал CSP. Возможные значения:
-
OptIn. Планирование настройки программы CSP для любого партнера в программе CSP -
Optout. Планирование настроенной программы CSP -
SelectiveOptIn. Планирование настройки программы CSP для определенных партнеров в программе CSP выбирает поставщик программного обеспечения. Дополнительные сведения см. в https://docs.microsoft.com/en-us/azure/marketplace/cloud-solution-providers
| Значение | Описание |
|---|---|
| OptIn | |
| OptOut | |
| SelectiveOptIn |
ErrorResponse
Объект ответа об ошибке API
| Имя | Тип | Описание |
|---|---|---|
| error |
Сведения об ответе API |
ErrorResponseDetails
Объект сведений об ответе об ошибке API
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Описание кода ошибки. Например, code=InternalError |
| message |
string |
Сообщение об ошибке. Например, сообщение=Внутренняя ошибка сервера |
Metadata
Расширенные метаданные плана или SKU.
| Имя | Тип | Описание |
|---|---|---|
| altStackReference |
string |
Указание на planId, в котором содержится альтернативная ссылка на стек |
| generation |
string |
Создание образа виртуальной машины (применимо только к продуктам виртуальной машины).см. https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2 |
| relatedSkus |
Указание на планId планов, связанных с этим планом |
PlanSkuRelation
Указание на связанный объект SKU
| Имя | Тип | Описание |
|---|---|---|
| relationType |
string |
Тип отношения |
| sku |
Артикул |
PlanSummary
Возвращает подмножество атрибутов плана
| Имя | Тип | Описание |
|---|---|---|
| altArchitectureReference |
string |
Справочник по альтернативной архитектуре |
| altStackReference |
string |
Альтернативный справочник по стеку |
| categoryIds |
string[] |
Планирование идентификаторов категорий |
| cspState |
Значение, показывающее, доступен ли план для покупки через канал CSP. Возможные значения:
|
|
| description |
string |
Описание плана или номера SKU |
| displayName |
string |
Отображаемое имя плана / sku |
| displayRank |
string |
Порядок, который план отображается в таблице "Планы" (как настроено издателем) |
| hasProtectedArtifacts |
boolean |
Установите значение true, если план имеет артефакты, которые должны быть скрыты для пользователей, не прошедших проверку подлинности |
| hasRI |
boolean |
Указание того, поддерживает ли SKU резервирования |
| isPrivate |
boolean |
Указывает, что план доступен только для ограниченной аудитории |
| metadata |
Расширенные метаданные плана или SKU. |
|
| planId |
string |
Идентификатор плана |
| planType |
Тип плана шаблона управляемого приложения или решения (применимо только к продукту приложений Azure). Возможные значения:
|
|
| pricingTypes |
Список типов цен, для которых назначен этот план (возможные значения совпадают с уровнем продукта). |
|
| skuId |
string |
Идентификатор SKU |
| stackType |
string |
Тип стека: классический, 1-го поколения, 2-го поколения |
| summary |
string |
Текст сводки плана |
| uniquePlanId |
string |
Уникальный идентификатор плана, который префиксируется путем объединения uniqueProductId и PlanId без разделителя между |
| vmArchitectureType |
Тип архитектуры виртуальной машины. Применимо только к продуктам виртуальной машины. Возможные значения:
|
|
| vmSecuritytypes |
Тип безопасности виртуальной машины. Применимо только к продуктам виртуальной машины. Возможные значения:
|
PlanType
Тип плана шаблона управляемого приложения или решения (применимо только к продукту приложений Azure). Возможные значения:
-
SolutionTemplate— тип плана шаблона решения (применимо только к приложениям Azure) -
ManagedApplication— тип плана управляемого приложения (применимо только к приложениям Azure)
PricingType
Тип ценообразования
| Значение | Описание |
|---|---|
| Free | |
| FreeTrial | |
| Byol | |
| Payg | |
| Ri |
ProductSummary
Возвращает подмножество атрибутов Product
| Имя | Тип | Описание |
|---|---|---|
| applicableProducts |
string[] |
Категории продуктов, к которому относится предложение |
| attributes |
Набор атрибутов продуктов (зависит от типа продукта), где каждый атрибут представлен парой ключей (имя атрибута) и значением(значением атрибута) |
|
| azureBenefit |
Право на получение преимущества обязательств по использованию Azure (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Возможные значения:
|
|
| badges |
Badge[] |
Доступны следующие значки продуктов: preferredSolution, powerBICertified, AdditionalPurchaseRequirement |
| categoryIds |
string[] |
Массив категорий продуктов, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Например, "Производительность" |
| cspLegalTermsUri |
string |
Юридические условия продукта для CSP |
| description |
string |
Текст описания продукта |
| displayName |
string |
Отображаемое имя продукта |
| hasMarketplaceFootprint |
boolean |
Указание того, имеет ли продукт представление в Marketplace |
| hasRIPlans |
boolean |
Указание наличия планов продукта с резервированиями |
| industryIds |
string[] |
Список идентификаторов отрасли, к которому принадлежит элемент |
| lastModifiedDateTime |
string (date-time) |
Дата последнего обновления продукта |
| linkedAddInsTypes |
object |
Связанные типы надстроек |
| locations |
string[] |
Список расположений, доступных на номерах SKU |
| longSummary |
string |
Сводка по продукту |
| operatingSystems |
string[] |
Сведения об операционной системе для этого продукта |
| plans |
Список планов, доступных для этого продукта |
|
| popularity |
number (double) |
Популярность продукта |
| pricingTypes |
Список типов цен, для которых назначено это предложение. Возможные значения:
|
|
| privacyPolicyUri |
string |
Политика конфиденциальности продукта |
| productFamily |
string |
Семейство продуктов |
| productId |
string |
Уникальный идентификатор продукта |
| productSubType |
string |
Подтип продукта |
| productType |
Метод доставки или модель развертывания. Возможные значения:
|
|
| publisherDisplayName |
string |
Отображаемое имя издателя |
| publisherId |
string |
Идентификатор издателя |
| publisherType |
Значение, указывающее, является ли это продуктом Майкрософт или сторонним продуктом. Возможные значения:
|
|
| publishingStage |
Этап публикации продукта. Возможные значения:
|
|
| ratingAverage |
number (double) |
Средняя оценка предложения |
| ratingBuckets |
Сегменты оценки, выше1, выше2, выше3, выше4 |
|
| ratingCount |
integer (int32) |
Общее количество оценок для предложения |
| service |
string |
Имя службы продукта, например "Виртуальные машины" |
| serviceFamily |
string |
Семейство служб продукта, например "Вычисление" |
| smallIconUri |
string |
Универсальный код ресурса (URI) для значка небольшого продукта |
| startingPrice |
Розничная цена самого дешевого плана продукта |
|
| summary |
string |
Сводка по продукту |
| supportedProducts |
string[] |
Сопоставляется со списком совместимых продуктов, которые предоставляет издатель |
| uniqueProductId |
string |
Уникальный идентификатор продукта |
ProductType
Метод доставки или модель развертывания. Возможные значения:
-
SaaS. Продукт — это программное решение, приобретенное на основе оплаты по мере использования у поставщика облачных служб. -
VirtualMachine. Продукт — это экземпляры службы изображений с ценами на основе использования -
AzureApplication. Продукты, опубликованные как шаблоны решений (ST) или AMA, которые развертывают ресурсы Azure в клиенте. -
DynamicsCE— все продукты Dynamics, кроме DynamicsBC и DynamicsOps -
DynamicsBC— Dynamics 365 business Central -
Container— продукт поставляется как контейнер -
DynamicsOps— приложения Dynamics 365 Operations Apps -
None. Тип продукта, возвращенный для служб Azure, расширений контейнеров и расширений виртуальных машин -
IotEdgeModules— ресурс поставляется в виде модуля IoT Edge -
ContainerApps— ресурс поставляется в качестве приложения-контейнера -
ConsultingServicesконсультационные услуги (доступны только в Azure Marketplace в качестве предложений) -
ManagedServices— продукт поставляется как управляемая служба -
PowerBI— продукты Power BI -
CosellOnly— продукты, доступные только в области Co-Sell программы -
PowerBIVisuals— продукты Visuals Power BI -
Office365— продукты Office 365 -
DevService— служба разработки -
AADApps— приложения Azure Active Directory -
VisualStudioExtension— расширения Visual Studio -
SolutionTemplate— тип плана шаблона решения (применимо только к приложениям Azure) -
ManagedApplication— тип плана управляемого приложения (применимо только к приложениям Azure) -
MicrosoftProduct— 1-й стороннего продукта Azure
| Значение | Описание |
|---|---|
| None | |
| DevService | |
| ManagedApplication | |
| VirtualMachine | |
| AzureApplication | |
| Container | |
| SaaS | |
| SolutionTemplate | |
| IotEdgeModules | |
| ManagedServices | |
| ContainerApps | |
| VisualStudioExtension | |
| DynamicsOps | |
| DynamicsCE | |
| DynamicsBC | |
| PowerBI | |
| ConsultingServices | |
| CosellOnly | |
| CoreVirtualMachine | |
| PowerBIVisuals | |
| Office365 | |
| AADApps | |
| AzureServices | |
| AppService | |
| LogAnalytics | |
| MicrosoftProduct |
PublisherType
Значение, указывающее, является ли это продуктом Майкрософт или сторонним продуктом. Возможные значения:
-
Microsoft— продукт опубликован корпорацией Майкрософт (1-й стороннего продукта) -
Third Party— продукт опубликован сторонним поставщиком
| Значение | Описание |
|---|---|
| Microsoft | |
| ThirdParty |
PublishingStage
Этап публикации продукта. Возможные значения:
-
Preview. Продукт доступен для ограниченной аудитории -
Public. Продукт доступен в Marketplace
| Значение | Описание |
|---|---|
| Preview | |
| Public |
RatingBucket
Сегмент оценки
| Значение | Описание |
|---|---|
| AboveOne | |
| AboveTwo | |
| AboveThree | |
| AboveFour |
Sku
Артикул
| Имя | Тип | Описание |
|---|---|---|
| generation |
string |
Создание |
| identity |
string |
Удостоверение |
| name |
string |
Имя |
StartingPrice
Розничная цена самого дешевого плана продукта
| Имя | Тип | Описание |
|---|---|---|
| currency |
string |
Валюта для цены |
| market |
string |
Рынок, для которого вычисляется начальная цена |
| meterUnits |
string |
Единицы модели ценообразования счетчиков |
| minMeterPrice |
number |
Начальная (минимальная) цена на метры |
| minTermPrice |
number |
Начальная (минимальная) цена на условия |
| termUnits |
string |
Единицы модели ценообразования |
VmArchitectureType
Тип архитектуры виртуальной машины. Применимо только к продуктам виртуальной машины. Возможные значения:
-
Arm64. Архитектура образа виртуальной машины плана — Arm64 -
X64Gen1— архитектура образа виртуальной машины плана — X64-го поколения1 -
X64Gen2— архитектура образа виртуальной машины плана — X64-го поколения2
| Значение | Описание |
|---|---|
| X64Gen1 | |
| X64Gen2 | |
| Arm64 |
VmSecurityType
Тип безопасности виртуальной машины. Применимо только к продуктам виртуальной машины. Возможные значения:
- Стандартный — базовый уровень безопасности для виртуальной машины
- Доверенный — защищает от постоянных и расширенных атак на виртуальных машинах 2-го поколения с настраиваемыми функциями, такими как загрузка безопасности и виртуальный доверенный платформенный модуль (vTPM)
- Конфиденциально. На вершине доверенного запуска конфиденциальные виртуальные машины обеспечивают более высокую конфиденциальность и целостность, гарантированную с помощью доверенной среды выполнения на основе оборудования.
| Значение | Описание |
|---|---|
| None | |
| Trusted | |
| Confidential |