Microsoft.Billing (stable:2025-05-01)

2025/11/17 • 4 updated methods

ProductGet_GetByBillingProfile (updated)
Description :  Gets a single product by billing profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProductGet_GetByBillingProfile",
  "$responses": {
    "200": {
      "$properties": {
        "plans": {
          "$properties": {
            "availabilities": {
              "$properties": [
                {
                  "#name": "pricingAudience",
                  "Description": {
                    "new": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution",
                    "old": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `PartnerCommercial` - Available through Cloud Solution Provider partner channel for reseller distribution"
                  }
                }
              ]
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Marketplace/products/{productId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: The ID of the target billing account. ,
Required: True ,
}
string ,
billingProfileId:
{
Description: The ID of the target billing account. ,
Required: True ,
}
string ,
productId:
{
Description: The ID of the product ,
Required: True ,
}
string ,
includeStopSoldPlans:
{
Description: Indicates whether to include plans that are no longer available for purchase in the response. By default, includeStopSoldPlans is set to FALSE. ,
Required: False ,
}
boolean ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. Default is "en" ,
Required: False ,
}
string ,
includeHiddenPlans:
{
Description: Indicates whether to include hidden plans in the response. By default, includeHiddenPlans is set to FALSE. ,
Required: False ,
}
boolean ,
includeServiceInstructionTemplates:
{
Description: Indicates whether to include the product's service instruction templates in the response. By default, includeServiceInstructionTemplates is set to FALSE. ,
Required: False ,
}
boolean ,
planId:
{
Description: Optional to pass the plan id to filter to a specific plan within the product. If not specified, the response will include all plans of the product. ,
Required: False ,
}
string ,
skuId:
{
Description: Optional to pass the sku id to filter to a specific sku within the product. If not specified, the response will include all skus of the product. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
displayName:
{
Description: Product display name ,
Required: False ,
}
string ,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: False ,
}
number ,
categoryIds:
{
Description: Array of product categories ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers. - `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits - `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs ,
Required: False ,
}
string ,
badges:
{
Description: Displays certification and qualification badges earned by the product for marketplace visibility. - `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria - `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform - `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality ,
Required: False ,
}
[
string ,
]
,
publisherType:
{
Description: Identifies the publisher relationship to Microsoft for support and partnership classification. - `Microsoft` - First-party Microsoft product with direct Microsoft support and development - `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance ,
Required: False ,
}
string ,
publishingStage:
{
Description: Indicates the product availability status and customer access level within Azure Marketplace. - `Preview` - Limited availability to selected customers for testing and early access evaluation - `Public` - General availability to all Azure Marketplace customers for production deployment ,
Required: False ,
}
string ,
uniqueProductId:
{
Description: Unique product identifier ,
Required: True ,
}
string ,
productType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. - `None` - Unspecified product type, typically used for products without a defined deployment model - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
productSubType:
{
Description: Product sub type ,
Required: False ,
}
string ,
productFamily:
{
Description: Product Family ,
Required: False ,
}
string ,
operatingSystems:
{
Description: Operating system info for this product ,
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
longSummary:
{
Description: Product long summary ,
Required: False ,
}
string ,
summary:
{
Description: Product summary ,
Required: False ,
}
string ,
smallIconUri:
{
Description: URI to the small product icon ,
Required: False ,
}
string ,
description:
{
Description: The product description text ,
Required: False ,
}
string ,
cspLegalTermsUri:
{
Description: The legal terms of the product for the CSP ,
Required: False ,
}
string ,
privacyPolicyUri:
{
Description: The privacy policy of the product ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: Categorizes products by customer rating thresholds for marketplace filtering and discovery. - `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews - `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews - `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews - `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews ,
Required: False ,
}
[
string ,
]
,
ratingAverage:
{
Description: Average rating for the offer ,
Format: double ,
Required: False ,
}
number ,
ratingCount:
{
Description: Total number of ratings for the offer ,
Format: int32 ,
Required: False ,
}
integer ,
supportedProducts:
{
Description: Maps to the list of compatible products ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
lastModifiedDateTime:
{
Description: Latest update date of the product ,
Required: False ,
}
string ,
locations:
{
Description: List of locations which are available on the SKUs ,
Required: False ,
}
[
string ,
]
,
serviceFamily:
{
Description: The service family of the product, such as 'Compute' ,
Required: False ,
}
string ,
service:
{
Description: The service name of the product, such as 'Virtual Machines' ,
Required: False ,
}
string ,
productId:
{
Description: The unique id of the product ,
Required: False ,
}
string ,
hasRiPlans:
{
Description: Indication whether the product has plans with reservations ,
Required: False ,
}
boolean ,
hasMarketplaceFootprint:
{
Description: Indication if product has a representation in the marketplace ,
Required: False ,
}
boolean ,
attributes:
{
Description: Set of products attributes ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: List of product videos ,
Required: False ,
}
[
{
caption:
{
Description: Video Caption ,
Required: False ,
}
string ,
uri:
{
Description: Video uri ,
Required: False ,
}
string ,
videoPurpose:
{
Description: Video purpose ,
Required: False ,
}
string ,
previewImage:
{
Description: Preview image ,
Required: False ,
}
{
caption:
{
Description: Image caption ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
imagePurpose:
{
Description: Purpose of the image ,
Required: False ,
}
string ,
}
,
}
,
]
,
images:
{
Description: List of Images ,
Required: False ,
}
[
{
context:
{
Description: Context of the image group ,
Required: False ,
}
string ,
items:
{
Description: List of images ,
Required: False ,
}
[
{
id:
{
Description: Image id ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
type:
{
Description: Image type ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
linkedAddIns:
{
Description: List of linked add ins provided for the item ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: List of Links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The product language ,
Required: False ,
}
string ,
hasStandardContractAmendments:
{
Description: A value indicating whether standard contract amendments are present ,
Required: False ,
}
boolean ,
offerId:
{
Description: The offer id ,
Required: False ,
}
string ,
standardContractAmendmentsRevisionId:
{
Description: Standard contract amendments for the product ,
Required: False ,
}
string ,
universalAmendmentUrl:
{
Description: The universal amendment link for an enterprise contract ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indicates if a product is private ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: Indicates if a product is no longer available for sale ,
Required: True ,
}
boolean ,
legalTermsUri:
{
Description: Legal terms URI ,
Required: False ,
}
string ,
legalTermsType:
{
Description: Identifies the legal agreement framework governing product licensing and usage terms. - `None` - Standard marketplace terms apply without additional legal agreement requirements - `EA` - Microsoft Enterprise Agreement terms for volume licensing and enterprise customer deployments ,
Required: False ,
}
string ,
supportUri:
{
Description: Support uri of the product ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: User interface definition uri ,
Required: False ,
}
string ,
screenshotUris:
{
Description: List of screenshot image URIs ,
Required: False ,
}
[
string ,
]
,
mediumIconUri:
{
Description: URI to the medium product icon ,
Required: False ,
}
string ,
largeIconUri:
{
Description: URI to the large product icon ,
Required: False ,
}
string ,
wideIconUri:
{
Description: URI to the wide product icon ,
Required: False ,
}
string ,
pricingDetailsUri:
{
Description: Pricing details uri of the product ,
Required: False ,
}
string ,
isReseller:
{
Description: A value indicating whether microsoft is acting as a reseller ,
Required: False ,
}
boolean ,
productOwnershipSellingMotion:
{
Description: Product ownership selling motion ,
Required: False ,
}
string ,
disableSendEmailOnPurchase:
{
Description: Indication to disable sending email on purchase ,
Required: False ,
}
boolean ,
isCoreVm:
{
Description: Indicates if VM was originally a Core Virtual Machine ,
Required: False ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
marketingMaterial:
{
Description: Includes links to the learning and marketing materials as configured by the publisher ,
Required: False ,
}
{
path:
{
Description: Path to the marketing site ,
Required: False ,
}
string ,
learnUri:
{
Description: Path to the learn site ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: List of artifacts ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
plans:
{
Description: Full set of plan/SKU attributes ,
Required: False ,
}
[
{
planId:
{
Description: Plan identifier ,
Required: False ,
}
string ,
uniquePlanId:
{
Description: Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan / sku ,
Required: False ,
}
string ,
vmArchitectureType:
{
Description: Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types. - `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support - `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support - `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads ,
Required: False ,
}
string ,
cspState:
{
Description: Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program. - `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers - `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels - `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment ,
Required: False ,
}
string ,
metadata:
{
Description: Expanded plan/SKU metadata. ,
Required: False ,
}
{
generation:
{
Description: The VM image generation (applicable to Virtual Machine products only) ,
Required: False ,
}
string ,
altStackReference:
{
Description: Pointing to a planId which holds the alternative stack reference ,
Required: False ,
}
string ,
}
,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
altArchitectureReference:
{
Description: The alternative architecture reference ,
Required: False ,
}
string ,
categoryIds:
{
Description: Plan CategoryIds ,
Required: False ,
}
[
string ,
]
,
hasProtectedArtifacts:
{
Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,
Required: False ,
}
boolean ,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
vmSecuritytypes:
{
Description: Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types. - `None` - Standard virtual machine security without additional protection features - `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities - `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: The plan summary text ,
Required: False ,
}
string ,
description:
{
Description: Plan / sku description ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU id ,
Required: False ,
}
string ,
planType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are: - `None` - Unspecified product type, typically used for products without a defined deployment model - `DevService` - Development-focused services and tools for software creation workflows - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
displayRank:
{
Description: The order the plan is displayed in the 'Plans' table ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indication that the plan is accessible to restricted audience only ,
Required: False ,
}
boolean ,
hasRi:
{
Description: Indication whether the SKU supports reservations ,
Required: False ,
}
boolean ,
id:
{
Description: The id ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities for this plan ,
Required: False ,
}
[
{
id:
{
Description: The document id ,
Required: False ,
}
string ,
actions:
{
Description: List of allowed actions ,
Required: False ,
}
[
string ,
]
,
meter:
{
Description: Applicable billing meter information ,
Required: False ,
}
{
meterId:
{
Description: Meter id ,
Required: False ,
}
string ,
partNumber:
{
Description: Compute part number ,
Required: False ,
}
string ,
consumptionResourceId:
{
Description: Consumption resource id ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
type:
{
Description: Type of this meter ,
Required: False ,
}
string ,
includedQuantityProperties:
{
Description: Included quantity properties ,
Required: False ,
}
[
{
termId:
{
Description: Term id ,
Required: False ,
}
string ,
quantity:
{
Description: Included quantity ,
Required: False ,
}
string ,
}
,
]
,
}
,
pricingAudience:
{
Description: Specifies the distribution channel and customer segment for product pricing and availability. Possible values: - `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution ,
Required: True ,
}
string ,
terms:
{
Description: List of applicable terms ,
Required: False ,
}
[
{
termDescriptionParameters:
{
Description: Term description parameters ,
Required: False ,
}
[
{
parameter:
{
Description: Description parameter ,
Required: False ,
}
string ,
value:
{
Description: Parameter's value ,
Required: False ,
}
string ,
}
,
]
,
termId:
{
Description: Term id ,
Required: False ,
}
string ,
termUnit:
{
Description: Term unit ,
Required: False ,
}
string ,
prorationPolicy:
{
Description: Defines the rules for calculating prorated charges or refunds for a subscription. ,
Required: False ,
}
{
minimumProratedUnits:
{
Description: Minimum prorated units ,
Required: False ,
}
string ,
}
,
termDescription:
{
Description: Term description ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
renewTermId:
{
Description: Renew term id ,
Required: False ,
}
string ,
renewTermUnits:
{
Description: Renew term units ,
Required: False ,
}
string ,
billingPlan:
{
Description: Billing Plan ,
Required: False ,
}
{
billingPeriod:
{
Description: Billing period ,
Required: False ,
}
string ,
title:
{
Description: Title of the billing plan ,
Required: False ,
}
string ,
description:
{
Description: Description of the billing plan ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
renewToTermBillingPlan:
{
Description: Renew Billing Plan ,
Required: False ,
}
string ,
isAutorenewable:
{
Description: Indicates if autorenew is enabled ,
Required: False ,
}
boolean ,
}
,
]
,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
consumptionUnitType:
{
Description: Consumption unit type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
uiDefinitionUri:
{
Description: What blade to open when someone wants to create a marketplace item ,
Required: False ,
}
string ,
artifacts:
{
Description: Files related to the marketplace item ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
version:
{
Description: Version of the marketplace item ,
Required: False ,
}
string ,
isHidden:
{
Description: A value indicating whether the plan is hidden ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether plan has been stopped from selling ,
Required: True ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
minQuantity:
{
Description: Min quantity ,
Format: int32 ,
Required: False ,
}
integer ,
maxQuantity:
{
Description: Max quantity ,
Format: int32 ,
Required: False ,
}
integer ,
isQuantifiable:
{
Description: A value indicating whether the plan is quantifiable ,
Required: True ,
}
boolean ,
billingComponents:
{
Description: Billing components ,
Required: False ,
}
[
{
billingTag:
{
Description: Billing Tag ,
Required: False ,
}
string ,
}
,
]
,
purchaseDurationDiscounts:
{
Description: List of purchase duration discounts ,
Required: False ,
}
[
{
duration:
{
Description: The duration ,
Required: False ,
}
string ,
discountPercentage:
{
Description: The discount percentage ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
isHiddenPrivateOffer:
{
Description: A value indicating whether the plan is used as hidden private offer requiring a quote ,
Required: False ,
}
boolean ,
certifications:
{
Description: List of certifications ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
customerInstruction:
{
Description: Plan's customer instruction for purchasing ,
Required: False ,
}
string ,
planLabels:
{
Description: Plan labels ,
Required: False ,
}
[
string ,
]
,
skuType:
{
Description: SKU type ,
Required: False ,
}
string ,
skuTitle:
{
Description: Sku title localized ,
Required: False ,
}
string ,
location:
{
Description: SKU location ,
Required: False ,
}
string ,
armRegionName:
{
Description: The Arm region name ,
Required: False ,
}
string ,
cloud:
{
Description: Applicable cloud, such as 'Global' ,
Required: False ,
}
string ,
locationType:
{
Description: The location type, such as 'Region' ,
Required: False ,
}
string ,
region:
{
Description: The region ,
Required: False ,
}
string ,
skuGroupId:
{
Description: The sku group id ,
Required: False ,
}
string ,
zone:
{
Description: The zone, such as 'Zone 1' ,
Required: False ,
}
string ,
feature:
{
Description: The feature, such as 'Spot' ,
Required: False ,
}
string ,
serviceType:
{
Description: The service type ,
Required: False ,
}
string ,
skuAttributes:
{
Description: Set of SKU attributes (varies per sku type), where each attribute is represented by a pair of key (attribute name) and value(attribute value) ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
skuProperties:
{
Description: The sku properties ,
Required: False ,
}
{
category:
{
Description: The sku category ,
Required: False ,
}
string ,
dataDiskType:
{
Description: The data disk type, such as 'Ssd' ,
Required: False ,
}
string ,
diskType:
{
Description: The disk type, such as 'Ssd' ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The number of cores ,
Required: False ,
}
string ,
ram:
{
Description: The RAM ,
Required: False ,
}
string ,
vCpu:
{
Description: The number of virtual CPUs ,
Required: False ,
}
string ,
armSkuName:
{
Description: The ARM SKU name ,
Required: False ,
}
string ,
accessTier:
{
Description: The access tier, such as 'Standard' ,
Required: False ,
}
string ,
}
,
offeringProperties:
{
Description: SKU price related properties. ,
Required: False ,
}
[
{
productCode:
{
Description: The product code (UPN) ,
Required: False ,
}
string ,
termId:
{
Description: The term id ,
Required: False ,
}
string ,
meterType:
{
Description: The meter type ,
Required: False ,
}
string ,
billingMeterId:
{
Description: The billing meter id ,
Required: False ,
}
string ,
offeringId:
{
Description: The offering id ,
Required: False ,
}
string ,
type:
{
Description: Entitlement, Consumption or Reservation ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details object ,
Required: True ,
}
{
code:
{
Description: The HTTP error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
}
,
}
ProductGet_GetByBillingAccount (updated)
Description :  Gets a single product by billing account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProductGet_GetByBillingAccount",
  "$responses": {
    "200": {
      "$properties": {
        "plans": {
          "$properties": {
            "availabilities": {
              "$properties": [
                {
                  "#name": "pricingAudience",
                  "Description": {
                    "new": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution",
                    "old": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `PartnerCommercial` - Available through Cloud Solution Provider partner channel for reseller distribution"
                  }
                }
              ]
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Marketplace/products/{productId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
billingAccountId:
{
Description: The ID of the target billing account. ,
Required: True ,
}
string ,
productId:
{
Description: The ID of the product ,
Required: True ,
}
string ,
includeStopSoldPlans:
{
Description: Indicates whether to include plans that are no longer available for purchase in the response. By default, includeStopSoldPlans is set to FALSE. ,
Required: False ,
}
boolean ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. Default is "en" ,
Required: False ,
}
string ,
includeHiddenPlans:
{
Description: Indicates whether to include hidden plans in the response. By default, includeHiddenPlans is set to FALSE. ,
Required: False ,
}
boolean ,
includeServiceInstructionTemplates:
{
Description: Indicates whether to include the product's service instruction templates in the response. By default, includeServiceInstructionTemplates is set to FALSE. ,
Required: False ,
}
boolean ,
planId:
{
Description: Optional to pass the plan id to filter to a specific plan within the product. If not specified, the response will include all plans of the product. ,
Required: False ,
}
string ,
skuId:
{
Description: Optional to pass the sku id to filter to a specific sku within the product. If not specified, the response will include all skus of the product. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
displayName:
{
Description: Product display name ,
Required: False ,
}
string ,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: False ,
}
number ,
categoryIds:
{
Description: Array of product categories ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers. - `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits - `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs ,
Required: False ,
}
string ,
badges:
{
Description: Displays certification and qualification badges earned by the product for marketplace visibility. - `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria - `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform - `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality ,
Required: False ,
}
[
string ,
]
,
publisherType:
{
Description: Identifies the publisher relationship to Microsoft for support and partnership classification. - `Microsoft` - First-party Microsoft product with direct Microsoft support and development - `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance ,
Required: False ,
}
string ,
publishingStage:
{
Description: Indicates the product availability status and customer access level within Azure Marketplace. - `Preview` - Limited availability to selected customers for testing and early access evaluation - `Public` - General availability to all Azure Marketplace customers for production deployment ,
Required: False ,
}
string ,
uniqueProductId:
{
Description: Unique product identifier ,
Required: True ,
}
string ,
productType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. - `None` - Unspecified product type, typically used for products without a defined deployment model - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
productSubType:
{
Description: Product sub type ,
Required: False ,
}
string ,
productFamily:
{
Description: Product Family ,
Required: False ,
}
string ,
operatingSystems:
{
Description: Operating system info for this product ,
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
longSummary:
{
Description: Product long summary ,
Required: False ,
}
string ,
summary:
{
Description: Product summary ,
Required: False ,
}
string ,
smallIconUri:
{
Description: URI to the small product icon ,
Required: False ,
}
string ,
description:
{
Description: The product description text ,
Required: False ,
}
string ,
cspLegalTermsUri:
{
Description: The legal terms of the product for the CSP ,
Required: False ,
}
string ,
privacyPolicyUri:
{
Description: The privacy policy of the product ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: Categorizes products by customer rating thresholds for marketplace filtering and discovery. - `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews - `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews - `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews - `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews ,
Required: False ,
}
[
string ,
]
,
ratingAverage:
{
Description: Average rating for the offer ,
Format: double ,
Required: False ,
}
number ,
ratingCount:
{
Description: Total number of ratings for the offer ,
Format: int32 ,
Required: False ,
}
integer ,
supportedProducts:
{
Description: Maps to the list of compatible products ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
lastModifiedDateTime:
{
Description: Latest update date of the product ,
Required: False ,
}
string ,
locations:
{
Description: List of locations which are available on the SKUs ,
Required: False ,
}
[
string ,
]
,
serviceFamily:
{
Description: The service family of the product, such as 'Compute' ,
Required: False ,
}
string ,
service:
{
Description: The service name of the product, such as 'Virtual Machines' ,
Required: False ,
}
string ,
productId:
{
Description: The unique id of the product ,
Required: False ,
}
string ,
hasRiPlans:
{
Description: Indication whether the product has plans with reservations ,
Required: False ,
}
boolean ,
hasMarketplaceFootprint:
{
Description: Indication if product has a representation in the marketplace ,
Required: False ,
}
boolean ,
attributes:
{
Description: Set of products attributes ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: List of product videos ,
Required: False ,
}
[
{
caption:
{
Description: Video Caption ,
Required: False ,
}
string ,
uri:
{
Description: Video uri ,
Required: False ,
}
string ,
videoPurpose:
{
Description: Video purpose ,
Required: False ,
}
string ,
previewImage:
{
Description: Preview image ,
Required: False ,
}
{
caption:
{
Description: Image caption ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
imagePurpose:
{
Description: Purpose of the image ,
Required: False ,
}
string ,
}
,
}
,
]
,
images:
{
Description: List of Images ,
Required: False ,
}
[
{
context:
{
Description: Context of the image group ,
Required: False ,
}
string ,
items:
{
Description: List of images ,
Required: False ,
}
[
{
id:
{
Description: Image id ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
type:
{
Description: Image type ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
linkedAddIns:
{
Description: List of linked add ins provided for the item ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: List of Links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The product language ,
Required: False ,
}
string ,
hasStandardContractAmendments:
{
Description: A value indicating whether standard contract amendments are present ,
Required: False ,
}
boolean ,
offerId:
{
Description: The offer id ,
Required: False ,
}
string ,
standardContractAmendmentsRevisionId:
{
Description: Standard contract amendments for the product ,
Required: False ,
}
string ,
universalAmendmentUrl:
{
Description: The universal amendment link for an enterprise contract ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indicates if a product is private ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: Indicates if a product is no longer available for sale ,
Required: True ,
}
boolean ,
legalTermsUri:
{
Description: Legal terms URI ,
Required: False ,
}
string ,
legalTermsType:
{
Description: Identifies the legal agreement framework governing product licensing and usage terms. - `None` - Standard marketplace terms apply without additional legal agreement requirements - `EA` - Microsoft Enterprise Agreement terms for volume licensing and enterprise customer deployments ,
Required: False ,
}
string ,
supportUri:
{
Description: Support uri of the product ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: User interface definition uri ,
Required: False ,
}
string ,
screenshotUris:
{
Description: List of screenshot image URIs ,
Required: False ,
}
[
string ,
]
,
mediumIconUri:
{
Description: URI to the medium product icon ,
Required: False ,
}
string ,
largeIconUri:
{
Description: URI to the large product icon ,
Required: False ,
}
string ,
wideIconUri:
{
Description: URI to the wide product icon ,
Required: False ,
}
string ,
pricingDetailsUri:
{
Description: Pricing details uri of the product ,
Required: False ,
}
string ,
isReseller:
{
Description: A value indicating whether microsoft is acting as a reseller ,
Required: False ,
}
boolean ,
productOwnershipSellingMotion:
{
Description: Product ownership selling motion ,
Required: False ,
}
string ,
disableSendEmailOnPurchase:
{
Description: Indication to disable sending email on purchase ,
Required: False ,
}
boolean ,
isCoreVm:
{
Description: Indicates if VM was originally a Core Virtual Machine ,
Required: False ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
marketingMaterial:
{
Description: Includes links to the learning and marketing materials as configured by the publisher ,
Required: False ,
}
{
path:
{
Description: Path to the marketing site ,
Required: False ,
}
string ,
learnUri:
{
Description: Path to the learn site ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: List of artifacts ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
plans:
{
Description: Full set of plan/SKU attributes ,
Required: False ,
}
[
{
planId:
{
Description: Plan identifier ,
Required: False ,
}
string ,
uniquePlanId:
{
Description: Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan / sku ,
Required: False ,
}
string ,
vmArchitectureType:
{
Description: Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types. - `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support - `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support - `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads ,
Required: False ,
}
string ,
cspState:
{
Description: Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program. - `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers - `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels - `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment ,
Required: False ,
}
string ,
metadata:
{
Description: Expanded plan/SKU metadata. ,
Required: False ,
}
{
generation:
{
Description: The VM image generation (applicable to Virtual Machine products only) ,
Required: False ,
}
string ,
altStackReference:
{
Description: Pointing to a planId which holds the alternative stack reference ,
Required: False ,
}
string ,
}
,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
altArchitectureReference:
{
Description: The alternative architecture reference ,
Required: False ,
}
string ,
categoryIds:
{
Description: Plan CategoryIds ,
Required: False ,
}
[
string ,
]
,
hasProtectedArtifacts:
{
Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,
Required: False ,
}
boolean ,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
vmSecuritytypes:
{
Description: Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types. - `None` - Standard virtual machine security without additional protection features - `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities - `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: The plan summary text ,
Required: False ,
}
string ,
description:
{
Description: Plan / sku description ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU id ,
Required: False ,
}
string ,
planType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are: - `None` - Unspecified product type, typically used for products without a defined deployment model - `DevService` - Development-focused services and tools for software creation workflows - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
displayRank:
{
Description: The order the plan is displayed in the 'Plans' table ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indication that the plan is accessible to restricted audience only ,
Required: False ,
}
boolean ,
hasRi:
{
Description: Indication whether the SKU supports reservations ,
Required: False ,
}
boolean ,
id:
{
Description: The id ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities for this plan ,
Required: False ,
}
[
{
id:
{
Description: The document id ,
Required: False ,
}
string ,
actions:
{
Description: List of allowed actions ,
Required: False ,
}
[
string ,
]
,
meter:
{
Description: Applicable billing meter information ,
Required: False ,
}
{
meterId:
{
Description: Meter id ,
Required: False ,
}
string ,
partNumber:
{
Description: Compute part number ,
Required: False ,
}
string ,
consumptionResourceId:
{
Description: Consumption resource id ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
type:
{
Description: Type of this meter ,
Required: False ,
}
string ,
includedQuantityProperties:
{
Description: Included quantity properties ,
Required: False ,
}
[
{
termId:
{
Description: Term id ,
Required: False ,
}
string ,
quantity:
{
Description: Included quantity ,
Required: False ,
}
string ,
}
,
]
,
}
,
pricingAudience:
{
Description: Specifies the distribution channel and customer segment for product pricing and availability. Possible values: - `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution ,
Required: True ,
}
string ,
terms:
{
Description: List of applicable terms ,
Required: False ,
}
[
{
termDescriptionParameters:
{
Description: Term description parameters ,
Required: False ,
}
[
{
parameter:
{
Description: Description parameter ,
Required: False ,
}
string ,
value:
{
Description: Parameter's value ,
Required: False ,
}
string ,
}
,
]
,
termId:
{
Description: Term id ,
Required: False ,
}
string ,
termUnit:
{
Description: Term unit ,
Required: False ,
}
string ,
prorationPolicy:
{
Description: Defines the rules for calculating prorated charges or refunds for a subscription. ,
Required: False ,
}
{
minimumProratedUnits:
{
Description: Minimum prorated units ,
Required: False ,
}
string ,
}
,
termDescription:
{
Description: Term description ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
renewTermId:
{
Description: Renew term id ,
Required: False ,
}
string ,
renewTermUnits:
{
Description: Renew term units ,
Required: False ,
}
string ,
billingPlan:
{
Description: Billing Plan ,
Required: False ,
}
{
billingPeriod:
{
Description: Billing period ,
Required: False ,
}
string ,
title:
{
Description: Title of the billing plan ,
Required: False ,
}
string ,
description:
{
Description: Description of the billing plan ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
renewToTermBillingPlan:
{
Description: Renew Billing Plan ,
Required: False ,
}
string ,
isAutorenewable:
{
Description: Indicates if autorenew is enabled ,
Required: False ,
}
boolean ,
}
,
]
,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
consumptionUnitType:
{
Description: Consumption unit type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
uiDefinitionUri:
{
Description: What blade to open when someone wants to create a marketplace item ,
Required: False ,
}
string ,
artifacts:
{
Description: Files related to the marketplace item ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
version:
{
Description: Version of the marketplace item ,
Required: False ,
}
string ,
isHidden:
{
Description: A value indicating whether the plan is hidden ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether plan has been stopped from selling ,
Required: True ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
minQuantity:
{
Description: Min quantity ,
Format: int32 ,
Required: False ,
}
integer ,
maxQuantity:
{
Description: Max quantity ,
Format: int32 ,
Required: False ,
}
integer ,
isQuantifiable:
{
Description: A value indicating whether the plan is quantifiable ,
Required: True ,
}
boolean ,
billingComponents:
{
Description: Billing components ,
Required: False ,
}
[
{
billingTag:
{
Description: Billing Tag ,
Required: False ,
}
string ,
}
,
]
,
purchaseDurationDiscounts:
{
Description: List of purchase duration discounts ,
Required: False ,
}
[
{
duration:
{
Description: The duration ,
Required: False ,
}
string ,
discountPercentage:
{
Description: The discount percentage ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
isHiddenPrivateOffer:
{
Description: A value indicating whether the plan is used as hidden private offer requiring a quote ,
Required: False ,
}
boolean ,
certifications:
{
Description: List of certifications ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
customerInstruction:
{
Description: Plan's customer instruction for purchasing ,
Required: False ,
}
string ,
planLabels:
{
Description: Plan labels ,
Required: False ,
}
[
string ,
]
,
skuType:
{
Description: SKU type ,
Required: False ,
}
string ,
skuTitle:
{
Description: Sku title localized ,
Required: False ,
}
string ,
location:
{
Description: SKU location ,
Required: False ,
}
string ,
armRegionName:
{
Description: The Arm region name ,
Required: False ,
}
string ,
cloud:
{
Description: Applicable cloud, such as 'Global' ,
Required: False ,
}
string ,
locationType:
{
Description: The location type, such as 'Region' ,
Required: False ,
}
string ,
region:
{
Description: The region ,
Required: False ,
}
string ,
skuGroupId:
{
Description: The sku group id ,
Required: False ,
}
string ,
zone:
{
Description: The zone, such as 'Zone 1' ,
Required: False ,
}
string ,
feature:
{
Description: The feature, such as 'Spot' ,
Required: False ,
}
string ,
serviceType:
{
Description: The service type ,
Required: False ,
}
string ,
skuAttributes:
{
Description: Set of SKU attributes (varies per sku type), where each attribute is represented by a pair of key (attribute name) and value(attribute value) ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
skuProperties:
{
Description: The sku properties ,
Required: False ,
}
{
category:
{
Description: The sku category ,
Required: False ,
}
string ,
dataDiskType:
{
Description: The data disk type, such as 'Ssd' ,
Required: False ,
}
string ,
diskType:
{
Description: The disk type, such as 'Ssd' ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The number of cores ,
Required: False ,
}
string ,
ram:
{
Description: The RAM ,
Required: False ,
}
string ,
vCpu:
{
Description: The number of virtual CPUs ,
Required: False ,
}
string ,
armSkuName:
{
Description: The ARM SKU name ,
Required: False ,
}
string ,
accessTier:
{
Description: The access tier, such as 'Standard' ,
Required: False ,
}
string ,
}
,
offeringProperties:
{
Description: SKU price related properties. ,
Required: False ,
}
[
{
productCode:
{
Description: The product code (UPN) ,
Required: False ,
}
string ,
termId:
{
Description: The term id ,
Required: False ,
}
string ,
meterType:
{
Description: The meter type ,
Required: False ,
}
string ,
billingMeterId:
{
Description: The billing meter id ,
Required: False ,
}
string ,
offeringId:
{
Description: The offering id ,
Required: False ,
}
string ,
type:
{
Description: Entitlement, Consumption or Reservation ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details object ,
Required: True ,
}
{
code:
{
Description: The HTTP error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
}
,
}
ProductGet_GetByTenant (updated)
Description :  Gets a single product by tenant.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProductGet_GetByTenant",
  "$parameters": [
    {
      "#name": "pricingAudience",
      "Description": {
        "new": "Direct-Commercial or Partner-Commercial. This value is used to determine the pricing audience for the product. If not specified, the default value is Direct-Commercial.",
        "old": "Direct-Commercial or Partner-Commercial, Direct-Commercial is the default. This value is used to determine the pricing audience for the product. If not specified, the default value is DirectCommercial."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "plans": {
          "$properties": {
            "availabilities": {
              "$properties": [
                {
                  "#name": "pricingAudience",
                  "Description": {
                    "new": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution",
                    "old": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `PartnerCommercial` - Available through Cloud Solution Provider partner channel for reseller distribution"
                  }
                }
              ]
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Marketplace/products/{productId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
productId:
{
Description: The ID of the product ,
Required: True ,
}
string ,
market:
{
Description: Product market value that will be used to fetch the product and affect the returning result.Possible values can be found at https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Example: 'US' ,
Required: True ,
}
string ,
includeStopSoldPlans:
{
Description: Indicates whether to include plans that are no longer available for purchase in the response. By default, includeStopSoldPlans is set to FALSE. ,
Required: False ,
}
boolean ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. Default is "en" ,
Required: False ,
}
string ,
pricingAudience:
{
Description: Direct-Commercial or Partner-Commercial. This value is used to determine the pricing audience for the product. If not specified, the default value is Direct-Commercial. ,
Required: False ,
}
string ,
includeHiddenPlans:
{
Description: Indicates whether to include hidden plans in the response. By default, includeHiddenPlans is set to FALSE. ,
Required: False ,
}
boolean ,
includeServiceInstructionTemplates:
{
Description: Indicates whether to include the product's service instruction templates in the response. By default, includeServiceInstructionTemplates is set to FALSE. ,
Required: False ,
}
boolean ,
planId:
{
Description: Optional to pass the plan id to filter to a specific plan within the product. If not specified, the response will include all plans of the product. ,
Required: False ,
}
string ,
skuId:
{
Description: Optional to pass the sku id to filter to a specific sku within the product. If not specified, the response will include all skus of the product. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
displayName:
{
Description: Product display name ,
Required: False ,
}
string ,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: False ,
}
number ,
categoryIds:
{
Description: Array of product categories ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers. - `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits - `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs ,
Required: False ,
}
string ,
badges:
{
Description: Displays certification and qualification badges earned by the product for marketplace visibility. - `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria - `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform - `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality ,
Required: False ,
}
[
string ,
]
,
publisherType:
{
Description: Identifies the publisher relationship to Microsoft for support and partnership classification. - `Microsoft` - First-party Microsoft product with direct Microsoft support and development - `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance ,
Required: False ,
}
string ,
publishingStage:
{
Description: Indicates the product availability status and customer access level within Azure Marketplace. - `Preview` - Limited availability to selected customers for testing and early access evaluation - `Public` - General availability to all Azure Marketplace customers for production deployment ,
Required: False ,
}
string ,
uniqueProductId:
{
Description: Unique product identifier ,
Required: True ,
}
string ,
productType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. - `None` - Unspecified product type, typically used for products without a defined deployment model - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
productSubType:
{
Description: Product sub type ,
Required: False ,
}
string ,
productFamily:
{
Description: Product Family ,
Required: False ,
}
string ,
operatingSystems:
{
Description: Operating system info for this product ,
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
longSummary:
{
Description: Product long summary ,
Required: False ,
}
string ,
summary:
{
Description: Product summary ,
Required: False ,
}
string ,
smallIconUri:
{
Description: URI to the small product icon ,
Required: False ,
}
string ,
description:
{
Description: The product description text ,
Required: False ,
}
string ,
cspLegalTermsUri:
{
Description: The legal terms of the product for the CSP ,
Required: False ,
}
string ,
privacyPolicyUri:
{
Description: The privacy policy of the product ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: Categorizes products by customer rating thresholds for marketplace filtering and discovery. - `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews - `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews - `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews - `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews ,
Required: False ,
}
[
string ,
]
,
ratingAverage:
{
Description: Average rating for the offer ,
Format: double ,
Required: False ,
}
number ,
ratingCount:
{
Description: Total number of ratings for the offer ,
Format: int32 ,
Required: False ,
}
integer ,
supportedProducts:
{
Description: Maps to the list of compatible products ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
lastModifiedDateTime:
{
Description: Latest update date of the product ,
Required: False ,
}
string ,
locations:
{
Description: List of locations which are available on the SKUs ,
Required: False ,
}
[
string ,
]
,
serviceFamily:
{
Description: The service family of the product, such as 'Compute' ,
Required: False ,
}
string ,
service:
{
Description: The service name of the product, such as 'Virtual Machines' ,
Required: False ,
}
string ,
productId:
{
Description: The unique id of the product ,
Required: False ,
}
string ,
hasRiPlans:
{
Description: Indication whether the product has plans with reservations ,
Required: False ,
}
boolean ,
hasMarketplaceFootprint:
{
Description: Indication if product has a representation in the marketplace ,
Required: False ,
}
boolean ,
attributes:
{
Description: Set of products attributes ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: List of product videos ,
Required: False ,
}
[
{
caption:
{
Description: Video Caption ,
Required: False ,
}
string ,
uri:
{
Description: Video uri ,
Required: False ,
}
string ,
videoPurpose:
{
Description: Video purpose ,
Required: False ,
}
string ,
previewImage:
{
Description: Preview image ,
Required: False ,
}
{
caption:
{
Description: Image caption ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
imagePurpose:
{
Description: Purpose of the image ,
Required: False ,
}
string ,
}
,
}
,
]
,
images:
{
Description: List of Images ,
Required: False ,
}
[
{
context:
{
Description: Context of the image group ,
Required: False ,
}
string ,
items:
{
Description: List of images ,
Required: False ,
}
[
{
id:
{
Description: Image id ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
type:
{
Description: Image type ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
linkedAddIns:
{
Description: List of linked add ins provided for the item ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: List of Links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The product language ,
Required: False ,
}
string ,
hasStandardContractAmendments:
{
Description: A value indicating whether standard contract amendments are present ,
Required: False ,
}
boolean ,
offerId:
{
Description: The offer id ,
Required: False ,
}
string ,
standardContractAmendmentsRevisionId:
{
Description: Standard contract amendments for the product ,
Required: False ,
}
string ,
universalAmendmentUrl:
{
Description: The universal amendment link for an enterprise contract ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indicates if a product is private ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: Indicates if a product is no longer available for sale ,
Required: True ,
}
boolean ,
legalTermsUri:
{
Description: Legal terms URI ,
Required: False ,
}
string ,
legalTermsType:
{
Description: Identifies the legal agreement framework governing product licensing and usage terms. - `None` - Standard marketplace terms apply without additional legal agreement requirements - `EA` - Microsoft Enterprise Agreement terms for volume licensing and enterprise customer deployments ,
Required: False ,
}
string ,
supportUri:
{
Description: Support uri of the product ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: User interface definition uri ,
Required: False ,
}
string ,
screenshotUris:
{
Description: List of screenshot image URIs ,
Required: False ,
}
[
string ,
]
,
mediumIconUri:
{
Description: URI to the medium product icon ,
Required: False ,
}
string ,
largeIconUri:
{
Description: URI to the large product icon ,
Required: False ,
}
string ,
wideIconUri:
{
Description: URI to the wide product icon ,
Required: False ,
}
string ,
pricingDetailsUri:
{
Description: Pricing details uri of the product ,
Required: False ,
}
string ,
isReseller:
{
Description: A value indicating whether microsoft is acting as a reseller ,
Required: False ,
}
boolean ,
productOwnershipSellingMotion:
{
Description: Product ownership selling motion ,
Required: False ,
}
string ,
disableSendEmailOnPurchase:
{
Description: Indication to disable sending email on purchase ,
Required: False ,
}
boolean ,
isCoreVm:
{
Description: Indicates if VM was originally a Core Virtual Machine ,
Required: False ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
marketingMaterial:
{
Description: Includes links to the learning and marketing materials as configured by the publisher ,
Required: False ,
}
{
path:
{
Description: Path to the marketing site ,
Required: False ,
}
string ,
learnUri:
{
Description: Path to the learn site ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: List of artifacts ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
plans:
{
Description: Full set of plan/SKU attributes ,
Required: False ,
}
[
{
planId:
{
Description: Plan identifier ,
Required: False ,
}
string ,
uniquePlanId:
{
Description: Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan / sku ,
Required: False ,
}
string ,
vmArchitectureType:
{
Description: Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types. - `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support - `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support - `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads ,
Required: False ,
}
string ,
cspState:
{
Description: Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program. - `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers - `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels - `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment ,
Required: False ,
}
string ,
metadata:
{
Description: Expanded plan/SKU metadata. ,
Required: False ,
}
{
generation:
{
Description: The VM image generation (applicable to Virtual Machine products only) ,
Required: False ,
}
string ,
altStackReference:
{
Description: Pointing to a planId which holds the alternative stack reference ,
Required: False ,
}
string ,
}
,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
altArchitectureReference:
{
Description: The alternative architecture reference ,
Required: False ,
}
string ,
categoryIds:
{
Description: Plan CategoryIds ,
Required: False ,
}
[
string ,
]
,
hasProtectedArtifacts:
{
Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,
Required: False ,
}
boolean ,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
vmSecuritytypes:
{
Description: Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types. - `None` - Standard virtual machine security without additional protection features - `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities - `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: The plan summary text ,
Required: False ,
}
string ,
description:
{
Description: Plan / sku description ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU id ,
Required: False ,
}
string ,
planType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are: - `None` - Unspecified product type, typically used for products without a defined deployment model - `DevService` - Development-focused services and tools for software creation workflows - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
displayRank:
{
Description: The order the plan is displayed in the 'Plans' table ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indication that the plan is accessible to restricted audience only ,
Required: False ,
}
boolean ,
hasRi:
{
Description: Indication whether the SKU supports reservations ,
Required: False ,
}
boolean ,
id:
{
Description: The id ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities for this plan ,
Required: False ,
}
[
{
id:
{
Description: The document id ,
Required: False ,
}
string ,
actions:
{
Description: List of allowed actions ,
Required: False ,
}
[
string ,
]
,
meter:
{
Description: Applicable billing meter information ,
Required: False ,
}
{
meterId:
{
Description: Meter id ,
Required: False ,
}
string ,
partNumber:
{
Description: Compute part number ,
Required: False ,
}
string ,
consumptionResourceId:
{
Description: Consumption resource id ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
type:
{
Description: Type of this meter ,
Required: False ,
}
string ,
includedQuantityProperties:
{
Description: Included quantity properties ,
Required: False ,
}
[
{
termId:
{
Description: Term id ,
Required: False ,
}
string ,
quantity:
{
Description: Included quantity ,
Required: False ,
}
string ,
}
,
]
,
}
,
pricingAudience:
{
Description: Specifies the distribution channel and customer segment for product pricing and availability. Possible values: - `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution ,
Required: True ,
}
string ,
terms:
{
Description: List of applicable terms ,
Required: False ,
}
[
{
termDescriptionParameters:
{
Description: Term description parameters ,
Required: False ,
}
[
{
parameter:
{
Description: Description parameter ,
Required: False ,
}
string ,
value:
{
Description: Parameter's value ,
Required: False ,
}
string ,
}
,
]
,
termId:
{
Description: Term id ,
Required: False ,
}
string ,
termUnit:
{
Description: Term unit ,
Required: False ,
}
string ,
prorationPolicy:
{
Description: Defines the rules for calculating prorated charges or refunds for a subscription. ,
Required: False ,
}
{
minimumProratedUnits:
{
Description: Minimum prorated units ,
Required: False ,
}
string ,
}
,
termDescription:
{
Description: Term description ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
renewTermId:
{
Description: Renew term id ,
Required: False ,
}
string ,
renewTermUnits:
{
Description: Renew term units ,
Required: False ,
}
string ,
billingPlan:
{
Description: Billing Plan ,
Required: False ,
}
{
billingPeriod:
{
Description: Billing period ,
Required: False ,
}
string ,
title:
{
Description: Title of the billing plan ,
Required: False ,
}
string ,
description:
{
Description: Description of the billing plan ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
renewToTermBillingPlan:
{
Description: Renew Billing Plan ,
Required: False ,
}
string ,
isAutorenewable:
{
Description: Indicates if autorenew is enabled ,
Required: False ,
}
boolean ,
}
,
]
,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
consumptionUnitType:
{
Description: Consumption unit type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
uiDefinitionUri:
{
Description: What blade to open when someone wants to create a marketplace item ,
Required: False ,
}
string ,
artifacts:
{
Description: Files related to the marketplace item ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
version:
{
Description: Version of the marketplace item ,
Required: False ,
}
string ,
isHidden:
{
Description: A value indicating whether the plan is hidden ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether plan has been stopped from selling ,
Required: True ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
minQuantity:
{
Description: Min quantity ,
Format: int32 ,
Required: False ,
}
integer ,
maxQuantity:
{
Description: Max quantity ,
Format: int32 ,
Required: False ,
}
integer ,
isQuantifiable:
{
Description: A value indicating whether the plan is quantifiable ,
Required: True ,
}
boolean ,
billingComponents:
{
Description: Billing components ,
Required: False ,
}
[
{
billingTag:
{
Description: Billing Tag ,
Required: False ,
}
string ,
}
,
]
,
purchaseDurationDiscounts:
{
Description: List of purchase duration discounts ,
Required: False ,
}
[
{
duration:
{
Description: The duration ,
Required: False ,
}
string ,
discountPercentage:
{
Description: The discount percentage ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
isHiddenPrivateOffer:
{
Description: A value indicating whether the plan is used as hidden private offer requiring a quote ,
Required: False ,
}
boolean ,
certifications:
{
Description: List of certifications ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
customerInstruction:
{
Description: Plan's customer instruction for purchasing ,
Required: False ,
}
string ,
planLabels:
{
Description: Plan labels ,
Required: False ,
}
[
string ,
]
,
skuType:
{
Description: SKU type ,
Required: False ,
}
string ,
skuTitle:
{
Description: Sku title localized ,
Required: False ,
}
string ,
location:
{
Description: SKU location ,
Required: False ,
}
string ,
armRegionName:
{
Description: The Arm region name ,
Required: False ,
}
string ,
cloud:
{
Description: Applicable cloud, such as 'Global' ,
Required: False ,
}
string ,
locationType:
{
Description: The location type, such as 'Region' ,
Required: False ,
}
string ,
region:
{
Description: The region ,
Required: False ,
}
string ,
skuGroupId:
{
Description: The sku group id ,
Required: False ,
}
string ,
zone:
{
Description: The zone, such as 'Zone 1' ,
Required: False ,
}
string ,
feature:
{
Description: The feature, such as 'Spot' ,
Required: False ,
}
string ,
serviceType:
{
Description: The service type ,
Required: False ,
}
string ,
skuAttributes:
{
Description: Set of SKU attributes (varies per sku type), where each attribute is represented by a pair of key (attribute name) and value(attribute value) ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
skuProperties:
{
Description: The sku properties ,
Required: False ,
}
{
category:
{
Description: The sku category ,
Required: False ,
}
string ,
dataDiskType:
{
Description: The data disk type, such as 'Ssd' ,
Required: False ,
}
string ,
diskType:
{
Description: The disk type, such as 'Ssd' ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The number of cores ,
Required: False ,
}
string ,
ram:
{
Description: The RAM ,
Required: False ,
}
string ,
vCpu:
{
Description: The number of virtual CPUs ,
Required: False ,
}
string ,
armSkuName:
{
Description: The ARM SKU name ,
Required: False ,
}
string ,
accessTier:
{
Description: The access tier, such as 'Standard' ,
Required: False ,
}
string ,
}
,
offeringProperties:
{
Description: SKU price related properties. ,
Required: False ,
}
[
{
productCode:
{
Description: The product code (UPN) ,
Required: False ,
}
string ,
termId:
{
Description: The term id ,
Required: False ,
}
string ,
meterType:
{
Description: The meter type ,
Required: False ,
}
string ,
billingMeterId:
{
Description: The billing meter id ,
Required: False ,
}
string ,
offeringId:
{
Description: The offering id ,
Required: False ,
}
string ,
type:
{
Description: Entitlement, Consumption or Reservation ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details object ,
Required: True ,
}
{
code:
{
Description: The HTTP error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
}
,
}
ProductGet_GetBySubscription (updated)
Description :  Gets a single product by subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProductGet_GetBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "plans": {
          "$properties": {
            "availabilities": {
              "$properties": [
                {
                  "#name": "pricingAudience",
                  "Description": {
                    "new": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution",
                    "old": "Specifies the distribution channel and customer segment for product pricing and availability. Possible values:\n- `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers\n- `PartnerCommercial` - Available through Cloud Solution Provider partner channel for reseller distribution"
                  }
                }
              ]
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/products/{productId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
productId:
{
Description: The ID of the product ,
Required: True ,
}
string ,
includeStopSoldPlans:
{
Description: Indicates whether to include plans that are no longer available for purchase in the response. By default, includeStopSoldPlans is set to FALSE. ,
Required: False ,
}
boolean ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. Default is "en" ,
Required: False ,
}
string ,
includeHiddenPlans:
{
Description: Indicates whether to include hidden plans in the response. By default, includeHiddenPlans is set to FALSE. ,
Required: False ,
}
boolean ,
includeServiceInstructionTemplates:
{
Description: Indicates whether to include the product's service instruction templates in the response. By default, includeServiceInstructionTemplates is set to FALSE. ,
Required: False ,
}
boolean ,
planId:
{
Description: Optional to pass the plan id to filter to a specific plan within the product. If not specified, the response will include all plans of the product. ,
Required: False ,
}
string ,
skuId:
{
Description: Optional to pass the sku id to filter to a specific sku within the product. If not specified, the response will include all skus of the product. ,
Required: False ,
}
string ,
lookUpOfferInTenantLevel:
{
Description: Indicates whether to use the tenant in context to fetch the product. By default, lookUpOfferInTenantLevel is set to FALSE. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
displayName:
{
Description: Product display name ,
Required: False ,
}
string ,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: False ,
}
number ,
categoryIds:
{
Description: Array of product categories ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers. - `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits - `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs ,
Required: False ,
}
string ,
badges:
{
Description: Displays certification and qualification badges earned by the product for marketplace visibility. - `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria - `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform - `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality ,
Required: False ,
}
[
string ,
]
,
publisherType:
{
Description: Identifies the publisher relationship to Microsoft for support and partnership classification. - `Microsoft` - First-party Microsoft product with direct Microsoft support and development - `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance ,
Required: False ,
}
string ,
publishingStage:
{
Description: Indicates the product availability status and customer access level within Azure Marketplace. - `Preview` - Limited availability to selected customers for testing and early access evaluation - `Public` - General availability to all Azure Marketplace customers for production deployment ,
Required: False ,
}
string ,
uniqueProductId:
{
Description: Unique product identifier ,
Required: True ,
}
string ,
productType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. - `None` - Unspecified product type, typically used for products without a defined deployment model - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
productSubType:
{
Description: Product sub type ,
Required: False ,
}
string ,
productFamily:
{
Description: Product Family ,
Required: False ,
}
string ,
operatingSystems:
{
Description: Operating system info for this product ,
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
longSummary:
{
Description: Product long summary ,
Required: False ,
}
string ,
summary:
{
Description: Product summary ,
Required: False ,
}
string ,
smallIconUri:
{
Description: URI to the small product icon ,
Required: False ,
}
string ,
description:
{
Description: The product description text ,
Required: False ,
}
string ,
cspLegalTermsUri:
{
Description: The legal terms of the product for the CSP ,
Required: False ,
}
string ,
privacyPolicyUri:
{
Description: The privacy policy of the product ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: Categorizes products by customer rating thresholds for marketplace filtering and discovery. - `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews - `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews - `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews - `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews ,
Required: False ,
}
[
string ,
]
,
ratingAverage:
{
Description: Average rating for the offer ,
Format: double ,
Required: False ,
}
number ,
ratingCount:
{
Description: Total number of ratings for the offer ,
Format: int32 ,
Required: False ,
}
integer ,
supportedProducts:
{
Description: Maps to the list of compatible products ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
lastModifiedDateTime:
{
Description: Latest update date of the product ,
Required: False ,
}
string ,
locations:
{
Description: List of locations which are available on the SKUs ,
Required: False ,
}
[
string ,
]
,
serviceFamily:
{
Description: The service family of the product, such as 'Compute' ,
Required: False ,
}
string ,
service:
{
Description: The service name of the product, such as 'Virtual Machines' ,
Required: False ,
}
string ,
productId:
{
Description: The unique id of the product ,
Required: False ,
}
string ,
hasRiPlans:
{
Description: Indication whether the product has plans with reservations ,
Required: False ,
}
boolean ,
hasMarketplaceFootprint:
{
Description: Indication if product has a representation in the marketplace ,
Required: False ,
}
boolean ,
attributes:
{
Description: Set of products attributes ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
videos:
{
Description: List of product videos ,
Required: False ,
}
[
{
caption:
{
Description: Video Caption ,
Required: False ,
}
string ,
uri:
{
Description: Video uri ,
Required: False ,
}
string ,
videoPurpose:
{
Description: Video purpose ,
Required: False ,
}
string ,
previewImage:
{
Description: Preview image ,
Required: False ,
}
{
caption:
{
Description: Image caption ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
imagePurpose:
{
Description: Purpose of the image ,
Required: False ,
}
string ,
}
,
}
,
]
,
images:
{
Description: List of Images ,
Required: False ,
}
[
{
context:
{
Description: Context of the image group ,
Required: False ,
}
string ,
items:
{
Description: List of images ,
Required: False ,
}
[
{
id:
{
Description: Image id ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
type:
{
Description: Image type ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
linkedAddIns:
{
Description: List of linked add ins provided for the item ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: List of Links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
language:
{
Description: The product language ,
Required: False ,
}
string ,
hasStandardContractAmendments:
{
Description: A value indicating whether standard contract amendments are present ,
Required: False ,
}
boolean ,
offerId:
{
Description: The offer id ,
Required: False ,
}
string ,
standardContractAmendmentsRevisionId:
{
Description: Standard contract amendments for the product ,
Required: False ,
}
string ,
universalAmendmentUrl:
{
Description: The universal amendment link for an enterprise contract ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indicates if a product is private ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: Indicates if a product is no longer available for sale ,
Required: True ,
}
boolean ,
legalTermsUri:
{
Description: Legal terms URI ,
Required: False ,
}
string ,
legalTermsType:
{
Description: Identifies the legal agreement framework governing product licensing and usage terms. - `None` - Standard marketplace terms apply without additional legal agreement requirements - `EA` - Microsoft Enterprise Agreement terms for volume licensing and enterprise customer deployments ,
Required: False ,
}
string ,
supportUri:
{
Description: Support uri of the product ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: User interface definition uri ,
Required: False ,
}
string ,
screenshotUris:
{
Description: List of screenshot image URIs ,
Required: False ,
}
[
string ,
]
,
mediumIconUri:
{
Description: URI to the medium product icon ,
Required: False ,
}
string ,
largeIconUri:
{
Description: URI to the large product icon ,
Required: False ,
}
string ,
wideIconUri:
{
Description: URI to the wide product icon ,
Required: False ,
}
string ,
pricingDetailsUri:
{
Description: Pricing details uri of the product ,
Required: False ,
}
string ,
isReseller:
{
Description: A value indicating whether microsoft is acting as a reseller ,
Required: False ,
}
boolean ,
productOwnershipSellingMotion:
{
Description: Product ownership selling motion ,
Required: False ,
}
string ,
disableSendEmailOnPurchase:
{
Description: Indication to disable sending email on purchase ,
Required: False ,
}
boolean ,
isCoreVm:
{
Description: Indicates if VM was originally a Core Virtual Machine ,
Required: False ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
marketingMaterial:
{
Description: Includes links to the learning and marketing materials as configured by the publisher ,
Required: False ,
}
{
path:
{
Description: Path to the marketing site ,
Required: False ,
}
string ,
learnUri:
{
Description: Path to the learn site ,
Required: False ,
}
string ,
}
,
artifacts:
{
Description: List of artifacts ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
plans:
{
Description: Full set of plan/SKU attributes ,
Required: False ,
}
[
{
planId:
{
Description: Plan identifier ,
Required: False ,
}
string ,
uniquePlanId:
{
Description: Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan / sku ,
Required: False ,
}
string ,
vmArchitectureType:
{
Description: Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types. - `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support - `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support - `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads ,
Required: False ,
}
string ,
cspState:
{
Description: Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program. - `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers - `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels - `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment ,
Required: False ,
}
string ,
metadata:
{
Description: Expanded plan/SKU metadata. ,
Required: False ,
}
{
generation:
{
Description: The VM image generation (applicable to Virtual Machine products only) ,
Required: False ,
}
string ,
altStackReference:
{
Description: Pointing to a planId which holds the alternative stack reference ,
Required: False ,
}
string ,
}
,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
altArchitectureReference:
{
Description: The alternative architecture reference ,
Required: False ,
}
string ,
categoryIds:
{
Description: Plan CategoryIds ,
Required: False ,
}
[
string ,
]
,
hasProtectedArtifacts:
{
Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,
Required: False ,
}
boolean ,
pricingTypes:
{
Description: Indicates the billing models and cost structures available for the plan. - `Free` - No charge for plan usage, typically for community editions or basic service tiers - `FreeTrial` - Time-limited free access period before transitioning to paid billing model - `Byol` - Bring Your Own License model where customers provide existing software licenses - `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage - `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing ,
Required: False ,
}
[
string ,
]
,
vmSecuritytypes:
{
Description: Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types. - `None` - Standard virtual machine security without additional protection features - `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities - `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: The plan summary text ,
Required: False ,
}
string ,
description:
{
Description: Plan / sku description ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU id ,
Required: False ,
}
string ,
planType:
{
Description: Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are: - `None` - Unspecified product type, typically used for products without a defined deployment model - `DevService` - Development-focused services and tools for software creation workflows - `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions - `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure - `AzureApplication` - Native Azure applications leveraging platform services and APIs - `Container` - Containerized applications deployed through Azure Container Instances or similar services - `SaaS` - Software as a Service solutions hosted and managed by the publisher - `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources - `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments - `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations - `ContainerApps` - Applications built for Azure Container Apps serverless container platform - `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality - `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions - `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations - `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons - `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components - `ConsultingServices` - Professional services offerings including implementation and advisory services - `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs - `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities - `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform - `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations - `AADApps` - Azure Active Directory integrated applications supporting organizational identity - `AzureServices` - Native Azure platform services and resource providers - `AppService` - Web applications hosted on Azure App Service platform - `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations - `MicrosoftProduct` - First-party Microsoft products available through marketplace channels ,
Required: True ,
}
string ,
displayRank:
{
Description: The order the plan is displayed in the 'Plans' table ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indication that the plan is accessible to restricted audience only ,
Required: False ,
}
boolean ,
hasRi:
{
Description: Indication whether the SKU supports reservations ,
Required: False ,
}
boolean ,
id:
{
Description: The id ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities for this plan ,
Required: False ,
}
[
{
id:
{
Description: The document id ,
Required: False ,
}
string ,
actions:
{
Description: List of allowed actions ,
Required: False ,
}
[
string ,
]
,
meter:
{
Description: Applicable billing meter information ,
Required: False ,
}
{
meterId:
{
Description: Meter id ,
Required: False ,
}
string ,
partNumber:
{
Description: Compute part number ,
Required: False ,
}
string ,
consumptionResourceId:
{
Description: Consumption resource id ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
type:
{
Description: Type of this meter ,
Required: False ,
}
string ,
includedQuantityProperties:
{
Description: Included quantity properties ,
Required: False ,
}
[
{
termId:
{
Description: Term id ,
Required: False ,
}
string ,
quantity:
{
Description: Included quantity ,
Required: False ,
}
string ,
}
,
]
,
}
,
pricingAudience:
{
Description: Specifies the distribution channel and customer segment for product pricing and availability. Possible values: - `Direct-Commercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `Partner-Commercial` - Available through Cloud Solution Provider partner channel for reseller distribution ,
Required: True ,
}
string ,
terms:
{
Description: List of applicable terms ,
Required: False ,
}
[
{
termDescriptionParameters:
{
Description: Term description parameters ,
Required: False ,
}
[
{
parameter:
{
Description: Description parameter ,
Required: False ,
}
string ,
value:
{
Description: Parameter's value ,
Required: False ,
}
string ,
}
,
]
,
termId:
{
Description: Term id ,
Required: False ,
}
string ,
termUnit:
{
Description: Term unit ,
Required: False ,
}
string ,
prorationPolicy:
{
Description: Defines the rules for calculating prorated charges or refunds for a subscription. ,
Required: False ,
}
{
minimumProratedUnits:
{
Description: Minimum prorated units ,
Required: False ,
}
string ,
}
,
termDescription:
{
Description: Term description ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
renewTermId:
{
Description: Renew term id ,
Required: False ,
}
string ,
renewTermUnits:
{
Description: Renew term units ,
Required: False ,
}
string ,
billingPlan:
{
Description: Billing Plan ,
Required: False ,
}
{
billingPeriod:
{
Description: Billing period ,
Required: False ,
}
string ,
title:
{
Description: Title of the billing plan ,
Required: False ,
}
string ,
description:
{
Description: Description of the billing plan ,
Required: False ,
}
string ,
price:
{
Description: Retail price with currency ,
Required: False ,
}
{
currencyCode:
{
Description: Currency code i.e. 'USD' ,
Required: False ,
}
string ,
isPiRequired:
{
Description: A value indicating whether a payment instrument is required ,
Required: True ,
}
boolean ,
listPrice:
{
Description: Retail price for the item ,
Format: float ,
Required: True ,
}
number ,
msrp:
{
Description: Manufacturer's suggested retail price for the item ,
Format: float ,
Required: True ,
}
number ,
}
,
}
,
renewToTermBillingPlan:
{
Description: Renew Billing Plan ,
Required: False ,
}
string ,
isAutorenewable:
{
Description: Indicates if autorenew is enabled ,
Required: False ,
}
boolean ,
}
,
]
,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
consumptionUnitType:
{
Description: Consumption unit type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
uiDefinitionUri:
{
Description: What blade to open when someone wants to create a marketplace item ,
Required: False ,
}
string ,
artifacts:
{
Description: Files related to the marketplace item ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: Defines the artifact resource type and its role in the marketplace offering deployment process. - `Template` - Primary Azure Resource Manager template containing the main deployment configuration - `Fragment` - Nested Azure Resource Manager template referenced by the primary template for modular deployments - `Custom` - Publisher-defined artifact with specialized deployment or configuration requirements - `Metadata` - Supplementary information and configuration data supporting the deployment process ,
Required: True ,
}
string ,
}
,
]
,
version:
{
Description: Version of the marketplace item ,
Required: False ,
}
string ,
isHidden:
{
Description: A value indicating whether the plan is hidden ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether plan has been stopped from selling ,
Required: True ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
{
startDate:
{
Description: A value indicating when the sale of this item is going to be stopped ,
Format: date-time ,
Required: False ,
}
string ,
reason:
{
Description: Specifies the business or technical justification for discontinuing product sales in the marketplace. - `EndOfSupport` - Product lifecycle has reached end-of-support status with no further updates or maintenance - `SecurityIssue` - Critical security vulnerability or compliance issue requiring immediate sales suspension - `Other` - Alternative business reason not covered by standard discontinuation categories ,
Required: False ,
}
string ,
alternativeOfferId:
{
Description: A value indicating an ID of an alternative offer provided by the same publisher ,
Required: False ,
}
string ,
alternativePlanId:
{
Description: A value indicating an ID of an alternative plan of the same offer ,
Required: False ,
}
string ,
}
,
minQuantity:
{
Description: Min quantity ,
Format: int32 ,
Required: False ,
}
integer ,
maxQuantity:
{
Description: Max quantity ,
Format: int32 ,
Required: False ,
}
integer ,
isQuantifiable:
{
Description: A value indicating whether the plan is quantifiable ,
Required: True ,
}
boolean ,
billingComponents:
{
Description: Billing components ,
Required: False ,
}
[
{
billingTag:
{
Description: Billing Tag ,
Required: False ,
}
string ,
}
,
]
,
purchaseDurationDiscounts:
{
Description: List of purchase duration discounts ,
Required: False ,
}
[
{
duration:
{
Description: The duration ,
Required: False ,
}
string ,
discountPercentage:
{
Description: The discount percentage ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
isHiddenPrivateOffer:
{
Description: A value indicating whether the plan is used as hidden private offer requiring a quote ,
Required: False ,
}
boolean ,
certifications:
{
Description: List of certifications ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: Uri of the link ,
Required: False ,
}
string ,
}
,
]
,
customerInstruction:
{
Description: Plan's customer instruction for purchasing ,
Required: False ,
}
string ,
planLabels:
{
Description: Plan labels ,
Required: False ,
}
[
string ,
]
,
skuType:
{
Description: SKU type ,
Required: False ,
}
string ,
skuTitle:
{
Description: Sku title localized ,
Required: False ,
}
string ,
location:
{
Description: SKU location ,
Required: False ,
}
string ,
armRegionName:
{
Description: The Arm region name ,
Required: False ,
}
string ,
cloud:
{
Description: Applicable cloud, such as 'Global' ,
Required: False ,
}
string ,
locationType:
{
Description: The location type, such as 'Region' ,
Required: False ,
}
string ,
region:
{
Description: The region ,
Required: False ,
}
string ,
skuGroupId:
{
Description: The sku group id ,
Required: False ,
}
string ,
zone:
{
Description: The zone, such as 'Zone 1' ,
Required: False ,
}
string ,
feature:
{
Description: The feature, such as 'Spot' ,
Required: False ,
}
string ,
serviceType:
{
Description: The service type ,
Required: False ,
}
string ,
skuAttributes:
{
Description: Set of SKU attributes (varies per sku type), where each attribute is represented by a pair of key (attribute name) and value(attribute value) ,
Required: False ,
}
[
{
key:
{
Description: The attribute key ,
Required: False ,
}
string ,
value:
{
Description: The attribute value ,
Required: False ,
}
string ,
}
,
]
,
skuProperties:
{
Description: The sku properties ,
Required: False ,
}
{
category:
{
Description: The sku category ,
Required: False ,
}
string ,
dataDiskType:
{
Description: The data disk type, such as 'Ssd' ,
Required: False ,
}
string ,
diskType:
{
Description: The disk type, such as 'Ssd' ,
Required: False ,
}
string ,
numberOfCores:
{
Description: The number of cores ,
Required: False ,
}
string ,
ram:
{
Description: The RAM ,
Required: False ,
}
string ,
vCpu:
{
Description: The number of virtual CPUs ,
Required: False ,
}
string ,
armSkuName:
{
Description: The ARM SKU name ,
Required: False ,
}
string ,
accessTier:
{
Description: The access tier, such as 'Standard' ,
Required: False ,
}
string ,
}
,
offeringProperties:
{
Description: SKU price related properties. ,
Required: False ,
}
[
{
productCode:
{
Description: The product code (UPN) ,
Required: False ,
}
string ,
termId:
{
Description: The term id ,
Required: False ,
}
string ,
meterType:
{
Description: The meter type ,
Required: False ,
}
string ,
billingMeterId:
{
Description: The billing meter id ,
Required: False ,
}
string ,
offeringId:
{
Description: The offering id ,
Required: False ,
}
string ,
type:
{
Description: Entitlement, Consumption or Reservation ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details object ,
Required: True ,
}
{
code:
{
Description: The HTTP error code ,
Required: True ,
}
string ,
message:
{
Description: The error message ,
Required: True ,
}
string ,
}
,
}