Azure Marketplace
REST APIs for Private Marketplace
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
REST APIs for Private Marketplace
Endpoints 45
Operations
- GETOperations_List
/providers/Microsoft.Marketplace/operationsLists all of the available Microsoft.Marketplace REST API operations.
PrivateStores
- GETPrivateStore_List
/providers/Microsoft.Marketplace/privateStores?use-cache=stringGets the list of available private stores. - GETPrivateStore_Get
/providers/Microsoft.Marketplace/privateStores/:privateStoreIdGet information about the private store - PUTPrivateStore_CreateOrUpdate
/providers/Microsoft.Marketplace/privateStores/:privateStoreIdChanges private store properties - DELETEPrivateStore_Delete
/providers/Microsoft.Marketplace/privateStores/:privateStoreIdDeletes the private store. All that is not saved will be lost. - POSTPrivateStore_AnyExistingOffersInTheCollections
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/anyExistingOffersInTheCollectionsQuery whether exists any offer in the collections. - POSTPrivateStore_BillingAccounts
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/billingAccountsTenant billing accounts names - POSTPrivateStore_BulkCollectionsAction
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/bulkCollectionsActionPerform an action on bulk collections - POSTPrivateStore_CollectionsToSubscriptionsMapping
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collectionsToSubscriptionsMappingFor a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list. - POSTPrivateStore_FetchAllSubscriptionsInTenant
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/fetchAllSubscriptionsInTenantFetch all subscriptions in tenant, only for marketplace admin - POSTPrivateStore_ListNewPlansNotifications
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/listNewPlansNotificationsList new plans notifications - POSTPrivateStore_ListStopSellOffersPlansNotifications
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/listStopSellOffersPlansNotificationsList stop sell notifications for both stop sell offers and stop sell plans - POSTPrivateStore_ListSubscriptionsContext
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/listSubscriptionsContextList all the subscriptions in the private store context - POSTPrivateStore_AcknowledgeOfferNotification
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/offers/:offerId/acknowledgeNotificationAcknowledge notification for offer - POSTPrivateStore_QueryApprovedPlans
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/queryApprovedPlansGet map of plans and related approved subscriptions. - POSTPrivateStore_QueryNotificationsState
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/queryNotificationsStateGet private store notifications state - POSTPrivateStore_QueryOffers
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/queryOffersList of offers, regardless the collections - POSTPrivateStore_QueryUserOffers
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/queryUserOffersList of user's approved offers for the provided offers and subscriptions - POSTQueryUserRules
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/queryUserRulesAll rules approved in the private store that are relevant for user subscriptions
RequestApprovalResources
- GETPrivateStore_GetApprovalRequestsList
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/requestApprovalsGet all open approval requests of current user - GETPrivateStore_GetRequestApproval
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/requestApprovals/:requestApprovalIdGet open request approval details - PUTPrivateStore_CreateApprovalRequest
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/requestApprovals/:requestApprovalIdCreate approval request - POSTPrivateStore_QueryRequestApproval
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/requestApprovals/:requestApprovalId/queryGet request statuses foreach plan, this api is used as a complex GET action. - POSTPrivateStore_WithdrawPlan
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/requestApprovals/:requestApprovalId/withdrawPlanWithdraw a user request approval on specific plan
AdminRequestApprovalsResources
- GETPrivateStore_AdminRequestApprovalsList
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/adminRequestApprovalsGet list of admin request approvals - GETPrivateStore_GetAdminRequestApproval
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/adminRequestApprovals/:adminRequestApprovalId?publisherId=stringGet open approval requests - PUTPrivateStore_UpdateAdminRequestApproval
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/adminRequestApprovals/:adminRequestApprovalIdUpdate the admin action, weather the request is approved or rejected and the approved plans
Collections
- GETPrivateStoreCollection_List
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collectionsGets private store collections list - GETPrivateStoreCollection_Get
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionIdGets private store collection - PUTPrivateStoreCollection_CreateOrUpdate
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionIdCreate or update private store collection - DELETEPrivateStoreCollection_Delete
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionIdDelete a collection from the given private store. - POSTPrivateStoreCollection_ApproveAllItems
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/approveAllItemsDelete all existing offers from the collection and enable approve all items. - POSTPrivateStoreCollection_DisableApproveAllItems
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/disableApproveAllItemsDisable approve all items for the collection. - POSTPrivateStoreCollectionOffer_ListByContexts
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/mapOffersToContextsGet a list of all offers in the given collection according to the required contexts. - POSTQueryRules
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/queryRulesGet a list of all private store rules in the given private store and collection - POSTSetCollectionRules
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/setRulesSet rule for specific private store and collection - POSTPrivateStoreCollection_TransferOffers
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/transferOfferstransferring offers (copy or move) from source collection to target collection(s)
Offers
- GETPrivateStoreCollectionOffer_List
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/offersGet a list of all private offers in the given private store and collection - GETPrivateStoreCollectionOffer_Get
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/offers/:offerIdGets information about a specific offer. - PUTPrivateStoreCollectionOffer_CreateOrUpdate
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/offers/:offerIdUpdate or add an offer to a specific collection of the private store. - DELETEPrivateStoreCollectionOffer_Delete
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/offers/:offerIdDeletes an offer from the given collection of private store. - POSTPrivateStoreCollectionOffer_ContextsView
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/offers/:offerId/contextsViewRetrieve offer information with plans under required contexts restrictions. - POSTPrivateStoreCollectionOffer_UpsertOfferWithMultiContext
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/offers/:offerId/upsertOfferWithMultiContextUpsert an offer with multiple context details.
- POSTPrivateStoreCollection_Post
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionIdDelete Private store collection. This is a workaround. - POSTPrivateStoreCollectionOffer_Post
/providers/Microsoft.Marketplace/privateStores/:privateStoreId/collections/:collectionId/offers/:offerIdDelete Private store offer. This is a workaround.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 45 operations on 35 pathsPOST 26GET 11PUT 5DELETE 3
- Main resources
- PrivateStores 18Collections 10Offers 6RequestApprovalResources 5AdminRequestApprovalsResources 3Operations 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
2025-01-01 - Links
- OpenAPI document
How to test the Azure Marketplace in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Marketplace collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Operations_List” (GET /providers/Microsoft.Marketplace/operations), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Marketplace?
REST APIs for Private Marketplace It is listed under E-commerce and has 45 endpoints.
Who publishes the Azure Marketplace?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Marketplace?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Marketplace?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Marketplace have?
45 operations on 35 paths (26 POST, 11 GET, 5 PUT, 3 DELETE). The largest groups are PrivateStores, Collections, Offers, RequestApprovalResources.
Is forking the Azure Marketplace free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.