Microsoft.Marketplace (stable:2022-02-02)

2025/12/05 • 2 new, 2 deleted methods

Search_PostArm (new)
Description :  Returns a list of azure private store marketplace catalog offers and total count and facets
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/search
{
x-ms-client-tenant-id:
{
Required: True ,
}
string ,
request:
{
Required: True ,
}
{
searchQuery:
{
Required: False ,
}
string ,
publisherName:
{
Required: False ,
}
string ,
skip:
{
Format: int32 ,
Required: False ,
}
integer ,
take:
{
Format: int32 ,
Required: False ,
}
integer ,
isAzureBenefitEligible:
{
Required: False ,
}
boolean ,
isMicrosoftProduct:
{
Required: False ,
}
boolean ,
isThirdParty:
{
Required: False ,
}
boolean ,
isCoreVm:
{
Required: False ,
}
boolean ,
isPreferredSolution:
{
Required: False ,
}
boolean ,
isAdditionalPurchaseRequired:
{
Required: False ,
}
boolean ,
isPowerBICertified:
{
Required: False ,
}
boolean ,
isIndustryCloud:
{
Required: False ,
}
boolean ,
languages:
{
Required: True ,
}
[
string ,
]
,
stores:
{
Required: True ,
}
[
string ,
]
,
select:
{
Required: False ,
}
[
string ,
]
,
sortBy:
{
Required: False ,
}
[
string ,
]
,
offerTypes:
{
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Required: False ,
}
[
string ,
]
,
privateStoreAllowances:
{
Required: False ,
}
[
string ,
]
,
appSourceIndustries:
{
Required: False ,
}
[
string ,
]
,
operatingSystems:
{
Required: False ,
}
[
string ,
]
,
appSourceCategories:
{
Required: False ,
}
[
string ,
]
,
azureIndustries:
{
Required: False ,
}
[
string ,
]
,
azureCategories:
{
Required: False ,
}
[
string ,
]
,
azurePortalCategories:
{
Required: False ,
}
[
string ,
]
,
facets:
{
Required: False ,
}
[
string ,
]
,
}
,
x-ms-app:
{
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
facets:
{
Required: False ,
}
[
{
facetName:
{
Required: False ,
}
string ,
facetValues:
{
Required: False ,
}
[
{
value:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
results:
{
Required: False ,
}
[
{
ampAppsPopularity:
{
Format: double ,
Required: False ,
}
number ,
ampCsPopularity:
{
Format: double ,
Required: False ,
}
number ,
applicableProducts:
{
Required: False ,
}
[
string ,
]
,
appSourceAppsPopularity:
{
Format: double ,
Required: False ,
}
number ,
appSourceCategories:
{
Required: False ,
}
[
string ,
]
,
appSourceCsPopularity:
{
Format: double ,
Required: False ,
}
number ,
appSourceIndustries:
{
Required: False ,
}
[
string ,
]
,
azureCategories:
{
Required: False ,
}
[
string ,
]
,
azurePortalCategories:
{
Required: False ,
}
[
string ,
]
,
azureIndustries:
{
Required: False ,
}
[
string ,
]
,
bigId:
{
Required: False ,
}
string ,
cspStates:
{
Required: False ,
}
[
string ,
]
,
determinedStorefronts:
{
Required: False ,
}
[
string ,
]
,
displayName:
{
Required: False ,
}
string ,
isAzureBenefitEligible:
{
Required: False ,
}
boolean ,
isCoreVm:
{
Required: False ,
}
boolean ,
isPreferredSolution:
{
Required: False ,
}
boolean ,
isAdditionalPurchaseRequired:
{
Required: False ,
}
boolean ,
isPowerBICertified:
{
Required: False ,
}
boolean ,
isIndustryCloud:
{
Required: False ,
}
boolean ,
isMicrosoftProduct:
{
Required: False ,
}
boolean ,
isPreview:
{
Required: False ,
}
boolean ,
language:
{
Required: False ,
}
string ,
legacyId:
{
Required: False ,
}
string ,
offerType:
{
Required: False ,
}
string ,
operatingSystems:
{
Required: False ,
}
[
string ,
]
,
plans:
{
Required: False ,
}
[
{
cspState:
{
Required: False ,
}
string ,
legacyPlanId:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
architectureType:
{
Required: False ,
}
string ,
metadata:
{
Required: False ,
}
{
generation:
{
Required: False ,
}
string ,
}
,
operatingSystem:
{
Required: False ,
}
{
family:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
}
,
}
,
]
,
pricingTypes:
{
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Required: False ,
}
string ,
summary:
{
Required: False ,
}
string ,
vmGenerations:
{
Required: False ,
}
[
string ,
]
,
vmImageTypes:
{
Required: False ,
}
[
string ,
]
,
vmSecurityTypes:
{
Required: False ,
}
[
string ,
]
,
smallIconUri:
{
Required: False ,
}
string ,
mediumIconUri:
{
Required: False ,
}
string ,
largeIconUri:
{
Required: False ,
}
string ,
wideIconUri:
{
Required: False ,
}
string ,
heroIconUri:
{
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available Microsoft.Marketplace REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Search_PostArm (removed)
Description :  Returns a list of azure private store marketplace catalog offers and total count and facets
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/search
{
x-ms-client-tenant-id:
{
Required: True ,
}
string ,
request:
{
Required: True ,
}
{
searchQuery:
{
Required: False ,
}
string ,
publisherName:
{
Required: False ,
}
string ,
skip:
{
Format: int32 ,
Required: False ,
}
integer ,
take:
{
Format: int32 ,
Required: False ,
}
integer ,
isAzureBenefitEligible:
{
Required: False ,
}
boolean ,
isMicrosoftProduct:
{
Required: False ,
}
boolean ,
isThirdParty:
{
Required: False ,
}
boolean ,
isCoreVm:
{
Required: False ,
}
boolean ,
isPreferredSolution:
{
Required: False ,
}
boolean ,
isAdditionalPurchaseRequired:
{
Required: False ,
}
boolean ,
isPowerBICertified:
{
Required: False ,
}
boolean ,
isIndustryCloud:
{
Required: False ,
}
boolean ,
languages:
{
Required: True ,
}
[
string ,
]
,
stores:
{
Required: True ,
}
[
string ,
]
,
select:
{
Required: False ,
}
[
string ,
]
,
sortBy:
{
Required: False ,
}
[
string ,
]
,
offerTypes:
{
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Required: False ,
}
[
string ,
]
,
privateStoreAllowances:
{
Required: False ,
}
[
string ,
]
,
appSourceIndustries:
{
Required: False ,
}
[
string ,
]
,
operatingSystems:
{
Required: False ,
}
[
string ,
]
,
appSourceCategories:
{
Required: False ,
}
[
string ,
]
,
azureIndustries:
{
Required: False ,
}
[
string ,
]
,
azureCategories:
{
Required: False ,
}
[
string ,
]
,
azurePortalCategories:
{
Required: False ,
}
[
string ,
]
,
facets:
{
Required: False ,
}
[
string ,
]
,
}
,
x-ms-app:
{
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
facets:
{
Required: False ,
}
[
{
facetName:
{
Required: False ,
}
string ,
facetValues:
{
Required: False ,
}
[
{
value:
{
Required: False ,
}
string ,
count:
{
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
results:
{
Required: False ,
}
[
{
ampAppsPopularity:
{
Format: double ,
Required: False ,
}
number ,
ampCsPopularity:
{
Format: double ,
Required: False ,
}
number ,
applicableProducts:
{
Required: False ,
}
[
string ,
]
,
appSourceAppsPopularity:
{
Format: double ,
Required: False ,
}
number ,
appSourceCategories:
{
Required: False ,
}
[
string ,
]
,
appSourceCsPopularity:
{
Format: double ,
Required: False ,
}
number ,
appSourceIndustries:
{
Required: False ,
}
[
string ,
]
,
azureCategories:
{
Required: False ,
}
[
string ,
]
,
azurePortalCategories:
{
Required: False ,
}
[
string ,
]
,
azureIndustries:
{
Required: False ,
}
[
string ,
]
,
bigId:
{
Required: False ,
}
string ,
cspStates:
{
Required: False ,
}
[
string ,
]
,
determinedStorefronts:
{
Required: False ,
}
[
string ,
]
,
displayName:
{
Required: False ,
}
string ,
isAzureBenefitEligible:
{
Required: False ,
}
boolean ,
isCoreVm:
{
Required: False ,
}
boolean ,
isPreferredSolution:
{
Required: False ,
}
boolean ,
isAdditionalPurchaseRequired:
{
Required: False ,
}
boolean ,
isPowerBICertified:
{
Required: False ,
}
boolean ,
isIndustryCloud:
{
Required: False ,
}
boolean ,
isMicrosoftProduct:
{
Required: False ,
}
boolean ,
isPreview:
{
Required: False ,
}
boolean ,
language:
{
Required: False ,
}
string ,
legacyId:
{
Required: False ,
}
string ,
offerType:
{
Required: False ,
}
string ,
operatingSystems:
{
Required: False ,
}
[
string ,
]
,
plans:
{
Required: False ,
}
[
{
cspState:
{
Required: False ,
}
string ,
legacyPlanId:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
architectureType:
{
Required: False ,
}
string ,
metadata:
{
Required: False ,
}
{
generation:
{
Required: False ,
}
string ,
}
,
operatingSystem:
{
Required: False ,
}
{
family:
{
Required: False ,
}
string ,
type:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
}
,
}
,
]
,
pricingTypes:
{
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Required: False ,
}
string ,
summary:
{
Required: False ,
}
string ,
vmGenerations:
{
Required: False ,
}
[
string ,
]
,
vmImageTypes:
{
Required: False ,
}
[
string ,
]
,
vmSecurityTypes:
{
Required: False ,
}
[
string ,
]
,
smallIconUri:
{
Required: False ,
}
string ,
mediumIconUri:
{
Required: False ,
}
string ,
largeIconUri:
{
Required: False ,
}
string ,
wideIconUri:
{
Required: False ,
}
string ,
heroIconUri:
{
Required: False ,
}
string ,
}
,
]
,
totalCount:
{
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Microsoft.Marketplace REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}