Products (stable:2025-05-01)

⚶ Changes

{
  "#id": "GetProduct",
  "$responses": {
    "200": {
      "$properties": {
        "@added_71585ae8af79457dbb1a8a95ece1c950": {
          "#name": "displayName",
          "Description": "Product display name",
          "Required": false,
          "Type": "string"
        },
        "@added_ab90e1544b1f43a1a0a6628c81f4e0ca": {
          "#name": "popularity",
          "Description": "Popularity of the product",
          "Format": "double",
          "Required": false,
          "Type": "number"
        },
        "@added_2985cb923c4847ca824a00bc7d1a3993": {
          "#name": "categoryIds",
          "Description": "Identifiers of categories associated with the product. Used for classification, filtering, and product discovery",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_12453864432f4803ac79284b3f21e526": {
          "#name": "industryIds",
          "Description": "Identifiers of industries associated with the product. Used for classification, filtering, and product discovery",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_777850be61e3437e83e57d9237c975e7": {
          "#name": "publisherId",
          "Description": "Publisher id",
          "Required": false,
          "Type": "string"
        },
        "@added_bd518086d31b409bbb1662ab84f2b072": {
          "#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_15674d51bdf241bcab8f2c2732196d92": {
          "#name": "badges",
          "Description": "Displays certification and qualification badges earned by the product for marketplace visibility",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_42825a5556bd4441a05a10fa8f618798": {
          "#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_77096dfb507741dd95e30f35814445b8": {
          "#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_fae06f76b19a482295e41cdcec0ddcbb": {
          "#name": "uniqueProductId",
          "Description": "Unique product identifier",
          "Required": true,
          "Type": "string"
        },
        "@added_840e2e55ee8548e89b28906e6ef224cc": {
          "#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_ef58ad250ca943aaa49fa77dbb75d241": {
          "#name": "productSubType",
          "Description": "Product sub type",
          "Required": false,
          "Type": "string"
        },
        "@added_0ab02e20891446cd8b9ad683bbc5471f": {
          "#name": "productFamily",
          "Description": "Product Family",
          "Required": false,
          "Type": "string"
        },
        "@added_68ee02b53fad461c888fee928c0065e8": {
          "#name": "operatingSystems",
          "Description": "Operating system info for this product",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_c458375fe928448b8fb248a18343eb02": {
          "#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_97c3a949e2ac4c5db8e93c2649c56714": {
          "#name": "publisherDisplayName",
          "Description": "Publisher display name",
          "Required": false,
          "Type": "string"
        },
        "@added_6f80767633054c8a883a672a74875ca3": {
          "#name": "longSummary",
          "Description": "Product long summary",
          "Required": false,
          "Type": "string"
        },
        "@added_0fb90716f3984b29be37841729752ac0": {
          "#name": "summary",
          "Description": "Product summary",
          "Required": false,
          "Type": "string"
        },
        "@added_e8cbbcfbe9a247e285a0bc07860c72c2": {
          "#name": "linkedAddInsTypes",
          "Description": "Linked add-in types",
          "Required": false,
          "Type": "object"
        },
        "@added_3d2eb81703c847d886cd04f020a11715": {
          "#name": "smallIconUri",
          "Description": "URI to the small product icon",
          "Required": false,
          "Type": "string"
        },
        "@added_9f8795b1d2854cf888cc572cd68adf98": {
          "#name": "description",
          "Description": "The product description text",
          "Required": false,
          "Type": "string"
        },
        "@added_92538973af8041d69b73dc30e2fa1e5e": {
          "#name": "cspLegalTermsUri",
          "Description": "The legal terms of the product for the CSP",
          "Required": false,
          "Type": "string"
        },
        "@added_10068945235d4742a3bf71eff82d0b77": {
          "#name": "privacyPolicyUri",
          "Description": "The privacy policy of the product",
          "Required": false,
          "Type": "string"
        },
        "@added_79cc8476f5a44201a367e7ea0562af41": {
          "#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_808c69e03838449a9d9124cf5f377887": {
          "#name": "ratingAverage",
          "Description": "Average rating for the offer",
          "Format": "double",
          "Required": false,
          "Type": "number"
        },
        "@added_c3c96f9a212748649d2b5f2a7ab1180a": {
          "#name": "ratingCount",
          "Description": "Total number of ratings for the offer",
          "Format": "int32",
          "Required": false,
          "Type": "integer"
        },
        "@added_015c9c530804478bb72b1ee827da2a1d": {
          "#name": "startingPrice",
          "Description": "Retail price of the product's cheapest plan",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "market",
              "Description": "The market for which the starting price is calculated",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "termUnits",
              "Description": "The terms pricing model units",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "meterUnits",
              "Description": "The meters pricing model units",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "minTermPrice",
              "Description": "Starting (minimal) terms price",
              "Format": "float",
              "Required": false,
              "Type": "number"
            },
            {
              "#name": "minMeterPrice",
              "Description": "Starting (minimal) meters price",
              "Format": "float",
              "Required": false,
              "Type": "number"
            },
            {
              "#name": "currency",
              "Description": "Currency for price",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_5ecbc442e1cf4053a8e08eda909378dc": {
          "#name": "supportedProducts",
          "Description": "Maps to the list of compatible products",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_d71483601bc34d7cbf00583e23c88555": {
          "#name": "applicableProducts",
          "Description": "Product categories the offer belongs to",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_ab97f9ee8448473e8c465e792cedaf72": {
          "#name": "lastModifiedDateTime",
          "Description": "Latest update date of the product",
          "Required": false,
          "Type": "string"
        },
        "@added_a9c3273bb9c34fa6bd3b4513f0b39be0": {
          "#name": "locations",
          "Description": "List of locations which are available on the SKUs",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_dbdd2d01e9414bcaa4783f64777f66a0": {
          "#name": "serviceFamily",
          "Description": "The service family of the product, such as 'Compute'",
          "Required": false,
          "Type": "string"
        },
        "@added_8a9dee47388a4d0eba99253b209e0643": {
          "#name": "service",
          "Description": "The service name of the product, such as 'Virtual Machines'",
          "Required": false,
          "Type": "string"
        },
        "@added_e5e57fa502a6484cbafe91297d311e5f": {
          "#name": "productId",
          "Description": "A unique commercial identifier used to reference a specific product in transactional operations such as purchases, invoicing, and metering. This Id  services entitlement validation, and billing across systems",
          "Required": false,
          "Type": "string"
        },
        "@added_0b196c1636b34794ad5460c15ad207c6": {
          "#name": "hasRiPlans",
          "Description": "Indication whether the product has plans with reservations",
          "Required": false,
          "Type": "boolean"
        },
        "@added_c9d00fa7eae847979b561a4ba5904d0d": {
          "#name": "hasMarketplaceFootprint",
          "Description": "Indication of whether product appears in Azure Marketplace",
          "Required": false,
          "Type": "boolean"
        },
        "@added_e06a6f95946d43ec967c923d90fc62f0": {
          "#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"
              }
            ]
          }
        },
        "@added_11a0219b977e4d669c351a9b0dc57414": {
          "#name": "activeDirectoryAppId",
          "Description": "Used to map SaaS apps to their Azure AD appIds",
          "Required": false,
          "Type": "string"
        },
        "plans": {
          "$properties": {
            "@added_4e71eb0cbc92411082029574e8e7d9d2": {
              "#name": "planId",
              "Description": "Plan identifier",
              "Required": false,
              "Type": "string"
            },
            "@added_7bccfc52761842e786dfdb29b2b970c9": {
              "#name": "uniquePlanId",
              "Description": "Unique plan Id which is prefixed by combining uniqueProductId and PlanId with no separator in between",
              "Required": false,
              "Type": "string"
            },
            "@added_d3e0f43bba1649c9b34197f5bdd8bfac": {
              "#name": "displayName",
              "Description": "Display name of the plan / sku",
              "Required": false,
              "Type": "string"
            },
            "@added_692e50a6d83349d0a6244805afa3b024": {
              "#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_fe8a763576154d3988c0993e0690843a": {
              "#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_78dedae66648436ca8d91900c0f07819": {
              "#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"
                },
                {
                  "#name": "relatedSkus",
                  "Description": "Other plans that may be related to this plan",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Description": "Pointing to a related SKU object",
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "sku",
                        "Description": "The related Sku",
                        "Required": false,
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "name",
                            "Description": "The Sku name",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "generation",
                            "Description": "The Sku generation",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "identity",
                            "Description": "The Sku identity",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      },
                      {
                        "#name": "relationType",
                        "Description": "Relation Type",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                }
              ]
            },
            "@added_384bf66a2f9747f6992349386c88c9a8": {
              "#name": "altStackReference",
              "Description": "Alternative stack reference",
              "Required": false,
              "Type": "string"
            },
            "@added_4d4b7d197621472f8a92869132eac181": {
              "#name": "stackType",
              "Description": "Stack type : Classic, Gen1, Gen2",
              "Required": false,
              "Type": "string"
            },
            "@added_d28a24d344ed4726973f04a8038aea6c": {
              "#name": "altArchitectureReference",
              "Description": "The alternative architecture reference",
              "Required": false,
              "Type": "string"
            },
            "@added_e321fe13c9124614a1611c4f200e5f31": {
              "#name": "categoryIds",
              "Description": "Plan CategoryIds",
              "Required": false,
              "Type": "array",
              "$items": {
                "Type": "string"
              }
            },
            "@added_a905dc608d7d4216a790e800cc386382": {
              "#name": "hasProtectedArtifacts",
              "Description": "Set to true if plan has artifacts that are to be hidden for non authenticated users",
              "Required": false,
              "Type": "boolean"
            },
            "@added_fe110bea77e146b7ae6139b4891b8a0e": {
              "#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_841198ff06f245bbbdcd7a1f055b63d3": {
              "#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_46a83c6c74c043598aa9457fb0d379bf": {
              "#name": "summary",
              "Description": "The plan summary text",
              "Required": false,
              "Type": "string"
            },
            "@added_f1e2c91216c2421b910e16e89a44724a": {
              "#name": "description",
              "Description": "Plan / sku description",
              "Required": false,
              "Type": "string"
            },
            "@added_08f4b272cae04ca9a963bf65734d0572": {
              "#name": "skuId",
              "Description": "The SKU id",
              "Required": false,
              "Type": "string"
            },
            "@added_b86a9f8cb136451da0b38cd96d6f24cf": {
              "#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_4def0ca38cd34abcaae9c7a680e7dc5d": {
              "#name": "displayRank",
              "Description": "The order the plan is displayed in the 'Plans' table. Note that lower numbers appear first.",
              "Required": false,
              "Type": "string"
            },
            "@added_f135317282574da4b26260b51d64e2e8": {
              "#name": "isPrivate",
              "Description": "Indication that the plan is accessible to restricted audience only",
              "Required": false,
              "Type": "boolean"
            },
            "@added_ec25edda94b9420ebd99110a02203572": {
              "#name": "hasRi",
              "Description": "Indication whether the SKU supports reservations",
              "Required": false,
              "Type": "boolean"
            }
          }
        }
      }
    }
  }
}