Get Product - Get Product
Recupera un singolo prodotto in base all'ID dal catalogo del marketplace
GET https://catalogapi.azure.com/products/{uniqueProductId}?api-version=2025-05-01&market={market}
GET https://catalogapi.azure.com/products/{uniqueProductId}?api-version=2025-05-01&market={market}&language={language}&locations={locations}&includeStopSoldPlans={includeStopSoldPlans}&hideKeys={hideKeys}&excludeSkuDetails={excludeSkuDetails}&includeFutureAvailabilities={includeFutureAvailabilities}&skuId={skuId}
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
unique
|
path | True |
string |
Identificatore univoco del prodotto |
|
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
|
market
|
query | True |
string |
Valore di mercato del prodotto. La risposta includerà piani/disponibilità che possono essere venduti nel mercato specificato. Basato sul formato ISO-3166. I valori possibili possono essere trovati in https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Esempio: "Stati Uniti" |
|
exclude
|
query |
boolean |
Indica se escludere i dettagli dello SKU nella risposta. Per impostazione predefinita, excludeSkuDetails è impostato su FALSE |
|
|
hide
|
query |
string[] |
Questa chiave viene usata per recuperare i prodotti di anteprima e viene generata all'interno del Centro per i partner durante il processo di pubblicazione dell'offerta |
|
|
include
|
query |
boolean |
Indica se includere nella risposta i piani/disponibilità SKU del prodotto con date future. Per impostazione predefinita, includeFutureAvailabilities è impostato su FALSE |
|
|
include
|
query |
boolean |
Indica se includere nella risposta i piani/SKU del prodotto che non sono più disponibili per l'acquisto. Per impostazione predefinita, includeStopSoldPlans è impostato su FALSE |
|
|
language
|
query |
string |
Lingua da cercare, codice ISO 639-1 a due lettere, valori possibili - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Il valore predefinito è "en" |
|
|
locations
|
query |
string[] |
Restituisci piani/disponibilità per la località selezionata. Per altre informazioni sulle aree dei data center di Azure, vedere: https://azure.microsoft.com/regions/ |
|
|
sku
|
query |
string |
Applica il filtro ID SKU al risultato |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| X-API-Key | True |
string |
Utilizzare la chiave fornita dal team del catalogo del Marketplace come parametro fornito nell'intestazione. I dettagli su come ottenere la chiave sono disponibili all'indirizzo https://aka.ms/DiscoveryAPI/keys |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta è andata a buon fine. |
|
| Other Status Codes |
Risposta di errore imprevista. |
Sicurezza
X-API-Key
Utilizzare la chiave fornita dal team del catalogo del Marketplace come parametro fornito nell'intestazione. I dettagli su come ottenere la chiave sono disponibili all'indirizzo https://aka.ms/DiscoveryAPI/keys
Tipo:
apiKey
In:
header
Esempio
| Example of request to get single SaaS product details |
| Example of request to get single VM product details |
Example of request to get single SaaS product details
Esempio di richiesta
GET https://catalogapi.azure.com/products/securescan.securescan-enterprise?api-version=2025-05-01&market=US&language=en&locations=eastus&includeStopSoldPlans=False&hideKeys=&excludeSkuDetails=False&includeFutureAvailabilities=False&skuId=
Risposta di esempio
{
"displayName": "CloudGuard Security Scanner",
"popularity": 4.8,
"categoryIds": [
"SecurityAndIdentity"
],
"industryIds": [
"Technology"
],
"publisherId": "securescan",
"azureBenefit": "Eligible",
"badges": [
"PreferredSolution",
"PowerBICertified",
"AdditionalPurchaseRequirement"
],
"publisherType": "ThirdParty",
"publishingStage": "Public",
"uniqueProductId": "securescan.securescan-enterprise",
"productType": "SaaS",
"productSubType": "SecurityAnalytics",
"productFamily": "Security",
"operatingSystems": [
"Linux"
],
"pricingTypes": [
"Payg"
],
"publisherDisplayName": "CloudGuard Security, Inc.",
"longSummary": "CloudGuard Security Scanner is an enterprise-grade cloud security solution that continuously monitors your cloud infrastructure for vulnerabilities, misconfigurations, and compliance violations. With real-time scanning, automated remediation suggestions, and comprehensive reporting, it helps organizations maintain a strong security posture across their cloud environments.",
"summary": "Enterprise cloud security scanner with continuous monitoring, compliance checking, and automated remediation guidance",
"videos": [
{
"caption": "CloudGuard Security Scanner Overview",
"uri": "https://www.youtube.com/watch?v=cloudguard-demo",
"videoPurpose": "trailer",
"previewImage": {
"caption": "Product Overview",
"uri": "https://www.cloudguard.com/media/preview-image.png",
"imagePurpose": "preview"
}
}
],
"images": [
{
"context": "screenshots",
"items": [
{
"id": "dashboard",
"uri": "https://www.cloudguard.com/screenshots/dashboard.png",
"type": "screenshot"
}
]
}
],
"links": [
{
"id": "documentation",
"displayName": "Documentation",
"uri": "https://docs.cloudguard.com"
}
],
"linkedAddIns": [
"cloudguard-cli:latest"
],
"linkedAddInsTypes": {
"cli": "Command Line Interface"
},
"additionalProductProperties": {
"complianceStandards": "PCI-DSS,HIPAA,SOC2,ISO27001",
"deploymentMode": "Automated",
"customField": "value"
},
"smallIconUri": "https://www.cloudguard.com/icons/small.png",
"description": "CloudGuard Security Scanner provides comprehensive cloud security monitoring and compliance management for enterprises. Key features include:\n\n- Continuous Security Monitoring: Real-time scanning of cloud resources for security vulnerabilities\n- Compliance Management: Pre-built compliance templates for major standards (PCI DSS, HIPAA, SOC 2)\n- Automated Remediation: Smart suggestions for fixing security issues with one-click implementation\n- Custom Policies: Create and enforce organization-specific security policies\n- Integration Support: Works with major DevOps tools and CI/CD pipelines\n- Advanced Reporting: Detailed security insights and compliance reports\n\nOur solution helps organizations maintain security best practices while accelerating their cloud journey.",
"ratingBuckets": [
"AboveFour"
],
"ratingAverage": 4.8,
"ratingCount": 245,
"activeDirectoryAppId": "someId",
"productLabels": [
"enterprise"
],
"plans": [
{
"planId": "pro",
"uniquePlanId": "securescan.securescan-enterprise-pro",
"displayName": "Professional",
"vmArchitectureType": null,
"cspState": "OptIn",
"metadata": {
"generation": "2023",
"altStackReference": "basic-tier",
"relatedSkus": [
{
"sku": {
"name": "basic",
"generation": "2023",
"identity": "cloudguard-scanner-basic"
},
"relationType": "upgrade-from"
}
]
},
"altStackReference": "basic-tier",
"stackType": "Gen2",
"altArchitectureReference": null,
"categoryIds": [
"SecurityAndIdentity",
"NetworkSecurity",
"CloudProtection"
],
"hasProtectedArtifacts": false,
"pricingTypes": [
"Payg"
],
"vmSecuritytypes": [],
"summary": "Advanced security features for growing organizations",
"description": "Professional-grade security scanning with advanced features and priority support",
"skuId": "pro-001",
"planType": "SaaS",
"displayRank": "2",
"isPrivate": false,
"id": "pro-plan-001",
"version": "2.1.0",
"isHidden": false,
"isStopSell": false,
"isQuantifiable": true,
"isHiddenPrivateOffer": false,
"certifications": [
{
"id": "iso27001",
"displayName": "ISO 27001 Certified",
"uri": "https://www.cloudguard.com/certifications/iso27001"
}
],
"customerInstruction": "Contact support for enterprise deployment assistance",
"planLabels": [
"recommended",
"enterprise"
],
"hasRi": true,
"skuType": "Standard",
"skuTitle": "CloudGuard Pro Scanner",
"location": "Global",
"armRegionName": "global",
"cloud": "Public",
"locationType": "Global",
"region": "Global",
"skuGroupId": "cloudguard-scanner-group",
"zone": "Zone 1",
"feature": "SecurityScanning",
"serviceType": "SaaS",
"skuAttributes": [
{
"key": "MaxScansPerMonth",
"value": "10000"
},
{
"key": "SupportLevel",
"value": "Premium"
}
],
"skuProperties": {
"category": "Security",
"dataDiskType": null,
"diskType": null,
"numberOfCores": null,
"ram": null,
"vCpu": null,
"armSkuName": "cloudguard-pro",
"accessTier": "Standard"
},
"billingComponents": [
{
"billingTag": "enterprise-scanner",
"customMeterIds": {
"scanOperations": [
1001,
1002
]
}
}
],
"purchaseDurationDiscounts": [
{
"duration": "P1Y",
"discountPercentage": 20
}
],
"availabilities": [
{
"id": "pro-payg",
"actions": [
"Purchase",
"Trial"
],
"meter": {
"meterId": "scan-meter-001",
"partNumber": "CGSCAN-PRO-001",
"consumptionResourceId": "cloudguard-scanner-pro",
"price": {
"currencyCode": "USD",
"isPiRequired": true,
"listPrice": 0.1,
"msrp": 0.12
},
"type": "usage",
"includedQuantityProperties": [
{
"termId": "monthly",
"quantity": "100"
}
]
},
"pricingAudience": "Direct-Commercial",
"terms": [
{
"termId": "monthly",
"termUnit": "P1M",
"termDescription": "Monthly subscription",
"prorationPolicy": {
"minimumProratedUnits": "P1D"
},
"price": {
"currencyCode": "USD",
"isPiRequired": true,
"listPrice": 99.99,
"msrp": 119.99
},
"renewTermId": "monthly",
"renewTermUnits": "P1M",
"billingPlan": {
"billingPeriod": "P1M",
"title": "Monthly Billing",
"description": "Billed monthly with usage charges",
"price": {
"currencyCode": "USD",
"isPiRequired": true,
"listPrice": 99.99,
"msrp": 119.99
}
},
"isAutorenewable": true,
"termDescriptionParameters": [
{
"parameter": "scanCount",
"value": "1000"
},
{
"parameter": "retention",
"value": "30 days"
}
],
"renewToTermBillingPlan": "pro-monthly-renewed"
}
],
"hasFreeTrials": true,
"consumptionUnitType": "scan",
"displayRank": 1
}
],
"planArtifactsVersion": "2.1.0-stable"
}
],
"supportedProducts": [
"azure-devops"
],
"applicableProducts": [
"azure-kubernetes-service"
],
"lastModifiedDateTime": "2025-05-01T10:00:00.0000000+00:00",
"locations": [
"eastus"
],
"serviceFamily": "Security",
"service": "SecurityServices",
"productId": "cloudguard-scanner-2025",
"hasMarketplaceFootprint": true,
"attributes": [
{
"key": "ComplianceFrameworks",
"value": "PCI-DSS,HIPAA,SOC2,ISO27001"
}
],
"language": "en",
"hasStandardContractAmendments": true,
"offerId": "cloudguard-security-scanner",
"standardContractAmendmentsRevisionId": "2025-05-01-rev1",
"universalAmendmentUrl": "https://www.cloudguard.com/legal/universal-amendment",
"isPrivate": false,
"isStopSell": false,
"legalTermsUri": "https://www.cloudguard.com/legal/terms",
"cspLegalTermsUri": "https://www.cloudguard.com/legal/csp-terms",
"legalTermsType": "EA",
"privacyPolicyUri": "https://www.cloudguard.com/legal/privacy",
"supportUri": "https://support.cloudguard.com",
"uiDefinitionUri": "https://www.cloudguard.com/setup/ui-definition",
"pricingDetailsUri": "https://www.cloudguard.com/pricing",
"mediumIconUri": "https://www.cloudguard.com/icons/medium.png",
"largeIconUri": "https://www.cloudguard.com/icons/large.png",
"wideIconUri": "https://www.cloudguard.com/icons/wide.png",
"isReseller": false,
"productOwnershipSellingMotion": "3PPAgency",
"disableSendEmailOnPurchase": false,
"isCoreVm": false,
"stopSellInfo": null,
"marketingMaterial": {
"path": "https://www.cloudguard.com/resources",
"learnUri": "https://learn.cloudguard.com"
},
"screenshotUris": [
"https://www.cloudguard.com/screenshots/dashboard.png",
"https://www.cloudguard.com/screenshots/reports.png"
],
"hasRiPlans": true,
"artifacts": [
{
"artifactType": "Template"
}
],
"startingPrice": {
"market": "US",
"termUnits": "P1M",
"meterUnits": "scan",
"minTermPrice": 99.99,
"minMeterPrice": 0.1,
"currency": "USD"
},
"productCustomData": "{\"additionalMetadata\": {\"supportTiers\": [\"Basic\", \"Premium\", \"Enterprise\"]}}",
"serviceId": "cloudguard-security-service-001"
}
Example of request to get single VM product details
Esempio di richiesta
GET https://catalogapi.azure.com/products/testpublisher.publisher-enterprise-linux-2025?api-version=2025-05-01&market=US&language=en&locations=eastus,westus2,northeurope&includeStopSoldPlans=False&hideKeys=&excludeSkuDetails=False&includeFutureAvailabilities=False&skuId=
Risposta di esempio
{
"displayName": "Enterprise Linux Server 2025",
"popularity": 4.2,
"categoryIds": [
"compute",
"virtualization",
"linux"
],
"industryIds": [
"technology",
"manufacturing",
"retail"
],
"publisherId": "testpublisher",
"azureBenefit": "Eligible",
"badges": [
"PreferredSolution"
],
"publisherType": "ThirdParty",
"publishingStage": "Public",
"uniqueProductId": "testpublisher.publisher-enterprise-linux-2025",
"productType": "VirtualMachine",
"productSubType": "LinuxServer",
"productFamily": "Compute",
"operatingSystems": [
"linux.ubuntu.22.04",
"linux.rhel.9"
],
"pricingTypes": [
"Payg",
"Ri"
],
"publisherDisplayName": "Enterprise Software Solutions",
"longSummary": "Enterprise Linux Server 2025 is a high-performance, secure virtual machine solution optimized for enterprise workloads. Built on the latest Linux distributions, it offers enhanced security features, automated patching, and performance monitoring capabilities. Ideal for running mission-critical applications, containerized workloads, and scalable microservices.",
"summary": "High-performance Linux VM with advanced security features and enterprise support",
"videos": [
{
"caption": "Product Overview",
"uri": "https://example.com/videos/linux-server-demo",
"videoPurpose": "Overview",
"previewImage": {
"caption": "Overview Thumbnail",
"uri": "https://example.com/videos/thumbnails/overview.png",
"imagePurpose": "Thumbnail"
}
}
],
"images": [
{
"context": "screenshots",
"items": [
{
"id": "dashboard",
"uri": "https://example.com/vm/dashboard.png",
"type": "Screenshot"
},
{
"id": "monitoring",
"uri": "https://example.com/vm/monitoring.png",
"type": "Screenshot"
}
]
}
],
"links": [
{
"id": "documentation",
"displayName": "Documentation",
"uri": "https://docs.example.com/enterprise-linux"
},
{
"id": "quickstart",
"displayName": "Quick Start Guide",
"uri": "https://docs.example.com/enterprise-linux/quickstart"
}
],
"linkedAddIns": [
"monitoring-agent:latest",
"backup-agent:latest"
],
"linkedAddInsTypes": {
"monitoring": "Performance Monitoring",
"backup": "Automated Backup"
},
"additionalProductProperties": {
"patchingSchedule": "Weekly",
"backupRetention": "30 days",
"monitoringInterval": "5 minutes"
},
"smallIconUri": "https://example.com/vm/icons/small.png",
"description": "Enterprise Linux Server 2025 delivers a robust virtual machine platform designed for modern enterprise workloads. Key features include:\n\n- High-Performance Computing: Optimized kernel configurations for maximum performance\n- Enhanced Security: Built-in security features including SELinux and automated security updates\n- Monitoring & Analytics: Integrated performance monitoring and diagnostic tools\n- Enterprise Support: 24/7 technical support with guaranteed response times\n- Compliance Ready: Pre-configured security baselines for various compliance standards\n- Automatic Updates: Scheduled security patches and system updates\n- Resource Optimization: Advanced resource scheduling and power management\n\nIdeal for organizations requiring a secure, reliable, and high-performance Linux environment.",
"ratingBuckets": [
"AboveFour"
],
"ratingAverage": 4.2,
"ratingCount": 156,
"activeDirectoryAppId": "someId",
"mixProductId": "MIX-VM-LINUX-001",
"plans": [
{
"planId": "standard-gen2",
"uniquePlanId": "testpublisher.publisher-enterprise-linux-2025-standard-gen2",
"displayName": "Standard Gen2",
"vmArchitectureType": "X64Gen2",
"cspState": "OptIn",
"metadata": {
"generation": "Gen2",
"altStackReference": "standard-gen1"
},
"altStackReference": "standard-gen1",
"stackType": "Gen2",
"altArchitectureReference": "standard-gen1-x64",
"categoryIds": [
"compute",
"enterprise"
],
"hasProtectedArtifacts": false,
"pricingTypes": [
"Payg",
"Ri"
],
"vmSecuritytypes": [
"Trusted",
"Confidential"
],
"summary": "Enterprise-grade VM with Gen2 architecture and enhanced security",
"description": "Standard Gen2 configuration optimized for enterprise workloads with advanced security features",
"skuId": "ent-std-gen2",
"planType": "VirtualMachine",
"displayRank": "1",
"isPrivate": false,
"id": "vm-plan-std-gen2",
"version": "1.0.0",
"isHidden": false,
"isStopSell": false,
"isQuantifiable": true,
"isHiddenPrivateOffer": false,
"certifications": [
{
"id": "azure-certified",
"displayName": "Azure Certified VM",
"uri": "https://example.com/certifications/azure-vm"
}
],
"customerInstruction": "Select appropriate VM size based on your workload requirements",
"planLabels": [
"standard",
"gen2",
"enterprise"
],
"hasRi": true,
"skuType": "Standard",
"skuTitle": "Enterprise Linux Standard Gen2",
"location": "eastus",
"armRegionName": "eastus",
"cloud": "Public",
"locationType": "Region",
"region": "East US",
"skuGroupId": "enterprise-linux-group",
"zone": "Zone 1",
"feature": "Standard",
"serviceType": "VirtualMachine",
"skuAttributes": [
{
"key": "vmSize",
"value": "Standard_D2s_v3"
},
{
"key": "cores",
"value": "2"
},
{
"key": "ram",
"value": "8GB"
},
{
"key": "diskType",
"value": "Premium_LRS"
},
{
"key": "networkAccelerated",
"value": "true"
}
],
"skuProperties": {
"category": "Compute",
"dataDiskType": "Premium_LRS",
"diskType": "Premium_LRS",
"numberOfCores": "2",
"ram": "8GB",
"vCpu": "2",
"armSkuName": "Standard_D2s_v3",
"accessTier": "Standard"
},
"offeringProperties": [
{
"productCode": "ENTLINUX-STD-GEN2",
"termId": "hourly",
"meterType": "compute",
"billingMeterId": "vm-compute-meter",
"offeringId": "enterprise-linux-std-offering",
"type": "Consumption"
}
],
"billingComponents": [
{
"billingTag": "compute",
"customMeterIds": {
"standard": [
1001,
1002
]
}
}
],
"availabilities": [
{
"id": "std-gen2-payg",
"actions": [
"Purchase",
"Trial"
],
"meter": {
"meterId": "std-gen2-compute",
"partNumber": "ENTLINUX-STD-GEN2",
"consumptionResourceId": "enterprise-linux-vm",
"price": {
"currencyCode": "USD",
"isPiRequired": true,
"listPrice": 0.12,
"msrp": 0.15
},
"type": "compute",
"includedQuantityProperties": []
},
"pricingAudience": "Direct-Commercial",
"hasFreeTrials": true,
"consumptionUnitType": "Hour",
"displayRank": 1
}
],
"planArtifactsVersion": "1.0.0-stable"
}
],
"supportedProducts": [
"azure-monitor",
"azure-backup",
"azure-security-center"
],
"applicableProducts": [
"azure-kubernetes-service",
"azure-container-apps"
],
"lastModifiedDateTime": "2025-05-01T10:00:00.0000000+00:00",
"locations": [
"eastus",
"westus2",
"northeurope"
],
"serviceFamily": "Compute",
"service": "Virtual Machines",
"productId": "enterprise-linux-2025",
"hasRiPlans": true,
"hasMarketplaceFootprint": true,
"attributes": [
{
"key": "vmSize",
"value": "Standard_D2s_v3"
},
{
"key": "cores",
"value": "2"
},
{
"key": "ram",
"value": "8GB"
},
{
"key": "diskType",
"value": "Premium_LRS"
}
],
"language": "en",
"hasStandardContractAmendments": true,
"offerId": "enterprise-linux-server",
"standardContractAmendmentsRevisionId": "2025-05-01-rev1",
"universalAmendmentUrl": "https://example.com/legal/universal-amendment",
"isPrivate": false,
"isStopSell": false,
"legalTermsUri": "https://example.com/legal/terms",
"cspLegalTermsUri": "https://example.com/legal/csp-terms",
"legalTermsType": "EA",
"privacyPolicyUri": "https://example.com/privacy",
"supportUri": "https://support.example.com/enterprise-linux",
"uiDefinitionUri": "https://example.com/vm/ui-definition",
"pricingDetailsUri": "https://example.com/vm/pricing",
"mediumIconUri": "https://example.com/vm/icons/medium.png",
"largeIconUri": "https://example.com/vm/icons/large.png",
"wideIconUri": "https://example.com/vm/icons/wide.png",
"isReseller": false,
"productOwnershipSellingMotion": "3PP",
"disableSendEmailOnPurchase": false,
"isCoreVm": false,
"marketingMaterial": {
"path": "https://example.com/vm/resources",
"learnUri": "https://learn.example.com/vm"
},
"screenshotUris": [
"https://example.com/vm/screenshots/dashboard.png",
"https://example.com/vm/screenshots/monitoring.png",
"https://example.com/vm/screenshots/security.png"
],
"artifacts": [
{
"name": "VM Image",
"uri": "https://example.com/vm/artifacts/image",
"artifactType": "Template"
}
],
"startingPrice": {
"market": "US",
"termUnits": "P1M",
"meterUnits": "Hour",
"minTermPrice": 0.12,
"minMeterPrice": 0.12,
"currency": "USD"
},
"productCustomData": "{\"vmConfiguration\": {\"supportedRegions\": [\"eastus\", \"westus2\", \"northeurope\"]}}",
"serviceId": "enterprise-linux-vm-service-001"
}
Definizioni
| Nome | Descrizione |
|---|---|
| Artifact |
Pianificare le risorse a livello di database e i file di configurazione |
| Attribute |
Rappresenta un attributo SKU, costituito da una chiave e un valore. Gli attributi possono differire tra i vari servizi |
| Availability |
Disponibilità per un determinato piano |
|
Billing |
Rappresenta un modello di componente di fatturazione |
|
Billing |
Rinnova il piano di fatturazione |
|
Discovery |
Dettagli dell'errore restituiti in DiscoveryErrorPayload |
|
Discovery |
Payload di errore restituito dalle API di individuazione del marketplace |
| Image |
Include il link all'immagine del prodotto |
|
Image |
Elenco degli oggetti immagine |
|
Included |
Proprietà della quantità incluse |
|
Link |
Rappresenta un elemento di collegamento letto dal pacchetto di elementi della galleria |
|
Marketing |
Include collegamenti ai materiali di apprendimento e marketing configurati dall'editore |
|
Market |
Prezzo al dettaglio del piano più economico del prodotto |
| Meter |
Informazioni sul contatore di fatturazione applicabili |
|
Offering |
SKU proprietà correlate al prezzo |
|
Plan |
Restituisce l'insieme completo degli attributi del piano |
|
Plan |
Metadati aggiuntivi |
|
Plan |
Puntamento a un oggetto SKU correlato |
|
Preview |
Immagine di anteprima video |
| Price |
Prezzo al pubblico con valuta |
|
Product |
Restituisce l'insieme completo degli attributi del prodotto |
|
Product |
Video del prodotto |
|
Proration |
Definisce le regole per il calcolo degli addebiti o dei rimborsi ripartiti proporzionalmente per un abbonamento |
|
Purchase |
La percentuale di sconto per le prenotazioni di software di macchine virtuali di terze parti |
|
Related |
Oggetto SKU relativo a un determinato piano |
|
Sku |
Dati aggregati dal livello Sku del prodotto |
|
Sku |
Proprietà dell'oggetto SKU |
|
Stop |
Rappresenta un modello per le informazioni relative allo stop sell |
| Term |
Termine applicabile |
|
Term |
I parametri del termine descrizione |
Artifact
Pianificare le risorse a livello di database e i file di configurazione
| Nome | Tipo | Descrizione |
|---|---|---|
| artifactType |
string |
Definisce il tipo di risorsa artefatto e il relativo ruolo nel processo di distribuzione dell'offerta del marketplace.
|
| name |
string |
Nome dell'artefatto |
| uri |
string |
Uri artefatto |
Attribute
Rappresenta un attributo SKU, costituito da una chiave e un valore. Gli attributi possono differire tra i vari servizi
| Nome | Tipo | Descrizione |
|---|---|---|
| key |
string |
La chiave dell'attributo |
| value |
string |
Il valore dell'attributo |
Availability
Disponibilità per un determinato piano
| Nome | Tipo | Descrizione |
|---|---|---|
| actions |
string[] |
Elenco delle azioni consentite |
| consumptionUnitType |
string |
Tipo di unità di consumo |
| displayRank |
integer (int32) |
Mostra rango |
| hasFreeTrials |
boolean |
Un valore che indica se dispone di versioni di valutazione gratuite |
| id |
string |
L'ID del documento |
| meter |
Informazioni sul contatore di fatturazione applicabili |
|
| pricingAudience |
string |
Specifica il canale di distribuzione e il segmento di clienti per i prezzi e la disponibilità dei prodotti |
| terms |
Term[] |
Elenco dei termini applicabili |
BillingComponent
Rappresenta un modello di componente di fatturazione
| Nome | Tipo | Descrizione |
|---|---|---|
| billingTag |
string |
Tag di fatturazione |
| customMeterIds |
object |
ID contatore personalizzati |
BillingPlan
Rinnova il piano di fatturazione
| Nome | Tipo | Descrizione |
|---|---|---|
| billingPeriod |
string |
Periodo di fatturazione |
| description |
string |
Description |
| price |
Prezzo al pubblico con valuta |
|
| title |
string |
Titolo |
DiscoveryErrorDetails
Dettagli dell'errore restituiti in DiscoveryErrorPayload
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Codice di errore HTTP |
| message |
string |
Messaggio di errore |
DiscoveryErrorPayload
Payload di errore restituito dalle API di individuazione del marketplace
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
L'oggetto dei dettagli dell'errore |
Image
Include il link all'immagine del prodotto
| Nome | Tipo | Descrizione |
|---|---|---|
| id |
string |
ID immagine |
| type |
string |
Tipo di immagine |
| uri |
string |
Immagine uri |
ImageGroup
Elenco degli oggetti immagine
| Nome | Tipo | Descrizione |
|---|---|---|
| context |
string |
Contesto del gruppo di immagini |
| items |
Image[] |
Elenco delle immagini |
IncludedQuantityProperty
Proprietà della quantità incluse
| Nome | Tipo | Descrizione |
|---|---|---|
| quantity |
string |
Quantità |
| termId |
string |
ID termine |
LinkProperties
Rappresenta un elemento di collegamento letto dal pacchetto di elementi della galleria
| Nome | Tipo | Descrizione |
|---|---|---|
| displayName |
string |
Nome visualizzato del collegamento |
| id |
string |
ID del link |
| uri |
string |
Uri del link |
MarketingMaterial
Include collegamenti ai materiali di apprendimento e marketing configurati dall'editore
| Nome | Tipo | Descrizione |
|---|---|---|
| learnUri |
string |
Percorso del sito di apprendimento |
| path |
string |
Percorso del sito di marketing |
MarketStartPrice
Prezzo al dettaglio del piano più economico del prodotto
| Nome | Tipo | Descrizione |
|---|---|---|
| currency |
string |
Valuta per il prezzo |
| market |
string |
Il mercato per il quale viene calcolato il prezzo di partenza |
| meterUnits |
string |
Unità del modello di determinazione dei prezzi dei contatori |
| minMeterPrice |
number (float) |
Prezzo di partenza (minimo) dei contatori |
| minTermPrice |
number (float) |
Prezzo di partenza (minimo) |
| termUnits |
string |
I termini unità del modello di determinazione del prezzo |
Meter
Informazioni sul contatore di fatturazione applicabili
| Nome | Tipo | Descrizione |
|---|---|---|
| consumptionResourceId |
string |
ID risorsa di consumo |
| includedQuantityProperties |
Proprietà della quantità incluse |
|
| meterId |
string |
ID contatore |
| partNumber |
string |
Calcola il numero di parte |
| price |
Prezzo al pubblico con valuta |
|
| type |
string |
Tipo di questo contatore |
OfferingProperties
SKU proprietà correlate al prezzo
| Nome | Tipo | Descrizione |
|---|---|---|
| billingMeterId |
string |
L'ID del contatore di fatturazione |
| meterType |
string |
Il tipo di contatore |
| offeringId |
string |
L'ID dell'offerta |
| productCode |
string |
Il codice del prodotto (UPN) |
| termId |
string |
Il termine id |
| type |
string |
Diritto, consumo o prenotazione |
PlanDetails
Restituisce l'insieme completo degli attributi del piano
| Nome | Tipo | Descrizione |
|---|---|---|
| altArchitectureReference |
string |
Il riferimento all'architettura alternativa |
| altStackReference |
string |
Riferimento stack alternativo |
| armRegionName |
string |
Nome della regione Arm |
| artifacts |
Artifact[] |
File relativi all'elemento del marketplace |
| availabilities |
Elenco delle disponibilità per questo piano |
|
| billingComponents |
Componenti di fatturazione Pan |
|
| categoryIds |
string[] |
Pianificare CategoryIds |
| certifications |
Elenco delle certificazioni |
|
| cloud |
string |
Cloud applicabile, ad esempio "Globale" |
| cspState |
string |
Controlla la disponibilità del piano e l'accesso dei partner all'interno del programma Microsoft Cloud Solution Provider (CSP).
|
| customerInstruction |
string |
Istruzioni per il cliente del piano per l'acquisto |
| description |
string |
Descrizione del piano / sku |
| displayName |
string |
Nome visualizzato del piano/SKU |
| displayRank |
string |
L'ordine in cui il piano viene visualizzato nella tabella "Planimetrie". Si noti che i numeri più bassi vengono visualizzati per primi. |
| feature |
string |
La funzione, come "Spot" |
| hasProtectedArtifacts |
boolean |
Impostare su true se il piano contiene elementi che devono essere nascosti per gli utenti non autenticati |
| hasRi |
boolean |
Indicazione se lo SKU supporta le prenotazioni |
| id |
string |
L'id |
| isHidden |
boolean |
Indica se un prodotto è nascosto |
| isHiddenPrivateOffer |
boolean |
Un valore che indica se il piano viene utilizzato come offerta privata nascosta che richiede un preventivo |
| isPrivate |
boolean |
Indicazione che il piano è accessibile solo a un pubblico ristretto |
| isQuantifiable |
boolean |
Un valore che indica se il piano è quantificabile |
| isStopSell |
boolean |
Indica se un piano non è più disponibile per la vendita |
| location |
string |
Ubicazione SKU |
| locationType |
string |
Il tipo di località, ad esempio "Regione" |
| metadata |
Metadati del piano/SKU espansi |
|
| offeringProperties |
SKU proprietà correlate al prezzo |
|
| planArtifactsVersion |
string |
Versione degli artefatti di Plan |
| planId |
string |
Identificatore del piano |
| planLabels |
string[] |
Pianificare le etichette |
| planType |
string |
Specifica il modello di distribuzione principale e l'architettura di hosting per il prodotto del marketplace. I valori attualmente supportati sono:
|
| pricingTypes |
string[] |
Indica i modelli di fatturazione e le strutture dei costi disponibili per il piano.
|
| purchaseDurationDiscounts |
Elenco degli sconti sulla durata dell'acquisto |
|
| region |
string |
La regione |
| serviceType |
string |
Il tipo di servizio |
| skuAttributes |
Set di attributi SKU (varia in base al tipo di SKU), in cui ogni attributo è rappresentato da una coppia di chiavi (nome dell'attributo) e value (valore dell'attributo) |
|
| skuGroupId |
string |
L'ID del gruppo sku |
| skuId |
string |
L'ID SKU |
| skuProperties |
Proprietà SKU |
|
| skuTitle |
string |
Titolo SKU localizzato |
| skuType |
string |
Tipo SKU |
| stackType |
string |
Tipo di stack : Classic, Gen1, Gen2 |
| stopSellInfo |
Un oggetto StopSellInfo che fornisce dati correlati allo stop sell |
|
| summary |
string |
Il testo riassuntivo del piano |
| uiDefinitionUri |
string |
Quale pannello aprire quando un utente desidera creare un elemento del marketplace |
| uniquePlanId |
string |
ID piano univoco preceduto dalla combinazione di uniqueProductId e PlanId senza separatori intermedi |
| version |
string |
Versione dell'elemento del marketplace |
| vmArchitectureType |
string |
Specifica l'architettura e la generazione del processore della macchina virtuale. Si applica esclusivamente ai tipi di prodotto Macchina virtuale.
|
| vmSecuritytypes |
string[] |
Definisce il livello di miglioramento della sicurezza per le distribuzioni di macchine virtuali. Si applica esclusivamente ai tipi di prodotto Macchina virtuale.
|
| zone |
string |
La zona, ad esempio "Zona 1" |
PlanMetadata
Metadati aggiuntivi
| Nome | Tipo | Descrizione |
|---|---|---|
| altStackReference |
string |
Puntamento a un planId che contiene il riferimento allo stack alternativo |
| generation |
string |
La generazione dell'immagine della macchina virtuale (applicabile solo ai prodotti Virtual Machine) |
| relatedSkus |
Altri piani che possono essere correlati a questo piano |
PlanSkuRelation
Puntamento a un oggetto SKU correlato
| Nome | Tipo | Descrizione |
|---|---|---|
| relationType |
string |
Tipo di relazione |
| sku |
Il relativo Sku |
PreviewImage
Immagine di anteprima video
| Nome | Tipo | Descrizione |
|---|---|---|
| caption |
string |
Anteprima didascalia immagine |
| imagePurpose |
string |
Scopo dell'anteprima dell'immagine |
| uri |
string |
Anteprima immagine uri |
Price
Prezzo al pubblico con valuta
| Nome | Tipo | Descrizione |
|---|---|---|
| currencyCode |
string |
Codice valuta, ad esempio "USD" |
| isPiRequired |
boolean |
Un valore che indica se è necessario uno strumento di pagamento |
| listPrice |
number (float) |
Prezzo di vendita al pubblico dell'articolo |
| msrp |
number (float) |
Prezzo di vendita al dettaglio suggerito dal produttore per l'articolo |
ProductDetails
Restituisce l'insieme completo degli attributi del prodotto
| Nome | Tipo | Descrizione |
|---|---|---|
| activeDirectoryAppId |
string |
Usato per eseguire il mapping delle app SaaS agli appId di Azure AD |
| additionalProductProperties |
object |
Dizionario delle proprietà aggiuntive fornite per l'elemento |
| applicableProducts |
string[] |
Categorie di prodotti a cui appartiene l'offerta |
| artifacts |
Artifact[] |
Elenco degli artefatti |
| attributes |
Set di attributi dei prodotti |
|
| azureBenefit |
string |
Indica se gli acquisti di prodotti vengono conteggiati ai fini dei vantaggi dell'impegno di consumo di Azure per i clienti aziendali.
|
| badges |
string[] |
Mostra i badge di certificazione e qualifica ottenuti dal prodotto per la visibilità sul marketplace |
| categoryIds |
string[] |
Identificatori delle categorie associate al prodotto. Utilizzato per la classificazione, il filtraggio e l'individuazione dei prodotti |
| cspLegalTermsUri |
string |
Condizioni legali del prodotto per il CSP |
| description |
string |
Il testo della descrizione del prodotto |
| disableSendEmailOnPurchase |
boolean |
Indicazione per disabilitare l'invio di email all'acquisto |
| displayName |
string |
Nome visualizzato del prodotto |
| hasMarketplaceFootprint |
boolean |
Indicazione della presenza del prodotto in Azure Marketplace |
| hasRiPlans |
boolean |
Indicazione se il prodotto ha piani con riserve |
| hasStandardContractAmendments |
boolean |
Un valore che indica se sono presenti modifiche al contratto standard |
| images |
Elenco delle immagini |
|
| industryIds |
string[] |
Identificatori dei settori associati al prodotto. Utilizzato per la classificazione, il filtraggio e l'individuazione dei prodotti |
| isCoreVm |
boolean |
Indica se la macchina virtuale era originariamente una macchina virtuale di base |
| isPrivate |
boolean |
Indica se un prodotto è privato |
| isReseller |
boolean |
Un valore che indica se microsoft agisce come rivenditore |
| isStopSell |
boolean |
Indica se un prodotto non è più disponibile per la vendita |
| language |
string |
La lingua del prodotto |
| largeIconUri |
string |
URI dell'icona grande del prodotto |
| lastModifiedDateTime |
string |
Data dell'ultimo aggiornamento del prodotto |
| legalTermsType |
string |
Identifica il quadro degli accordi legali che regolano le licenze dei prodotti e le condizioni di utilizzo.
|
| legalTermsUri |
string |
Termini legali URI |
| linkedAddIns |
string[] |
Elenco degli Add In collegati forniti per l'articolo |
| linkedAddInsTypes |
object |
Tipi di componenti aggiuntivi collegati |
| links |
Elenco dei link forniti per l'elemento |
|
| locations |
string[] |
Elenco delle ubicazioni disponibili nelle referenze |
| longSummary |
string |
Riassunto lungo del prodotto |
| marketingMaterial |
Include collegamenti ai materiali di apprendimento e marketing configurati dall'editore |
|
| maxQuantityOnProposal |
integer (int32) |
Quantità massima consentita su una proposta |
| mediumIconUri |
string |
URI dell'icona del prodotto medio |
| mixProductId |
string |
Un identificatore per i servizi di pubblicazione |
| offerId |
string |
L'id dell'offerta |
| operatingSystems |
string[] |
Informazioni sul sistema operativo per questo prodotto |
| plans |
Set completo di attributi del piano/SKU |
|
| popularity |
number (double) |
Popolarità del prodotto |
| pricingDetailsUri |
string |
Uri dei dettagli sui prezzi del prodotto |
| pricingTypes |
string[] |
Indica i modelli di fatturazione e le strutture dei costi disponibili per il piano.
|
| privacyPolicyUri |
string |
L'informativa sulla privacy del prodotto |
| productCustomData |
string |
Dati passthrough personalizzati forniti dall'editore |
| productFamily |
string |
Famiglia di prodotti |
| productId |
string |
Un identificatore commerciale univoco utilizzato per fare riferimento a un prodotto specifico in operazioni transazionali come acquisti, fatturazione e misurazione. Questo ID serve la convalida dei diritti e la fatturazione tra i sistemi |
| productLabels |
string[] |
Etichette usate per filtrare il prodotto |
| productOwnershipSellingMotion |
string |
Movimento di vendita della proprietà del prodotto |
| productSubType |
string |
Sottotipo di prodotto |
| productType |
string |
Specifica il modello di distribuzione principale e l'architettura di hosting per il prodotto del Marketplace archiviato nel Catalogo del Marketplace. I valori possibili includono, ma non sono limitati a:
|
| publisherDisplayName |
string |
Nome visualizzato dell'editore |
| publisherId |
string |
ID editore |
| publisherType |
string |
Identifica la relazione tra l'editore e Microsoft per il supporto e la classificazione delle partnership.
|
| publishingStage |
string |
Indica lo stato di disponibilità del prodotto e il livello di accesso del cliente all'interno di Azure Marketplace.
|
| ratingAverage |
number (double) |
Valutazione media dell'offerta |
| ratingBuckets |
string[] |
Classifica i prodotti in base alle soglie di valutazione dei clienti per il filtraggio e l'individuazione del marketplace.
|
| ratingCount |
integer (int32) |
Numero totale di valutazioni per l'offerta |
| screenshotUris |
string[] |
Elenco degli URI delle immagini degli screenshot |
| service |
string |
Il nome del servizio del prodotto, ad esempio "Macchine virtuali" |
| serviceFamily |
string |
La famiglia di servizi del prodotto, ad esempio "Calcolo" |
| serviceId |
string |
L'ID del servizio |
| skuAggregatedData |
Dati aggregati dal livello Sku del prodotto |
|
| smallIconUri |
string |
URI dell'icona del prodotto piccolo |
| standardContractAmendmentsRevisionId |
string |
Modifiche contrattuali standard per il prodotto |
| startingPrice |
Prezzo al dettaglio del piano più economico del prodotto |
|
| stopSellInfo |
Un oggetto StopSellInfo che fornisce dati correlati allo stop sell |
|
| summary |
string |
Riassunto del prodotto |
| supportUri |
string |
Uri di supporto del prodotto |
| supportedProducts |
string[] |
Mappa l'elenco dei prodotti compatibili |
| uiDefinitionUri |
string |
URI di definizione dell'interfaccia utente |
| uniqueProductId |
string |
Identificatore univoco del prodotto |
| universalAmendmentUrl |
string |
Il link di modifica universale per un contratto d'impresa |
| videos |
Elenco dei video dei prodotti |
|
| wideIconUri |
string |
URI dell'icona del prodotto esteso |
ProductVideo
Video del prodotto
| Nome | Tipo | Descrizione |
|---|---|---|
| caption |
string |
Didascalia |
| previewImage |
Immagine di anteprima video |
|
| uri |
string |
URI video |
| videoPurpose |
string |
Scopo del video |
ProrationPolicy
Definisce le regole per il calcolo degli addebiti o dei rimborsi ripartiti proporzionalmente per un abbonamento
| Nome | Tipo | Descrizione |
|---|---|---|
| minimumProratedUnits |
string |
Specifica l'unità di tempo più piccola (durata ISO 8601) utilizzata nella ripartizione proporzionale, ad esempio P1D per un giorno |
PurchaseDurationDiscount
La percentuale di sconto per le prenotazioni di software di macchine virtuali di terze parti
| Nome | Tipo | Descrizione |
|---|---|---|
| discountPercentage |
number (float) |
La percentuale di sconto |
| duration |
string |
Durata |
RelatedSku
Oggetto SKU relativo a un determinato piano
| Nome | Tipo | Descrizione |
|---|---|---|
| generation |
string |
La generazione Sku |
| identity |
string |
L'identità Sku |
| name |
string |
Il nome Sku |
SkuAggregatedData
Dati aggregati dal livello Sku del prodotto
| Nome | Tipo | Descrizione |
|---|---|---|
| actions |
string[] |
Superset di azioni aggregate da disponibilità e termini tra le SKU dei prodotti |
| features |
string[] |
Superset di caratteristiche Sku |
| hasAdminEligibleSKUs |
boolean |
C'è almeno uno Sku Admin Eligibile |
| hasConsumptionComponents |
boolean |
C'è almeno uno Sku con componenti di consumo |
| hasEndUserEligibleSKUs |
boolean |
Esiste almeno uno Sku EndUser Eligible |
| programs |
string[] |
Superset dei programmi Sku |
| states |
string[] |
Superset degli stati di termini di disponibilità sku |
SkuProperties
Proprietà dell'oggetto SKU
| Nome | Tipo | Descrizione |
|---|---|---|
| accessTier |
string |
Il livello di accesso, ad esempio "Standard" |
| armSkuName |
string |
Nome SKU ARM |
| category |
string |
La categoria SKU |
| dataDiskType |
string |
Il tipo di disco dati, ad esempio "Ssd" |
| diskType |
string |
Il tipo di disco, ad esempio "Ssd" |
| numberOfCores |
string |
Il numero di core |
| ram |
string |
La RAM |
| vCpu |
string |
Il numero di CPU virtuali |
StopSellInfo
Rappresenta un modello per le informazioni relative allo stop sell
| Nome | Tipo | Descrizione |
|---|---|---|
| alternativeOfferId |
string |
Un valore che indica l'ID di un'offerta alternativa fornita dallo stesso editore |
| alternativePlanId |
string |
Un valore che indica un ID di un piano alternativo della stessa offerta |
| reason |
string |
Specifica la giustificazione commerciale o tecnica per l'interruzione della vendita di prodotti nel marketplace.
|
| startDate |
string (date-time) |
Un valore che indica quando la vendita di questo articolo sta per essere interrotta |
Term
Termine applicabile
| Nome | Tipo | Descrizione |
|---|---|---|
| billingPlan |
Piano di fatturazione |
|
| isAutorenewable |
boolean |
Indica se il rinnovo automatico è abilitato |
| price |
Prezzo al pubblico con valuta |
|
| prorationPolicy |
Definisce le regole per il calcolo degli addebiti o dei rimborsi ripartiti proporzionalmente per un abbonamento |
|
| renewTermId |
string |
Rinnovare l'ID termine |
| renewTermUnits |
string |
Rinnovare le unità a termine |
| renewToTermBillingPlan |
string |
Rinnova il piano di fatturazione |
| termDescription |
string |
Descrizione del termine |
| termDescriptionParameters |
I parametri del termine descrizione |
|
| termId |
string |
ID termine |
| termUnit |
string |
Unità di termine |
TermDescriptionParameter
I parametri del termine descrizione
| Nome | Tipo | Descrizione |
|---|---|---|
| parameter |
string |
Parametro |
| value |
string |
Value |