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

2025/11/13 • 4 updated methods

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

⚶ Changes

{
  "#id": "ProductGet_GetByBillingProfile",
  "$responses": {
    "200": {
      "Description": {
        "new": "Returns the full set of Product attributes",
        "old": "Summary description of the product"
      },
      "$properties": [
        {
          "@added_6470f8c1178c47baa48d5f5f0f6809b6": {
            "#name": "displayName",
            "Description": "Product display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_be32ff0105eb4ea0a34df75374cb7674": {
            "#name": "popularity",
            "Description": "Popularity of the product",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_dec3b0e48307473a9b582f22d2e3dfe4": {
            "#name": "categoryIds",
            "Description": "Array of product categories",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_49b879b16d9a4e8db058bd968991b5d9": {
            "#name": "industryIds",
            "Description": "List of industry IDs the item belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_75d5c2f50b5b42f29c18486086a797ba": {
            "#name": "publisherId",
            "Description": "Publisher id",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_d06452d8b3d1496b87eb7e83da0afa09": {
            "#name": "azureBenefit",
            "Description": "Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers.\n- `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits\n- `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_ae8d5022ca3343ef9633b427ddd0ccb1": {
            "#name": "badges",
            "Description": "Displays certification and qualification badges earned by the product for marketplace visibility.\n- `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria\n- `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform\n- `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_7390fe17193f47e19e3099c4fb2dcd2c": {
            "#name": "publisherType",
            "Description": "Identifies the publisher relationship to Microsoft for support and partnership classification.\n- `Microsoft` - First-party Microsoft product with direct Microsoft support and development\n- `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_d1b93e6c0404415081483e402ce4c8c1": {
            "#name": "publishingStage",
            "Description": "Indicates the product availability status and customer access level within Azure Marketplace.\n- `Preview` - Limited availability to selected customers for testing and early access evaluation\n- `Public` - General availability to all Azure Marketplace customers for production deployment",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_93bf4d856fcc472384ea6ca8e00b719d": {
            "#name": "uniqueProductId",
            "Description": "Unique product identifier",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_3e88a2bf612349aa9856a7050b967f82": {
            "#name": "productType",
            "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_19fb3e03af764a64aef98d2a598f52af": {
            "#name": "productSubType",
            "Description": "Product sub type",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_e051972e5603415284cb81d4ecee9de0": {
            "#name": "productFamily",
            "Description": "Product Family",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_42ed5106eb6b4dbfa8a02ea101857933": {
            "#name": "operatingSystems",
            "Description": "Operating system info for this product",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_9d8eac1e330e4e53a5c581bc3eeb98b1": {
            "#name": "pricingTypes",
            "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_6b928bcc76794b6c95fc531c6a11f89d": {
            "#name": "publisherDisplayName",
            "Description": "Publisher display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_4e683d7174e04017af7719dc64bf92ec": {
            "#name": "longSummary",
            "Description": "Product long summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_14378c899f854711aaf83d0a56351fa8": {
            "#name": "summary",
            "Description": "Product summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_5abac080d3c84607be76b746fa95c045": {
            "#name": "smallIconUri",
            "Description": "URI to the small product icon",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_3498cb4a2688467897ef03e93e03f952": {
            "#name": "description",
            "Description": "The product description text",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_ef956d37dd324edca1094e6ecfd3b278": {
            "#name": "cspLegalTermsUri",
            "Description": "The legal terms of the product for the CSP",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_18e5303569fa4987b920af6b48936479": {
            "#name": "privacyPolicyUri",
            "Description": "The privacy policy of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_5c2a909f3b8f49d6a517a0a9bae86030": {
            "#name": "ratingBuckets",
            "Description": "Categorizes products by customer rating thresholds for marketplace filtering and discovery.\n- `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews\n- `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews\n- `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews\n- `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_30b66598f8de469db7e2a316b69e1fe4": {
            "#name": "ratingAverage",
            "Description": "Average rating for the offer",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_0e325ac0673542029da34dc622eb5ff8": {
            "#name": "ratingCount",
            "Description": "Total number of ratings for the offer",
            "Format": "int32",
            "Required": false,
            "Type": "integer"
          }
        },
        {
          "@added_a1dcfe2b52594f75a89ac277e24bd898": {
            "#name": "supportedProducts",
            "Description": "Maps to the list of compatible products",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_092d1cccf84a49dc99f1a73934409789": {
            "#name": "applicableProducts",
            "Description": "Product categories the offer belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_72f937f9a41041cbb14af4448d0e2467": {
            "#name": "lastModifiedDateTime",
            "Description": "Latest update date of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_965131b301a742aeb3033ae55adbbe9b": {
            "#name": "locations",
            "Description": "List of locations which are available on the SKUs",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_2a21341b172a4a4aa8f2b44d61cff1a3": {
            "#name": "serviceFamily",
            "Description": "The service family of the product, such as 'Compute'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_f627a5cbda5546dfb426d1801ee8519e": {
            "#name": "service",
            "Description": "The service name of the product, such as 'Virtual Machines'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "#name": "productId",
          "Required": {
            "new": false,
            "old": true
          }
        },
        {
          "@added_f9b86d796d234f40a25b82b4949262d7": {
            "#name": "hasRiPlans",
            "Description": "Indication whether the product has plans with reservations",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_66b638fb6c534a8aa3e076b33aa49b48": {
            "#name": "hasMarketplaceFootprint",
            "Description": "Indication if product has a representation in the marketplace",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_a99fcc8195094cd8b801da5c890b1715": {
            "#name": "attributes",
            "Description": "Set of products attributes",
            "Required": false,
            "Type": "array",
            "$items": {
              "Description": "Represents a SKU attribute, which consists of a key and value. The attributes may differ across various services.",
              "Type": "object",
              "$properties": [
                {
                  "#name": "key",
                  "Description": "The attribute key",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "value",
                  "Description": "The attribute value",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        },
        {
          "plans": {
            "Description": {
              "new": "Returns the full set of Plan attributes",
              "old": "Returns a subset of Plan attributes"
            },
            "$properties": {
              "@added_6243077e64164c2f9a4c9f8ab5a5e681": {
                "#name": "planId",
                "Description": "Plan identifier",
                "Required": false,
                "Type": "string"
              },
              "@added_9ca50b56f7bc48ee89dab81ad8572875": {
                "#name": "uniquePlanId",
                "Description": "Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between",
                "Required": false,
                "Type": "string"
              },
              "@added_b29bb62b10944d7190ee099f0f868b67": {
                "#name": "displayName",
                "Description": "Display name of the plan / sku",
                "Required": false,
                "Type": "string"
              },
              "@added_829402533b4c435e8f9a07be7132f0c2": {
                "#name": "vmArchitectureType",
                "Description": "Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types.\n- `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support\n- `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support\n- `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads",
                "Required": false,
                "Type": "string"
              },
              "@added_b1b833a43ee64e2bb1fde5fd341618b1": {
                "#name": "cspState",
                "Description": "Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program.\n- `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers\n- `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels\n- `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment",
                "Required": false,
                "Type": "string"
              },
              "@added_834009f3f720471b8a2d3fede7070ff2": {
                "#name": "metadata",
                "Description": "Expanded plan/SKU metadata.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "generation",
                    "Description": "The VM image generation (applicable to Virtual Machine products only)",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "altStackReference",
                    "Description": "Pointing to a planId which holds the alternative stack reference",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_eaccb20fcf934619b8f7ad1a4fa99b2d": {
                "#name": "altStackReference",
                "Description": "Alternative stack reference",
                "Required": false,
                "Type": "string"
              },
              "@added_64cefe7969a84eea96a6bc47bffa8da5": {
                "#name": "stackType",
                "Description": "Stack type : Classic, Gen1, Gen2",
                "Required": false,
                "Type": "string"
              },
              "@added_e36dcc041c074615a32479f72a2984e9": {
                "#name": "altArchitectureReference",
                "Description": "The alternative architecture reference",
                "Required": false,
                "Type": "string"
              },
              "@added_5984d3b9bd8c4948b4a681701fc7eed2": {
                "#name": "categoryIds",
                "Description": "Plan CategoryIds",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_97abe8c375da425bbedda2381c2c5a21": {
                "#name": "hasProtectedArtifacts",
                "Description": "Set to true if plan has artifacts that are to be hidden for non authenticated users",
                "Required": false,
                "Type": "boolean"
              },
              "@added_f5ed684a3d1b47748de5d4cf04684c1b": {
                "#name": "pricingTypes",
                "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_62c810dfc4da4fcfb5f8b5aed63a5f1b": {
                "#name": "vmSecuritytypes",
                "Description": "Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types.\n- `None` - Standard virtual machine security without additional protection features\n- `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities\n- `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_18c11239747d4098a137595f60a0786e": {
                "#name": "summary",
                "Description": "The plan summary text",
                "Required": false,
                "Type": "string"
              },
              "@added_4bef7436bb624307be68aa9c5b779c60": {
                "#name": "description",
                "Description": "Plan / sku description",
                "Required": false,
                "Type": "string"
              },
              "@added_519e6679c9c643ddae9c0471b62561eb": {
                "#name": "skuId",
                "Description": "The SKU id",
                "Required": false,
                "Type": "string"
              },
              "@added_3212e97bd8454781bf5c46f60203262f": {
                "#name": "planType",
                "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `DevService` - Development-focused services and tools for software creation workflows\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
                "Required": true,
                "Type": "string"
              },
              "@added_40445a46c38d48a39a76eb0a54b657e9": {
                "#name": "displayRank",
                "Description": "The order the plan is displayed in the 'Plans' table",
                "Required": false,
                "Type": "string"
              },
              "@added_eb32d30d889b45ecb8a5298d7685a183": {
                "#name": "isPrivate",
                "Description": "Indication that the plan is accessible to restricted audience only",
                "Required": false,
                "Type": "boolean"
              },
              "@added_279f930dfc764f9bb8557800559d89b9": {
                "#name": "hasRi",
                "Description": "Indication whether the SKU supports reservations",
                "Required": false,
                "Type": "boolean"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ 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: - `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `PartnerCommercial` - 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": {
      "Description": {
        "new": "Returns the full set of Product attributes",
        "old": "Summary description of the product"
      },
      "$properties": [
        {
          "@added_0d6815a381314506a89590ccb06c0ec2": {
            "#name": "displayName",
            "Description": "Product display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_f6b51351cc4d4f99b063d3a759f5fe5d": {
            "#name": "popularity",
            "Description": "Popularity of the product",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_e17d99b933444e908ef194c7cec602bc": {
            "#name": "categoryIds",
            "Description": "Array of product categories",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_ad947252e3a44152ab7367322919c4b9": {
            "#name": "industryIds",
            "Description": "List of industry IDs the item belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_28b33b7122614adba16e6ce219a9b5d1": {
            "#name": "publisherId",
            "Description": "Publisher id",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_201345d6262648b4a58d3fc9b77c6741": {
            "#name": "azureBenefit",
            "Description": "Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers.\n- `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits\n- `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_215efb6ca2454957a27b6e431e60a251": {
            "#name": "badges",
            "Description": "Displays certification and qualification badges earned by the product for marketplace visibility.\n- `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria\n- `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform\n- `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_936164c5385140e099c7a2d1b0be0a02": {
            "#name": "publisherType",
            "Description": "Identifies the publisher relationship to Microsoft for support and partnership classification.\n- `Microsoft` - First-party Microsoft product with direct Microsoft support and development\n- `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_b11623ce2653423ca34220c0e7a42c2b": {
            "#name": "publishingStage",
            "Description": "Indicates the product availability status and customer access level within Azure Marketplace.\n- `Preview` - Limited availability to selected customers for testing and early access evaluation\n- `Public` - General availability to all Azure Marketplace customers for production deployment",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_c19531d00aa84acfb47cf3c8b6544abc": {
            "#name": "uniqueProductId",
            "Description": "Unique product identifier",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_b5982c014677491dbdd640a4a55b05e6": {
            "#name": "productType",
            "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_237fb116500c4efd8ad77992d9ed175f": {
            "#name": "productSubType",
            "Description": "Product sub type",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_611889c7e7f04fac97560783d905a794": {
            "#name": "productFamily",
            "Description": "Product Family",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_38923553e63f4358bc552395f0f68bea": {
            "#name": "operatingSystems",
            "Description": "Operating system info for this product",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_af4ec2b8a433448eb168324b1f2a967e": {
            "#name": "pricingTypes",
            "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_33419330f8d948389487840ed97d0909": {
            "#name": "publisherDisplayName",
            "Description": "Publisher display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_d6c92e69492d4181b3de6e0593a5000c": {
            "#name": "longSummary",
            "Description": "Product long summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_2573898df6d544ed8d20f51c2c5f0539": {
            "#name": "summary",
            "Description": "Product summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_017fd8ae902e487dad9d1afd290831d5": {
            "#name": "smallIconUri",
            "Description": "URI to the small product icon",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_8cf77faad70642138e595107936a9307": {
            "#name": "description",
            "Description": "The product description text",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_88a1a86db69c4fe58db06c598e565125": {
            "#name": "cspLegalTermsUri",
            "Description": "The legal terms of the product for the CSP",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_6776def900ff43399f50758e8a767ac2": {
            "#name": "privacyPolicyUri",
            "Description": "The privacy policy of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_4021d8bed94f4f9e8194f1cc0ec0b963": {
            "#name": "ratingBuckets",
            "Description": "Categorizes products by customer rating thresholds for marketplace filtering and discovery.\n- `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews\n- `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews\n- `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews\n- `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_95b2fd82bc48405d9646701c98d64000": {
            "#name": "ratingAverage",
            "Description": "Average rating for the offer",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_1a011e09b2bb485caa6f81fbf6283bd4": {
            "#name": "ratingCount",
            "Description": "Total number of ratings for the offer",
            "Format": "int32",
            "Required": false,
            "Type": "integer"
          }
        },
        {
          "@added_88dfa372a2a74897a8dd7e223c4ba00f": {
            "#name": "supportedProducts",
            "Description": "Maps to the list of compatible products",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_df957b5ee66c4bcbbdc72722874396f4": {
            "#name": "applicableProducts",
            "Description": "Product categories the offer belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_587e648fefe3492c872bb71e1be9203c": {
            "#name": "lastModifiedDateTime",
            "Description": "Latest update date of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_7d7f73b0570d46ff8e6245240f139bdd": {
            "#name": "locations",
            "Description": "List of locations which are available on the SKUs",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_9f03e4e90cdd4e448a40f3bade3af765": {
            "#name": "serviceFamily",
            "Description": "The service family of the product, such as 'Compute'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_2eb27524608e4ad2aa493ab59d52c6d6": {
            "#name": "service",
            "Description": "The service name of the product, such as 'Virtual Machines'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "#name": "productId",
          "Required": {
            "new": false,
            "old": true
          }
        },
        {
          "@added_baf9e5f24d304fb98f9a47f27a7bbbdd": {
            "#name": "hasRiPlans",
            "Description": "Indication whether the product has plans with reservations",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_6452c830c94d44c38862c242cb8635e4": {
            "#name": "hasMarketplaceFootprint",
            "Description": "Indication if product has a representation in the marketplace",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_55750bb4b28d4da0b23bf193101db984": {
            "#name": "attributes",
            "Description": "Set of products attributes",
            "Required": false,
            "Type": "array",
            "$items": {
              "Description": "Represents a SKU attribute, which consists of a key and value. The attributes may differ across various services.",
              "Type": "object",
              "$properties": [
                {
                  "#name": "key",
                  "Description": "The attribute key",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "value",
                  "Description": "The attribute value",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        },
        {
          "plans": {
            "Description": {
              "new": "Returns the full set of Plan attributes",
              "old": "Returns a subset of Plan attributes"
            },
            "$properties": {
              "@added_8bb528872a924b438cc0ae4f4dea439d": {
                "#name": "planId",
                "Description": "Plan identifier",
                "Required": false,
                "Type": "string"
              },
              "@added_7baa75cfdeab4c9c95d61cce28772220": {
                "#name": "uniquePlanId",
                "Description": "Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between",
                "Required": false,
                "Type": "string"
              },
              "@added_b151fc433a394dd6a828bdedd398afac": {
                "#name": "displayName",
                "Description": "Display name of the plan / sku",
                "Required": false,
                "Type": "string"
              },
              "@added_7395dc8fe9ee43688500451901ec4461": {
                "#name": "vmArchitectureType",
                "Description": "Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types.\n- `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support\n- `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support\n- `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads",
                "Required": false,
                "Type": "string"
              },
              "@added_6df1164368314db1a7485711aefedfd6": {
                "#name": "cspState",
                "Description": "Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program.\n- `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers\n- `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels\n- `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment",
                "Required": false,
                "Type": "string"
              },
              "@added_f8908e8f8450416db132ca9eb8fdcb77": {
                "#name": "metadata",
                "Description": "Expanded plan/SKU metadata.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "generation",
                    "Description": "The VM image generation (applicable to Virtual Machine products only)",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "altStackReference",
                    "Description": "Pointing to a planId which holds the alternative stack reference",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_d7487d9722b84416b517baba798cc650": {
                "#name": "altStackReference",
                "Description": "Alternative stack reference",
                "Required": false,
                "Type": "string"
              },
              "@added_58683a8524d941f2867699dc12522494": {
                "#name": "stackType",
                "Description": "Stack type : Classic, Gen1, Gen2",
                "Required": false,
                "Type": "string"
              },
              "@added_ce67ee0bc7f44a9b9e703a5f687d0231": {
                "#name": "altArchitectureReference",
                "Description": "The alternative architecture reference",
                "Required": false,
                "Type": "string"
              },
              "@added_16d2154e14254a55b287a65e51a395f7": {
                "#name": "categoryIds",
                "Description": "Plan CategoryIds",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_2d8fa08ac47446d2be3283145e395819": {
                "#name": "hasProtectedArtifacts",
                "Description": "Set to true if plan has artifacts that are to be hidden for non authenticated users",
                "Required": false,
                "Type": "boolean"
              },
              "@added_5ac103865fc640309fb5e5c254da555b": {
                "#name": "pricingTypes",
                "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_71240d149219418bbe3adee5c052c4fb": {
                "#name": "vmSecuritytypes",
                "Description": "Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types.\n- `None` - Standard virtual machine security without additional protection features\n- `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities\n- `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_eb583e77d74b4b538021fdb600e57a74": {
                "#name": "summary",
                "Description": "The plan summary text",
                "Required": false,
                "Type": "string"
              },
              "@added_f97ef0b839a040ef9a2efed852595da9": {
                "#name": "description",
                "Description": "Plan / sku description",
                "Required": false,
                "Type": "string"
              },
              "@added_5cabcc29410c43a5821a83cf7d163d40": {
                "#name": "skuId",
                "Description": "The SKU id",
                "Required": false,
                "Type": "string"
              },
              "@added_42cc2f5653a241b8b235079e6416e41b": {
                "#name": "planType",
                "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `DevService` - Development-focused services and tools for software creation workflows\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
                "Required": true,
                "Type": "string"
              },
              "@added_76bbba1416e94a63b6d48f013ce8a9be": {
                "#name": "displayRank",
                "Description": "The order the plan is displayed in the 'Plans' table",
                "Required": false,
                "Type": "string"
              },
              "@added_21975e5f70da4746a638a4a1f5aabcf1": {
                "#name": "isPrivate",
                "Description": "Indication that the plan is accessible to restricted audience only",
                "Required": false,
                "Type": "boolean"
              },
              "@added_53c0778e83a64d8bba07e094401557e0": {
                "#name": "hasRi",
                "Description": "Indication whether the SKU supports reservations",
                "Required": false,
                "Type": "boolean"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ 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: - `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `PartnerCommercial` - 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",
  "$responses": {
    "200": {
      "Description": {
        "new": "Returns the full set of Product attributes",
        "old": "Summary description of the product"
      },
      "$properties": [
        {
          "@added_4ed81f9dd8054f91b8f16434aab682b0": {
            "#name": "displayName",
            "Description": "Product display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_16daa5bd6e4846f583d23dcd7ec71afb": {
            "#name": "popularity",
            "Description": "Popularity of the product",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_193b32ccd7394a268dd42fb8dde2af3d": {
            "#name": "categoryIds",
            "Description": "Array of product categories",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_8975ed0527f54ceaa778bab8ff1009a6": {
            "#name": "industryIds",
            "Description": "List of industry IDs the item belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_faf7a24e1df44afab09490143c96d626": {
            "#name": "publisherId",
            "Description": "Publisher id",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_36517cd6d2fe489992f84a21dfab1959": {
            "#name": "azureBenefit",
            "Description": "Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers.\n- `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits\n- `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_08e49f7f00aa4aadad619dc0373bde90": {
            "#name": "badges",
            "Description": "Displays certification and qualification badges earned by the product for marketplace visibility.\n- `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria\n- `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform\n- `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_e9f1dde3c74a4acdaecd391e7e1a8e81": {
            "#name": "publisherType",
            "Description": "Identifies the publisher relationship to Microsoft for support and partnership classification.\n- `Microsoft` - First-party Microsoft product with direct Microsoft support and development\n- `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_90d76676b1d64badb106663cb6849a31": {
            "#name": "publishingStage",
            "Description": "Indicates the product availability status and customer access level within Azure Marketplace.\n- `Preview` - Limited availability to selected customers for testing and early access evaluation\n- `Public` - General availability to all Azure Marketplace customers for production deployment",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_212ec41ab9cb4dfa9a50362fac7624b4": {
            "#name": "uniqueProductId",
            "Description": "Unique product identifier",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_75b85fc620cd454e9f0a41df26245ca3": {
            "#name": "productType",
            "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_2e3a1afb4fdd4c6ab3beeff7a19965da": {
            "#name": "productSubType",
            "Description": "Product sub type",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_44aac471528a4f0aab21b31263be54d7": {
            "#name": "productFamily",
            "Description": "Product Family",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_4d96c36b61cd40258a445fee33e632e3": {
            "#name": "operatingSystems",
            "Description": "Operating system info for this product",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_7534222b0dcb4e5c978cbcce0a8da721": {
            "#name": "pricingTypes",
            "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_5487e24da3e0417a8477e68e25256f81": {
            "#name": "publisherDisplayName",
            "Description": "Publisher display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_211e8718f6f24384a267050a8894dc6f": {
            "#name": "longSummary",
            "Description": "Product long summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_fc5dc6a7e5994788a50e4194277f3bf6": {
            "#name": "summary",
            "Description": "Product summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_daa62354265a4c719008ac51502f8431": {
            "#name": "smallIconUri",
            "Description": "URI to the small product icon",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_5de88d42b3d042a898746dd497438f5b": {
            "#name": "description",
            "Description": "The product description text",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_3bf0353f6315452f8d5f4867c5becea4": {
            "#name": "cspLegalTermsUri",
            "Description": "The legal terms of the product for the CSP",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_d8e7018ba7994e99935939a92e2d602a": {
            "#name": "privacyPolicyUri",
            "Description": "The privacy policy of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_4a702560a4f541deae1eab88cb2fd126": {
            "#name": "ratingBuckets",
            "Description": "Categorizes products by customer rating thresholds for marketplace filtering and discovery.\n- `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews\n- `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews\n- `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews\n- `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_d39cda3484774d398d2a071c520db2cc": {
            "#name": "ratingAverage",
            "Description": "Average rating for the offer",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_ed311ab540d549beb85677c086e46621": {
            "#name": "ratingCount",
            "Description": "Total number of ratings for the offer",
            "Format": "int32",
            "Required": false,
            "Type": "integer"
          }
        },
        {
          "@added_89b2d4d78c45479d8af50c2f03d31694": {
            "#name": "supportedProducts",
            "Description": "Maps to the list of compatible products",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_909cd800c9324e9b885a0246ccb72523": {
            "#name": "applicableProducts",
            "Description": "Product categories the offer belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_71fd326fdaec4dd0b002a0bf83655b15": {
            "#name": "lastModifiedDateTime",
            "Description": "Latest update date of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_d6cb69b77b62451fb29816926258d212": {
            "#name": "locations",
            "Description": "List of locations which are available on the SKUs",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_e82f9389dbca427f88b2bceb61ddb162": {
            "#name": "serviceFamily",
            "Description": "The service family of the product, such as 'Compute'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_746646c6f1bf40d3b94f209f4ec64e45": {
            "#name": "service",
            "Description": "The service name of the product, such as 'Virtual Machines'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "#name": "productId",
          "Required": {
            "new": false,
            "old": true
          }
        },
        {
          "@added_98217ecbeb7b4b22aca5cdf5a9a6e2a3": {
            "#name": "hasRiPlans",
            "Description": "Indication whether the product has plans with reservations",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_32dd872d7ccd4c4191b677498ac5962c": {
            "#name": "hasMarketplaceFootprint",
            "Description": "Indication if product has a representation in the marketplace",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_e3d506c4efff46c9a9960fc279218346": {
            "#name": "attributes",
            "Description": "Set of products attributes",
            "Required": false,
            "Type": "array",
            "$items": {
              "Description": "Represents a SKU attribute, which consists of a key and value. The attributes may differ across various services.",
              "Type": "object",
              "$properties": [
                {
                  "#name": "key",
                  "Description": "The attribute key",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "value",
                  "Description": "The attribute value",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        },
        {
          "plans": {
            "Description": {
              "new": "Returns the full set of Plan attributes",
              "old": "Returns a subset of Plan attributes"
            },
            "$properties": {
              "@added_ea1da59c5ae84043a9cc4b2c8dbbcaf2": {
                "#name": "planId",
                "Description": "Plan identifier",
                "Required": false,
                "Type": "string"
              },
              "@added_81e6947a65424343a50957fa739e9bf5": {
                "#name": "uniquePlanId",
                "Description": "Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between",
                "Required": false,
                "Type": "string"
              },
              "@added_b080ec5c391348b49c13b898ac4ab1cc": {
                "#name": "displayName",
                "Description": "Display name of the plan / sku",
                "Required": false,
                "Type": "string"
              },
              "@added_b22ff71d839c4206b2892a2e8ebcaad8": {
                "#name": "vmArchitectureType",
                "Description": "Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types.\n- `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support\n- `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support\n- `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads",
                "Required": false,
                "Type": "string"
              },
              "@added_392a0b61a2604b58b1410b92dec541dd": {
                "#name": "cspState",
                "Description": "Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program.\n- `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers\n- `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels\n- `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment",
                "Required": false,
                "Type": "string"
              },
              "@added_a3fd6d1a602a462098fb3c50cfe18a41": {
                "#name": "metadata",
                "Description": "Expanded plan/SKU metadata.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "generation",
                    "Description": "The VM image generation (applicable to Virtual Machine products only)",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "altStackReference",
                    "Description": "Pointing to a planId which holds the alternative stack reference",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_1855158d7a7f4228b435ddfe80e49189": {
                "#name": "altStackReference",
                "Description": "Alternative stack reference",
                "Required": false,
                "Type": "string"
              },
              "@added_a34dda6b0e204b68bd1418a2bf9915d9": {
                "#name": "stackType",
                "Description": "Stack type : Classic, Gen1, Gen2",
                "Required": false,
                "Type": "string"
              },
              "@added_ea5b6ca9abb845d39976b0a09131cf7f": {
                "#name": "altArchitectureReference",
                "Description": "The alternative architecture reference",
                "Required": false,
                "Type": "string"
              },
              "@added_a22b4bc9aa6642a9a175d7b364c1e361": {
                "#name": "categoryIds",
                "Description": "Plan CategoryIds",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_a03ef045bc7b40cf90250468750f5832": {
                "#name": "hasProtectedArtifacts",
                "Description": "Set to true if plan has artifacts that are to be hidden for non authenticated users",
                "Required": false,
                "Type": "boolean"
              },
              "@added_8f3e905334064d3a8b2046ae676de87b": {
                "#name": "pricingTypes",
                "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_b2407f0cd16e4a769dbbc4b4fcbece97": {
                "#name": "vmSecuritytypes",
                "Description": "Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types.\n- `None` - Standard virtual machine security without additional protection features\n- `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities\n- `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_5fe9abfc70b0435d9c23c8bb01b99e12": {
                "#name": "summary",
                "Description": "The plan summary text",
                "Required": false,
                "Type": "string"
              },
              "@added_1242dadbc404446cb83bed4f0b938f10": {
                "#name": "description",
                "Description": "Plan / sku description",
                "Required": false,
                "Type": "string"
              },
              "@added_f3ea16f585a74ad68b206b3d92ab884e": {
                "#name": "skuId",
                "Description": "The SKU id",
                "Required": false,
                "Type": "string"
              },
              "@added_b191e016b306455aa1aabdee06db7e0a": {
                "#name": "planType",
                "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `DevService` - Development-focused services and tools for software creation workflows\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
                "Required": true,
                "Type": "string"
              },
              "@added_65b51866187148ec83ce945e72dfbbef": {
                "#name": "displayRank",
                "Description": "The order the plan is displayed in the 'Plans' table",
                "Required": false,
                "Type": "string"
              },
              "@added_b82ca0fc4158428a936182d9ad895a99": {
                "#name": "isPrivate",
                "Description": "Indication that the plan is accessible to restricted audience only",
                "Required": false,
                "Type": "boolean"
              },
              "@added_d45b502a75974ca4a7e47dafb4f30d42": {
                "#name": "hasRi",
                "Description": "Indication whether the SKU supports reservations",
                "Required": false,
                "Type": "boolean"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ 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, 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. ,
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: - `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `PartnerCommercial` - 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": {
      "Description": {
        "new": "Returns the full set of Product attributes",
        "old": "Summary description of the product"
      },
      "$properties": [
        {
          "@added_88f9051712ad43b79e100ff94ad11b69": {
            "#name": "displayName",
            "Description": "Product display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_5ed6d0b7c7154fcb8d5e96ac704414c6": {
            "#name": "popularity",
            "Description": "Popularity of the product",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_dab82938674048ad90ed36a98502fb61": {
            "#name": "categoryIds",
            "Description": "Array of product categories",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_e282eac799da48399901c4ae7fb7ee22": {
            "#name": "industryIds",
            "Description": "List of industry IDs the item belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_bc3c470d6201457a9f6b27618d8b298f": {
            "#name": "publisherId",
            "Description": "Publisher id",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_bdabc3a4d33b4492a85540c3db76eaae": {
            "#name": "azureBenefit",
            "Description": "Indicates whether product purchases count toward Azure consumption commitment benefits for enterprise customers.\n- `Eligible` - Product costs apply to Azure consumption commitment benefit calculations and credits\n- `NotEligible` - Product costs do not qualify for Azure consumption commitment benefit programs",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_a8723e2c4f984727be2f2bbe29816aef": {
            "#name": "badges",
            "Description": "Displays certification and qualification badges earned by the product for marketplace visibility.\n- `PreferredSolution` - Microsoft-recognized solution meeting specific quality and partnership criteria\n- `PowerBICertified` - Certified compatibility and integration with Microsoft Power BI platform\n- `AdditionalPurchaseRequirement` - Product requires additional purchases or subscriptions for full functionality",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_8a6947563fcb4415a4606f63ea157949": {
            "#name": "publisherType",
            "Description": "Identifies the publisher relationship to Microsoft for support and partnership classification.\n- `Microsoft` - First-party Microsoft product with direct Microsoft support and development\n- `ThirdParty` - Independent software vendor product with publisher-provided support and maintenance",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_b0e28ee8832040c6a661b578d04be049": {
            "#name": "publishingStage",
            "Description": "Indicates the product availability status and customer access level within Azure Marketplace.\n- `Preview` - Limited availability to selected customers for testing and early access evaluation\n- `Public` - General availability to all Azure Marketplace customers for production deployment",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_2110b992f9d14bc0a088d5e32960a95d": {
            "#name": "uniqueProductId",
            "Description": "Unique product identifier",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_656d257d1f544027aa4ba692a3695772": {
            "#name": "productType",
            "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
            "Required": true,
            "Type": "string"
          }
        },
        {
          "@added_862dba26083346c4bdd83e6f710c75be": {
            "#name": "productSubType",
            "Description": "Product sub type",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_bbdad5fc4cf7406fba3e3da000c76a1a": {
            "#name": "productFamily",
            "Description": "Product Family",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_2323310b4403423dad49f311df2ad9a5": {
            "#name": "operatingSystems",
            "Description": "Operating system info for this product",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_590f99cf6d4643fc9e5d18ed8b3f4b3e": {
            "#name": "pricingTypes",
            "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_6b8570b7d9d5495fa2bc4bc8162000e7": {
            "#name": "publisherDisplayName",
            "Description": "Publisher display name",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_ed9c19216db045d089661a6d139e5c20": {
            "#name": "longSummary",
            "Description": "Product long summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_209ec9de02cf446fa00b0d79c4cc60d1": {
            "#name": "summary",
            "Description": "Product summary",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_b388e3da742c425d975b0505dd17d0a3": {
            "#name": "smallIconUri",
            "Description": "URI to the small product icon",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_f21fef0d2acf4cab8709fe841cb8954b": {
            "#name": "description",
            "Description": "The product description text",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_f5653e9d0c3f4720998125b2b59842d5": {
            "#name": "cspLegalTermsUri",
            "Description": "The legal terms of the product for the CSP",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_d73456ccf6cd4796a9bdb9c2e5a4fddd": {
            "#name": "privacyPolicyUri",
            "Description": "The privacy policy of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_5d29ae3ef1fc4d6689d2ad7d80561d50": {
            "#name": "ratingBuckets",
            "Description": "Categorizes products by customer rating thresholds for marketplace filtering and discovery.\n- `AboveOne` - Products with customer ratings exceeding 1.0 stars based on marketplace reviews\n- `AboveTwo` - Products with customer ratings exceeding 2.0 stars based on marketplace reviews\n- `AboveThree` - Products with customer ratings exceeding 3.0 stars based on marketplace reviews\n- `AboveFour` - Products with customer ratings exceeding 4.0 stars based on marketplace reviews",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_a69dfb6b02c748169ed63fb1182bffb7": {
            "#name": "ratingAverage",
            "Description": "Average rating for the offer",
            "Format": "double",
            "Required": false,
            "Type": "number"
          }
        },
        {
          "@added_dbd14f5b4e514b8e980fec982913d23a": {
            "#name": "ratingCount",
            "Description": "Total number of ratings for the offer",
            "Format": "int32",
            "Required": false,
            "Type": "integer"
          }
        },
        {
          "@added_8cb538fde5e24dab9ff7106feb26bf55": {
            "#name": "supportedProducts",
            "Description": "Maps to the list of compatible products",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_d572fa4219714a49b1ecc5dfcf102c4e": {
            "#name": "applicableProducts",
            "Description": "Product categories the offer belongs to",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_795e1d04ee714d558718839172c2d813": {
            "#name": "lastModifiedDateTime",
            "Description": "Latest update date of the product",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_ecd00af43e564c588ec3db0dc5b493ed": {
            "#name": "locations",
            "Description": "List of locations which are available on the SKUs",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          }
        },
        {
          "@added_e6004866aacd46e89d33bf678979587a": {
            "#name": "serviceFamily",
            "Description": "The service family of the product, such as 'Compute'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "@added_94292d25578f4a7e838a911de17cf74e": {
            "#name": "service",
            "Description": "The service name of the product, such as 'Virtual Machines'",
            "Required": false,
            "Type": "string"
          }
        },
        {
          "#name": "productId",
          "Required": {
            "new": false,
            "old": true
          }
        },
        {
          "@added_6d0695a565834a32ad98303a5e8cee02": {
            "#name": "hasRiPlans",
            "Description": "Indication whether the product has plans with reservations",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_500423f8902a49979512be08073b5b56": {
            "#name": "hasMarketplaceFootprint",
            "Description": "Indication if product has a representation in the marketplace",
            "Required": false,
            "Type": "boolean"
          }
        },
        {
          "@added_7a8047b88e36417d806c995a33659606": {
            "#name": "attributes",
            "Description": "Set of products attributes",
            "Required": false,
            "Type": "array",
            "$items": {
              "Description": "Represents a SKU attribute, which consists of a key and value. The attributes may differ across various services.",
              "Type": "object",
              "$properties": [
                {
                  "#name": "key",
                  "Description": "The attribute key",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "value",
                  "Description": "The attribute value",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        },
        {
          "plans": {
            "Description": {
              "new": "Returns the full set of Plan attributes",
              "old": "Returns a subset of Plan attributes"
            },
            "$properties": {
              "@added_a9d186c680b249e0aa7c0358bf1d5a6c": {
                "#name": "planId",
                "Description": "Plan identifier",
                "Required": false,
                "Type": "string"
              },
              "@added_6e64e7ce9ff44cf18694ff64d371c616": {
                "#name": "uniquePlanId",
                "Description": "Unique plan identifier which is prefixed by combining uniqueProductId and PlanId with no separator in between",
                "Required": false,
                "Type": "string"
              },
              "@added_30cfdb97f04c4a59a1f37288e7bd572d": {
                "#name": "displayName",
                "Description": "Display name of the plan / sku",
                "Required": false,
                "Type": "string"
              },
              "@added_0e1cc89f1b38447094ca9b087405dac6": {
                "#name": "vmArchitectureType",
                "Description": "Specifies the virtual machine processor architecture and generation. Applies exclusively to Virtual Machine product types.\n- `X64Gen1` - x64 processor architecture with Generation 1 virtual machine firmware and BIOS support\n- `X64Gen2` - x64 processor architecture with Generation 2 virtual machine firmware and UEFI support\n- `Arm64` - ARM 64-bit processor architecture optimized for energy efficiency and cloud-native workloads",
                "Required": false,
                "Type": "string"
              },
              "@added_6d59471b42e04588bb436739483ca433": {
                "#name": "cspState",
                "Description": "Controls plan availability and partner access within the Microsoft Cloud Solution Provider (CSP) program.\n- `OptIn` - Enables all authorized Cloud Solution Provider partners to resell and deploy the product to customers\n- `OptOut` - Excluded from Cloud Solution Provider program, available only through direct channels\n- `SelectiveOptIn` - Available only to selected Cloud Solution Provider partners for resale and customer deployment",
                "Required": false,
                "Type": "string"
              },
              "@added_0f8315b33dcc4a0fafd9b714913df1d5": {
                "#name": "metadata",
                "Description": "Expanded plan/SKU metadata.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "generation",
                    "Description": "The VM image generation (applicable to Virtual Machine products only)",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "altStackReference",
                    "Description": "Pointing to a planId which holds the alternative stack reference",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_ea936ecdc96b4ce6bf090f723606cce0": {
                "#name": "altStackReference",
                "Description": "Alternative stack reference",
                "Required": false,
                "Type": "string"
              },
              "@added_de1147e0de954d1eaa4816fde88f7a35": {
                "#name": "stackType",
                "Description": "Stack type : Classic, Gen1, Gen2",
                "Required": false,
                "Type": "string"
              },
              "@added_bf5d9778c4c94ee081c802c399b1ff83": {
                "#name": "altArchitectureReference",
                "Description": "The alternative architecture reference",
                "Required": false,
                "Type": "string"
              },
              "@added_af4978eaad0045dd99c6e060ff76ae33": {
                "#name": "categoryIds",
                "Description": "Plan CategoryIds",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_4b3d2ec88f954073a119964c462ddceb": {
                "#name": "hasProtectedArtifacts",
                "Description": "Set to true if plan has artifacts that are to be hidden for non authenticated users",
                "Required": false,
                "Type": "boolean"
              },
              "@added_24557a1f567b4ce4913ef21d48e76435": {
                "#name": "pricingTypes",
                "Description": "Indicates the billing models and cost structures available for the plan.\n- `Free` - No charge for plan usage, typically for community editions or basic service tiers\n- `FreeTrial` - Time-limited free access period before transitioning to paid billing model\n- `Byol` - Bring Your Own License model where customers provide existing software licenses\n- `Payg` - Pay As You Go consumption-based billing calculated on actual resource usage\n- `Ri` - Reserved Instance billing with upfront commitment for discounted long-term pricing",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_e8a005836e204f98a565b0018a849d49": {
                "#name": "vmSecuritytypes",
                "Description": "Defines the security enhancement level for virtual machine deployments. Applies exclusively to Virtual Machine product types.\n- `None` - Standard virtual machine security without additional protection features\n- `Trusted` - Trusted Launch security with secure boot and virtual Trusted Platform Module capabilities\n- `Confidential` - Confidential computing with memory encryption and attestation for sensitive workloads",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              "@added_6d849f4a92484252b66c53c6b38dac8c": {
                "#name": "summary",
                "Description": "The plan summary text",
                "Required": false,
                "Type": "string"
              },
              "@added_13fc33bcff6a480cb283a1cb51e57ea7": {
                "#name": "description",
                "Description": "Plan / sku description",
                "Required": false,
                "Type": "string"
              },
              "@added_56891afc21b04b8cbb00572836407901": {
                "#name": "skuId",
                "Description": "The SKU id",
                "Required": false,
                "Type": "string"
              },
              "@added_b9aa3a4e7d8f4d63901639f38dff369e": {
                "#name": "planType",
                "Description": "Specifies the primary deployment model and hosting architecture for the marketplace product. Currently supported values are:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `DevService` - Development-focused services and tools for software creation workflows\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `VisualStudioExtension` - Extensions that integrate with Visual Studio IDE functionality\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels",
                "Required": true,
                "Type": "string"
              },
              "@added_a255602d52b44b9f8ecca41dd7fc3a88": {
                "#name": "displayRank",
                "Description": "The order the plan is displayed in the 'Plans' table",
                "Required": false,
                "Type": "string"
              },
              "@added_62d77d71bf5c4a1a9620a45c7e1296fd": {
                "#name": "isPrivate",
                "Description": "Indication that the plan is accessible to restricted audience only",
                "Required": false,
                "Type": "boolean"
              },
              "@added_fed89abf8fae4f598632eef0cb84f8f4": {
                "#name": "hasRi",
                "Description": "Indication whether the SKU supports reservations",
                "Required": false,
                "Type": "boolean"
              }
            }
          }
        }
      ]
    }
  }
}

⚼ 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: - `DirectCommercial` - Available through direct Azure Marketplace purchases for commercial customers without intermediaries like partners or resellers - `PartnerCommercial` - 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 ,
}
,
}