Microsoft.Marketplace (stable:2020-01-01)

2025/09/26 • 13 new, 13 deleted methods

PrivateStoreOffers_List (new)
Description :  Get a list of all private offers in the given private store
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of offer list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStorePrivateOffers_List (new)
Description :  Get a list of all private offers in the given private store
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of offer list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_Delete (new)
Description :  Deletes an offer from the given private store.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_Get (new)
Description :  Gets information about a specific offer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_CreateOrUpdate (new)
Description :  Update or add an offer to the default collection of the private store.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_Post (new)
Description :  Delete Private store offer. This is a workaround.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{
payload:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStorePrivateOffer_Get (new)
Description :  Gets information about a specific private offer.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStorePrivateOffer_CreateOrUpdate (new)
Description :  Update or add a private offer to the default collection of the private store.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_List (new)
Description :  Gets the list of available private stores
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantTag:
{
Description: Tenant Tag ,
Required: False ,
}
string ,
tenantIds:
{
Description: Tenant ids ,
Required: False ,
}
[
string ,
]
,
customerTag:
{
Description: Customer tag ,
Required: False ,
}
string ,
hasCommercialAssociation:
{
Description: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription ,
Required: False ,
}
boolean ,
hasMultiTenantAssociation:
{
Description: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD ,
Required: False ,
}
boolean ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of PrivateStore list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_Get (new)
Description :  Get information about the private store
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{}

⚐ Response (200)

{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantTag:
{
Description: Tenant Tag ,
Required: False ,
}
string ,
tenantIds:
{
Description: Tenant ids ,
Required: False ,
}
[
string ,
]
,
customerTag:
{
Description: Customer tag ,
Required: False ,
}
string ,
hasCommercialAssociation:
{
Description: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription ,
Required: False ,
}
boolean ,
hasMultiTenantAssociation:
{
Description: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD ,
Required: False ,
}
boolean ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_Delete (new)
Description :  Deletes the private store. All that is not saved will be lost.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_CreateOrUpdate (new)
Description :  Changes private store properties
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantTag:
{
Description: Tenant Tag ,
Required: False ,
}
string ,
tenantIds:
{
Description: Tenant ids ,
Required: False ,
}
[
string ,
]
,
customerTag:
{
Description: Customer tag ,
Required: False ,
}
string ,
hasCommercialAssociation:
{
Description: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription ,
Required: False ,
}
boolean ,
hasMultiTenantAssociation:
{
Description: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD ,
Required: False ,
}
boolean ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Marketplace ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Amendments ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Get Amendments etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffers_List (removed)
Description :  Get a list of all private offers in the given private store
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of offer list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStorePrivateOffers_List (removed)
Description :  Get a list of all private offers in the given private store
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of offer list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_Delete (removed)
Description :  Deletes an offer from the given private store.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_Get (removed)
Description :  Gets information about a specific offer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_CreateOrUpdate (removed)
Description :  Update or add an offer to the default collection of the private store.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreOffer_Post (removed)
Description :  Delete Private store offer. This is a workaround.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{
payload:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStorePrivateOffer_Get (removed)
Description :  Gets information about a specific private offer.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStorePrivateOffer_CreateOrUpdate (removed)
Description :  Update or add a private offer to the default collection of the private store.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_List (removed)
Description :  Gets the list of available private stores
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantTag:
{
Description: Tenant Tag ,
Required: False ,
}
string ,
tenantIds:
{
Description: Tenant ids ,
Required: False ,
}
[
string ,
]
,
customerTag:
{
Description: Customer tag ,
Required: False ,
}
string ,
hasCommercialAssociation:
{
Description: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription ,
Required: False ,
}
boolean ,
hasMultiTenantAssociation:
{
Description: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD ,
Required: False ,
}
boolean ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of PrivateStore list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_Get (removed)
Description :  Get information about the private store
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{}

⚐ Response (200)

{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantTag:
{
Description: Tenant Tag ,
Required: False ,
}
string ,
tenantIds:
{
Description: Tenant ids ,
Required: False ,
}
[
string ,
]
,
customerTag:
{
Description: Customer tag ,
Required: False ,
}
string ,
hasCommercialAssociation:
{
Description: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription ,
Required: False ,
}
boolean ,
hasMultiTenantAssociation:
{
Description: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD ,
Required: False ,
}
boolean ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_Delete (removed)
Description :  Deletes the private store. All that is not saved will be lost.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_CreateOrUpdate (removed)
Description :  Changes private store properties
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantTag:
{
Description: Tenant Tag ,
Required: False ,
}
string ,
tenantIds:
{
Description: Tenant ids ,
Required: False ,
}
[
string ,
]
,
customerTag:
{
Description: Customer tag ,
Required: False ,
}
string ,
hasCommercialAssociation:
{
Description: Indicating whether private store has association with Commercial's Billing Account (through billing account's customer tag retrieved from GSM for a subscription ,
Required: False ,
}
boolean ,
hasMultiTenantAssociation:
{
Description: Indicating whether private store has association with multiple tenants (through tenant's tag retrieved from AAD ,
Required: False ,
}
boolean ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Marketplace ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Amendments ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Get Amendments etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}