diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/Marketplace.json deleted file mode 100644 index 76d987df9829..000000000000 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/Marketplace.json +++ /dev/null @@ -1,174 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2019-12-01", - "title": "Marketplace RP Service" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStoreClient/isPrivateClient": { - "get": { - "tags": [ - "isPrivateClient" - ], - "description": "Check if client is private or not.", - "operationId": "PrivateStoreClient_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - } - }, - "x-ms-examples": { - "GetPrivateStoreClient": { - "$ref": "./examples/GetPrivateStoreClient.json" - } - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - } - }, - "/providers/Microsoft.Marketplace/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available Microsoft.Marketplace REST API operations.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Microsoft.Marketplace error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The Azure subscription ID.", - "required": true, - "type": "string" - } - }, - "definitions": { - "ErrorResponse": { - "description": "Error response indicates Microsoft.Marketplace service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "properties": { - "code": { - "description": "Error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string", - "readOnly": true - } - } - } - } - }, - "Operation": { - "description": "Microsoft.Marketplace REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft.Marketplace", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed: Amendments", - "type": "string" - }, - "operation": { - "description": "Operation type: Get Amendments etc.", - "type": "string" - } - } - } - } - }, - "OperationListResult": { - "description": "Result of the request to list Marketplace operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any.", - "readOnly": true - } - } - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/examples/GetPrivateStoreClient.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/examples/GetPrivateStoreClient.json deleted file mode 100644 index 8458e8864299..000000000000 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2019-12-01/examples/GetPrivateStoreClient.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "resRg", - "clusterName": "myCluster", - "api-version": "2019-12-01" - }, - "responses": { - "200": { - "description": "OK. The request has succeeded." - } - } -} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json index 4bf90e4eea96..83ee490aa16a 100644 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "2020-01-01", - "title": "MarketplaceManagementClient", + "title": "Marketplace RP Service", "description": "REST APIs for Azure Marketplace" }, "host": "management.azure.com", diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json index 31e1786825ce..88be9353ebef 100644 --- a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2020-12-01/Marketplace.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "2020-12-01", - "title": "MarketplaceManagementClient", + "title": "Marketplace RP Service", "description": "REST APIs for Azure Marketplace" }, "host": "management.azure.com", diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json new file mode 100644 index 000000000000..daaf091ace01 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/Marketplace.json @@ -0,0 +1,2326 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01", + "title": "Marketplace RP Service", + "description": "REST APIs for Private Marketplace" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Marketplace/privateStores": { + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UseCacheParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_List", + "description": "Gets the list of available private stores.", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateStoreList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetPrivateStores": { + "$ref": "./examples/GetPrivateStores.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_Get", + "description": "Get information about the private store", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateStore" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStore": { + "$ref": "./examples/GetPrivateStore.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_CreateOrUpdate", + "description": "Changes private store properties", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/PrivateStore" + } + } + ], + "responses": { + "200": { + "description": "Change successful" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateStores_update": { + "$ref": "./examples/PrivateStores_update.json" + } + } + }, + "delete": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_Delete", + "description": "Deletes the private store. All that is not saved will be lost.", + "responses": { + "200": { + "description": "Private store was deleted successfully." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletePrivateStores": { + "$ref": "./examples/DeletePrivateStore.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryOffers": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_QueryOffers", + "description": "List of offers, regardless the collections", + "responses": { + "200": { + "description": "List of offers", + "schema": { + "$ref": "#/definitions/QueryOffers" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QueryOffers": { + "$ref": "./examples/QueryOffers.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/billingAccounts": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_BillingAccounts", + "description": "Tenant billing accounts names", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingAccountsResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingAccounts": { + "$ref": "./examples/BillingAccounts.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collectionsToSubscriptionsMapping": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_CollectionsToSubscriptionsMapping", + "description": "For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingPayload" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CollectionsToSubscriptionsMapping": { + "$ref": "./examples/CollectionsToSubscriptionsMapping.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_List", + "description": "Gets private store collections list", + "responses": { + "200": { + "description": "Collections list information retrieved", + "schema": { + "$ref": "#/definitions/CollectionsList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStoreCollectionsList": { + "$ref": "./examples/GetPrivateStoreCollectionsList.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_Get", + "description": "Gets private store collection", + "responses": { + "200": { + "description": "Collection information retrieved", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStoreCollection": { + "$ref": "./examples/GetPrivateStoreCollection.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_CreateOrUpdate", + "description": "Create or update private store collection", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/Collection" + } + } + ], + "responses": { + "200": { + "description": "Create or update collection properties", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreatePrivateStoreCollection": { + "$ref": "./examples/CreatePrivateStoreCollection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_Delete", + "description": "Delete a collection from the given private store.", + "responses": { + "200": { + "description": "Collection was deleted successfully" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletePrivateStoreCollection": { + "$ref": "./examples/DeletePrivateStoreCollection.json" + } + } + }, + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_Post", + "description": "Delete Private store collection. This is a workaround.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/PrivateStoreOperation" + } + } + ], + "responses": { + "200": { + "description": "Operation succeeded" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PostPrivateStoreCollection": { + "$ref": "./examples/PostPrivateStoreCollection.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/transferOffers": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollection_TransferOffers", + "description": "transferring offers (copy or move) from source collection to target collection(s)", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/TransferOffersProperties" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransferOffersResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TransferOffers": { + "$ref": "./examples/TransferOffers.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_List", + "description": "Get a list of all private offers in the given private store and collection", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferListResponse" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetPrivateStoreOffers": { + "$ref": "./examples/GetPrivateStoreOffers.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/OfferIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_Get", + "description": "Gets information about a specific offer.", + "responses": { + "200": { + "description": "Offer information retrieved", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetPrivateStoreCollectionOffer": { + "$ref": "./examples/GetPrivateStoreCollectionOffer.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_CreateOrUpdate", + "description": "Update or add an offer to a specific collection of the private store.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/Offer" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateStoreOffer_update": { + "$ref": "./examples/PrivateStoreOffer_update.json" + } + } + }, + "delete": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_Delete", + "description": "Deletes an offer from the given collection of private store.", + "responses": { + "200": { + "description": "Offer was deleted successfully" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeletePrivateStoreOffer": { + "$ref": "./examples/DeletePrivateStoreOffer.json" + } + } + }, + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStoreCollectionOffer_Post", + "description": "Delete Private store offer. This is a workaround.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/PrivateStoreOperation" + } + } + ], + "responses": { + "200": { + "description": "Operation succeeded" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PostPrivateStoreCollectionOffer": { + "$ref": "./examples/PostPrivateStoreCollectionOffer.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_GetApprovalRequestsList", + "description": "Get all open approval requests of current user", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestApprovalsList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetApprovalRequestsList": { + "$ref": "./examples/GetApprovalRequestsList.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/RequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_GetRequestApproval", + "description": "Get open request approval details", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestApprovalResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetApprovalRequest": { + "$ref": "./examples/GetRequestApproval.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_CreateApprovalRequest", + "description": "Create approval request", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/RequestApprovalResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestApprovalResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateApprovalRequest": { + "$ref": "./examples/CreateApprovalRequest.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/query": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/RequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_QueryRequestApproval", + "description": "Get request statuses foreach plan, this api is used as a complex GET action.", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/QueryRequestApprovalProperties" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QueryRequestApproval" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QueryRequestApproval": { + "$ref": "./examples/QueryRequestApproval.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_AdminRequestApprovalsList", + "description": "Get list of admin request approvals", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsList" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AdminRequestApprovalsList": { + "$ref": "./examples/AdminRequestApprovalsList.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/AdminRequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_GetAdminRequestApproval", + "description": "Get open approval requests", + "parameters": [ + { + "$ref": "#/parameters/PublisherIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAdminRequestApproval": { + "$ref": "./examples/GetAdminRequestApproval.json" + } + } + }, + "put": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_UpdateAdminRequestApproval", + "description": "Update the admin action, weather the request is approved or rejected and the approved plans", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateAdminRequestApproval": { + "$ref": "./examples/UpdateAdminRequestApproval.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryNotificationsState": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_QueryNotificationsState", + "description": "Get private store notifications state", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateStoreNotificationsState" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationsState": { + "$ref": "./examples/NotificationsState.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}/acknowledgeNotification": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/OfferIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_AcknowledgeOfferNotification", + "description": "Acknowledge notification for offer", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/AcknowledgeOfferNotificationProperties" + } + } + ], + "responses": { + "200": { + "description": "OK, notification was acknowledged by the RP" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AcknowledgeNotification": { + "$ref": "./examples/AcknowledgeNotification.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/withdrawPlan": { + "parameters": [ + { + "$ref": "#/parameters/PrivateStoreIdParameter" + }, + { + "$ref": "#/parameters/RequestApprovalIdPathParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "PrivateStores" + ], + "operationId": "PrivateStore_WithdrawPlan", + "description": "Withdraw a user request approval on specific plan", + "parameters": [ + { + "in": "body", + "name": "payload", + "schema": { + "$ref": "#/definitions/WithdrawProperties" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WithdrawPlan": { + "$ref": "./examples/WithdrawPlan.json" + } + } + } + }, + "/providers/Microsoft.Marketplace/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Microsoft.Marketplace REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Microsoft.Marketplace error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": { + "PrivateStoreIdParameter": { + "name": "privateStoreId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The store ID - must use the tenant ID" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request." + }, + "CollectionIdParameter": { + "name": "collectionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The collection ID" + }, + "OfferIdPathParameter": { + "in": "path", + "name": "offerId", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "The offer ID to update or delete" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "Subscription id of the private offers" + }, + "UseCacheParameter": { + "name": "use-cache", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Determines if to use cache or DB for serving this request" + }, + "AdminRequestApprovalIdPathParameter": { + "in": "path", + "name": "adminRequestApprovalId", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "The admin request approval ID to get create or update" + }, + "RequestApprovalIdPathParameter": { + "in": "path", + "name": "requestApprovalId", + "type": "string", + "x-ms-parameter-location": "method", + "required": true, + "description": "The request approval ID to get create or update" + }, + "PublisherIdParameter": { + "name": "publisherId", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "description": "The publisher id of this offer." + } + }, + "definitions": { + "PrivateStoreList": { + "description": "Describes the json payload for the list of available private stores (between zero and one, inclusive)", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateStore" + } + }, + "nextLink": { + "description": "URL to get the next set of PrivateStore list results if there are any.", + "type": "string" + } + } + }, + "PrivateStore": { + "description": "The PrivateStore data structure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateStoreProperties", + "description": "The PrivateStore data structure.", + "x-ms-client-flatten": true + } + } + }, + "PrivateStoreProperties": { + "description": "Describes the json payload on whether or not the private store is enabled for a given tenant", + "type": "object", + "properties": { + "availability": { + "description": "Indicates private store availability", + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "Availability", + "modelAsString": true + } + }, + "privateStoreId": { + "description": "Private Store id", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "Identifier for purposes of race condition", + "type": "string" + }, + "privateStoreName": { + "description": "Private Store Name", + "type": "string" + }, + "tenantId": { + "description": "Tenant id", + "type": "string" + }, + "isGov": { + "description": "Is government", + "type": "boolean" + }, + "collectionIds": { + "description": "Gets list of associated collection ids", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "branding": { + "description": "Gets or sets list of branding characteristics", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CollectionsList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Collection" + } + }, + "nextLink": { + "description": "URL to get the next set of offer list results if there are any.", + "type": "string" + } + } + }, + "Collection": { + "description": "The Collection data structure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CollectionProperties", + "description": "The collection data structure.", + "x-ms-client-flatten": true + } + } + }, + "CollectionProperties": { + "description": "The collection details", + "type": "object", + "properties": { + "collectionId": { + "description": "Gets collection Id.", + "type": "string", + "readOnly": true + }, + "collectionName": { + "description": "Gets or sets collection name.", + "type": "string" + }, + "claim": { + "description": "Gets or sets the association with Commercial's Billing Account.", + "type": "string" + }, + "allSubscriptions": { + "description": "Indicating whether all subscriptions are selected (=true) or not (=false).", + "type": "boolean" + }, + "subscriptionsList": { + "description": "Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request", + "type": "array", + "items": { + "type": "string" + } + }, + "enabled": { + "description": "Indicating whether the collection is enabled or disabled.", + "type": "boolean" + }, + "numberOfOffers": { + "description": "Gets the number of offers associated with the collection.", + "type": "integer", + "format": "int64", + "readOnly": true + } + } + }, + "OfferListResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + } + }, + "nextLink": { + "description": "URL to get the next set of offer list results if there are any.", + "type": "string" + } + } + }, + "QueryOffers": { + "description": "List of offers", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OfferProperties" + } + }, + "nextLink": { + "description": "URL to get the next set of PrivateStore list results if there are any.", + "type": "string" + } + } + }, + "Offer": { + "description": "The privateStore offer data structure.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OfferProperties", + "description": "The privateStore offer data structure.", + "x-ms-client-flatten": true + } + } + }, + "OfferProperties": { + "type": "object", + "properties": { + "uniqueOfferId": { + "description": "Offers unique id", + "type": "string", + "readOnly": true + }, + "offerDisplayName": { + "description": "It will be displayed prominently in the marketplace", + "type": "string", + "readOnly": true + }, + "publisherDisplayName": { + "description": "Publisher name that will be displayed prominently in the marketplace", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "Identifier for purposes of race condition", + "type": "string" + }, + "privateStoreId": { + "readOnly": true, + "description": "Private store unique id", + "type": "string" + }, + "createdAt": { + "readOnly": true, + "description": "Private store offer creation date", + "type": "string" + }, + "modifiedAt": { + "readOnly": true, + "description": "Private store offer modification date", + "type": "string" + }, + "specificPlanIdsLimitation": { + "description": "Plan ids limitation for this offer", + "type": "array", + "items": { + "type": "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.", + "type": "boolean" + }, + "iconFileUris": { + "description": "Icon File Uris", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "plans": { + "description": "Offer plans", + "type": "array", + "items": { + "$ref": "#/definitions/Plan" + } + } + } + }, + "Plan": { + "type": "object", + "properties": { + "skuId": { + "description": "Identifier for this plan", + "type": "string", + "readOnly": true + }, + "planId": { + "description": "Text identifier for this plan", + "type": "string", + "readOnly": true + }, + "planDisplayName": { + "description": "Friendly name for the plan for display in the marketplace", + "type": "string", + "readOnly": true + }, + "accessibility": { + "description": "Plan accessibility", + "type": "string", + "enum": [ + "Unknown", + "Public", + "PrivateTenantOnLevel", + "PrivateSubscriptionOnLevel" + ], + "x-ms-enum": { + "name": "accessibility", + "modelAsString": true + } + }, + "altStackReference": { + "description": "Alternative stack type", + "type": "string", + "readOnly": true + }, + "stackType": { + "description": "Stack type (classic or arm)", + "type": "string", + "readOnly": true + } + } + }, + "AdminRequestApprovalsList": { + "description": "List of admin request approval resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AdminRequestApprovalsResource" + } + }, + "nextLink": { + "description": "URL to get the next set of notifications list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "AdminRequestApprovalsResource": { + "description": "Admin request approval resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AdminRequestApprovalProperties", + "description": "The privateStore admin Approval request data structure.", + "x-ms-client-flatten": true + } + } + }, + "AdminRequestApprovalProperties": { + "description": "Admin approval request resource properties", + "type": "object", + "properties": { + "offerId": { + "description": "Gets or sets offer Id", + "type": "string" + }, + "displayName": { + "description": "Gets display name", + "type": "string", + "readOnly": true + }, + "publisherId": { + "description": "Gets or sets publisher Id", + "type": "string" + }, + "adminAction": { + "description": "Gets or sets admin action", + "type": "string", + "enum": [ + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "adminAction", + "modelAsString": true + } + }, + "approvedPlans": { + "description": "Gets or sets Approved plans ids, empty in case of rejected", + "type": "array", + "items": { + "type": "string" + } + }, + "comment": { + "description": "Gets or sets admin comment", + "type": "string" + }, + "administrator": { + "description": "Gets or sets admin details", + "type": "string" + }, + "plans": { + "description": "Gets list of plans with requesters details", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PlanRequesterDetails" + } + }, + "collectionIds": { + "description": "Gets or sets list of associated collection ids", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PlanRequesterDetails": { + "description": "Plan with requesters details", + "properties": { + "planId": { + "description": "Gets the plan id", + "type": "string", + "readOnly": true + }, + "planDisplayName": { + "description": "Gets the plan display name", + "type": "string", + "readOnly": true + }, + "requesters": { + "description": "Gets requesters details list", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UserRequestDetails" + } + } + } + }, + "UserRequestDetails": { + "description": "user request details", + "type": "object", + "properties": { + "user": { + "description": "Gets user id", + "type": "string", + "readOnly": true + }, + "date": { + "description": "Gets request date", + "type": "string", + "readOnly": true + }, + "justification": { + "description": "Gets justification", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "Gets the subscription id that the user is requesting to add the plan to", + "type": "string" + }, + "subscriptionName": { + "description": "Gets the subscription name that the user is requesting to add the plan to", + "type": "string" + } + } + }, + "RequestApprovalsList": { + "description": "List of admin request approval resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestApprovalResource" + } + }, + "nextLink": { + "description": "URL to get the next set of notifications list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "RequestApprovalResource": { + "description": "Request approval resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RequestApprovalProperties", + "description": "The privateStore approval request data structure.", + "x-ms-client-flatten": true + } + } + }, + "RequestApprovalProperties": { + "description": "Approval request resource properties", + "type": "object", + "properties": { + "offerId": { + "description": "Gets or sets unique offer id.", + "type": "string" + }, + "offerDisplayName": { + "description": "Gets offer display name", + "type": "string", + "readOnly": true + }, + "publisherId": { + "description": "The offer's publisher id", + "type": "string" + }, + "plansDetails": { + "description": "Gets or sets the plans details", + "type": "array", + "items": { + "$ref": "#/definitions/planDetails" + } + }, + "isClosed": { + "description": "Gets a value indicating whether the request is closed", + "type": "boolean", + "readOnly": true + }, + "messageCode": { + "description": "Gets or sets the request approval message code", + "type": "integer", + "format": "int64" + } + } + }, + "planDetails": { + "description": "Return plan with request details", + "type": "object", + "properties": { + "planId": { + "description": "Gets or sets Plan Id ", + "type": "string" + }, + "status": { + "description": "Gets the plan status", + "type": "string", + "readOnly": true, + "enum": [ + "Pending", + "Rejected", + "Approved", + "None" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "requestDate": { + "description": "Gets request date", + "format": "date-time", + "readOnly": true + }, + "justification": { + "description": "Gets or sets user's justification for the plan's request", + "type": "string" + }, + "subscriptionId": { + "description": "Gets or sets the subscription id that the user is requesting to add the plan to", + "type": "string" + }, + "subscriptionName": { + "description": "Gets or sets the subscription name that the user is requesting to add the plan to", + "type": "string" + } + } + }, + "QueryRequestApproval": { + "description": "Gets the request plans with indication on each plan whether is approved by the admin, has pending request or not requested yet", + "type": "object", + "properties": { + "uniqueOfferId": { + "description": "Gets or sets unique offer id.", + "type": "string" + }, + "plansDetails": { + "description": "Gets or sets the plans details", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/planDetails" + } + }, + "etag": { + "description": "Gets or sets e-tag field ", + "type": "string" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + } + } + }, + "QueryRequestApprovalProperties": { + "description": "The details to get the request plans statuses", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RequestDetails", + "description": "The details to get the request plans statuses" + } + } + }, + "RequestDetails": { + "description": "Request details needed to get the plans statuses", + "type": "object", + "properties": { + "publisherId": { + "description": "The offer's publisher id", + "type": "string" + }, + "planIds": { + "description": "Current plans list", + "type": "array", + "items": { + "type": "string" + } + }, + "subscriptionId": { + "description": "Gets or sets the subscription id", + "type": "string" + } + } + }, + "PrivateStoreNotificationsState": { + "description": "Get private store notifications state", + "type": "object", + "properties": { + "stopSellNotifications": { + "type": "array", + "items": { + "$ref": "#/definitions/StopSellNotifications" + } + }, + "newNotifications": { + "type": "array", + "items": { + "$ref": "#/definitions/NewNotifications" + } + }, + "approvalRequests": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestApprovalsDetails" + } + } + } + }, + "NewNotifications": { + "description": "New plans notification details", + "type": "object", + "properties": { + "offerId": { + "description": "Gets offer id", + "type": "string" + }, + "displayName": { + "description": "Gets offer display name", + "type": "string" + }, + "isFuturePlansEnabled": { + "description": "Gets a value indicating whether future plans is enabled.", + "type": "boolean" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + }, + "icon": { + "description": "Gets or sets the icon url", + "type": "string" + }, + "plans": { + "description": "Gets or sets removed plans notifications", + "type": "array", + "items": { + "$ref": "#/definitions/PlanNotificationDetails" + } + } + } + }, + "StopSellNotifications": { + "description": "Stop sell notification details", + "type": "object", + "properties": { + "offerId": { + "description": "Gets offer id", + "type": "string" + }, + "displayName": { + "description": "Gets offer display name", + "type": "string" + }, + "isEntire": { + "description": "Gets a value indicating whether entire offer is in stop sell or only few of its plans", + "type": "boolean" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + }, + "icon": { + "description": "Gets or sets the icon url", + "type": "string" + }, + "plans": { + "description": "Gets or sets removed plans notifications", + "type": "array", + "items": { + "$ref": "#/definitions/PlanNotificationDetails" + } + } + } + }, + "PlanNotificationDetails": { + "description": "Plan notification details", + "type": "object", + "properties": { + "planId": { + "description": "Gets or sets the plan id", + "type": "string" + }, + "planDisplayName": { + "description": "Gets or sets the plan display name", + "type": "string" + } + } + }, + "RequestApprovalsDetails": { + "description": "Request approvals details", + "type": "object", + "properties": { + "offerId": { + "description": "Gets offer id", + "type": "string" + }, + "displayName": { + "description": "Gets offer display name", + "type": "string" + }, + "publisherId": { + "description": "Gets or sets publisher id", + "type": "string" + }, + "messageCode": { + "description": "Gets or sets the notification message id", + "type": "integer", + "format": "int64" + }, + "icon": { + "description": "Gets or sets the icon url", + "type": "string" + }, + "plans": { + "description": "Gets or sets removed plans notifications", + "type": "array", + "items": { + "$ref": "#/definitions/PlanNotificationDetails" + } + } + } + }, + "AcknowledgeOfferNotificationProperties": { + "description": "Notification update request payload", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AcknowledgeOfferNotificationDetails", + "description": "Notification update request payload details", + "x-ms-client-flatten": true + } + } + }, + "AcknowledgeOfferNotificationDetails": { + "description": "Notification update request payload details", + "type": "object", + "properties": { + "acknowledge": { + "description": "Gets or sets a value indicating whether acknowledge action flag is enabled", + "type": "boolean" + }, + "dismiss": { + "description": "Gets or sets a value indicating whether dismiss action flag is enabled", + "type": "boolean" + }, + "removeOffer": { + "description": "Gets or sets a value indicating whether remove offer action flag is enabled", + "type": "boolean" + }, + "addPlans": { + "description": "Gets or sets added plans", + "type": "array", + "items": { + "type": "string" + } + }, + "removePlans": { + "description": "Gets or sets remove plans", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "WithdrawProperties": { + "description": "Withdraw properties", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/WithdrawDetails", + "description": "Withdraw properties details", + "x-ms-client-flatten": true + } + } + }, + "WithdrawDetails": { + "description": "Withdraw properties details", + "type": "object", + "properties": { + "planId": { + "description": "Gets or sets Plan Id ", + "type": "string" + }, + "publisherId": { + "description": "The offer's publisher id", + "type": "string" + } + } + }, + "BillingAccountsResponse": { + "description": "Billing accounts response object", + "type": "object", + "properties": { + "billingAccounts": { + "description": "Billing accounts list", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TransferOffersProperties": { + "description": "Transfer offers properties", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TransferOffersDetails", + "description": "transfer offers properties details", + "x-ms-client-flatten": true + } + } + }, + "TransferOffersResponse": { + "description": "The transfer items response. The response contains two lists that indicate for each collection whether the operation succeeded or failed", + "type": "object", + "properties": { + "succeeded": { + "description": "Succeeded collections", + "type": "array", + "items": { + "$ref": "#/definitions/CollectionsDetails" + } + }, + "failed": { + "description": "Failed collections", + "type": "array", + "items": { + "$ref": "#/definitions/CollectionsDetails" + } + } + } + }, + "CollectionsDetails": { + "description": "Collection name and id.", + "type": "object", + "properties": { + "collectionName": { + "description": "Collection name.", + "type": "string" + }, + "collectionId": { + "description": "Collection id.", + "type": "string" + } + } + }, + "TransferOffersDetails": { + "description": "Transfer offers response details", + "type": "object", + "properties": { + "targetCollections": { + "description": "Target collections ids", + "type": "array", + "items": { + "type": "string" + } + }, + "operation": { + "description": "Operation to perform (For example: Copy or Move)", + "type": "string" + }, + "offerIdsList": { + "description": "Offers ids list to transfer from source collection to target collection(s)", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CollectionsToSubscriptionsMappingPayload": { + "description": "The subscriptions list to get the related collections", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingProperties", + "description": "Subscriptions ids list" + } + } + }, + "CollectionsToSubscriptionsMappingProperties": { + "description": "The subscriptions list to get the related collections", + "type": "object", + "properties": { + "subscriptionIds": { + "description": "Subscriptions ids list", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CollectionsToSubscriptionsMappingResponse": { + "description": "A map of collections subscriptions details", + "type": "object", + "properties": { + "details": { + "$ref": "#/definitions/CollectionsToSubscriptionsMappingResponseProperties", + "description": "The map of collections subscriptions" + } + } + }, + "CollectionsToSubscriptionsMappingResponseProperties": { + "description": "Collections - subscriptions mapping details, map key is collectionId. In case subscriptions list is null or empty: no subscription from the list is related to that collection.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/collectionsSubscriptionsMappingDetails" + } + }, + "collectionsSubscriptionsMappingDetails": { + "description": "Collection name and related subscriptions list", + "type": "object", + "properties": { + "collectionName": { + "description": "Collection name", + "type": "string" + }, + "subscriptions": { + "description": "Subscriptions ids list", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateStoreOperation": { + "description": "Set the Operation for the POST method. Ping or Delete", + "type": "string", + "enum": [ + "DeletePrivateStoreOffer", + "DeletePrivateStoreCollection", + "DeletePrivateStoreCollectionOffer", + "Ping" + ], + "x-ms-enum": { + "name": "Operation", + "modelAsString": true + } + }, + "OperationListResult": { + "description": "Result of the request to list Marketplace operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SingleOperation" + }, + "description": "List of Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + } + }, + "SingleOperation": { + "description": "Microsoft.Marketplace REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "description": "Service provider: Microsoft.Marketplace", + "type": "string" + }, + "resource": { + "readOnly": true, + "description": "Resource on which the operation is performed", + "type": "string" + }, + "operation": { + "readOnly": true, + "description": "Operation type", + "type": "string" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "ErrorResponse": { + "description": "Error response indicates Microsoft.Marketplace service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "Resource": { + "description": "An Azure resource.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true, + "description": "Metadata pertaining to creation and last modification of the resource" + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Read only system data", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AcknowledgeNotification.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AcknowledgeNotification.json new file mode 100644 index 000000000000..f137c4adc7ee --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AcknowledgeNotification.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "removePlans": [ + "testPlanA" + ], + "addPlans": null, + "acknowledge": false, + "dismiss": false, + "removeOffer": false + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AdminRequestApprovalsList.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AdminRequestApprovalsList.json new file mode 100644 index 000000000000..b0c503b942aa --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/AdminRequestApprovalsList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/adminRequestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "/providers/Microsoft.Marketplace/privateStores/adminRequestApprovals", + "properties": { + "publisherId": "marketplacetestthirdparty", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "displayName": "Offer display name", + "plans": [ + { + "planId": "testA", + "planDisplayName": "Plan display name A", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "Because I want to....", + "subscriptionId": "404a1952-706a-453a-989b-647cc4ca5f9c", + "subscriptionName": "Test subscription" + } + ] + }, + { + "planId": "*", + "planDisplayName": "* (this means the user requested any plan, here you will get only *)", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "try me :)", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ] + } + ], + "adminAction": "Pending", + "collectionIds": [], + "approvedPlans": null, + "comment": null, + "administrator": null + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BillingAccounts.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BillingAccounts.json new file mode 100644 index 000000000000..a47233b0f34b --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/BillingAccounts.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "billingAccounts": [ + "Billing Account 1", + "Billing Account 2" + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CollectionsToSubscriptionsMapping.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CollectionsToSubscriptionsMapping.json new file mode 100644 index 000000000000..c746ec91b65e --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CollectionsToSubscriptionsMapping.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01", + "payload": { + "properties": { + "subscriptionIds": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + } + } + }, + "responses": { + "200": { + "body": { + "details": { + "4eb49758-f591-486f-bd58-dff00fb7a8d8": { + "collectionName": "Test Collection", + "subscriptions": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + }, + "74c02e27-2524-436c-831d-d64565f31153": { + "collectionName": "Test Collection 2", + "subscriptions": null + } + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreateApprovalRequest.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreateApprovalRequest.json new file mode 100644 index 000000000000..bba8ec0901b7 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreateApprovalRequest.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "RequestApprovalResource": { + "parameters": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "plansDetails": [ + { + "planId": "testPlanA", + "justification": "Because I want to....", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + }, + { + "planId": "*", + "justification": "try me :)", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/9afd3c45-5230-4d58-9469-2cacc00bba68/requestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/requestApprovals", + "properties": { + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "offerDisplayName": "Offer Display name", + "plansDetails": [ + { + "planId": "testPlanA", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "Because I want to....", + "status": "Pending", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + }, + { + "planId": "*", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "try me :)", + "status": "Pending", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ], + "isClosed": false, + "messageCode": 0 + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreatePrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreatePrivateStoreCollection.json new file mode 100644 index 000000000000..96227de205f7 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/CreatePrivateStoreCollection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "api-version": "2020-01-01", + "payload": { + "properties": { + "collectionName": "Test Collection", + "claim": "", + "allSubscriptions": false, + "subscriptionsList": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "properties": { + "collectionName": "Test Collection", + "claim": "", + "allSubscriptions": false, + "subscriptionsList": [ + "b340914e-353d-453a-85fb-8f9b65b51f91", + "f2baa04d-5bfc-461b-b6d8-61b403c9ec48" + ] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-04-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-04-01T10:23:17.6571572+02:00" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStore.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStore.json new file mode 100644 index 000000000000..ebd18418a757 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStore.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreCollection.json new file mode 100644 index 000000000000..abbcf1c3f409 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreCollection.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "d0f5aa2c-ecc3-4d87-906a-f8c486dcc4f1", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreOffer.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreOffer.json new file mode 100644 index 000000000000..18d270636eef --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/DeletePrivateStoreOffer.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetAdminRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetAdminRequestApproval.json new file mode 100644 index 000000000000..c8f500036c7a --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetAdminRequestApproval.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "adminRequestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/adminRequestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "/providers/Microsoft.Marketplace/privateStores/adminRequestApprovals", + "properties": { + "publisherId": "marketplacetestthirdparty", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "displayName": "Offer display name", + "plans": [ + { + "planId": "testA", + "planDisplayName": "Plan display name A", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "Because I want to....", + "subscriptionId": "1fs4r5t6-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 1" + } + ] + }, + { + "planId": "*", + "planDisplayName": "* (this means the user requested any plan, here you will get only *)", + "requesters": [ + { + "user": "testUser3", + "date": "2021-02-01T11:42:12.9526511+02:00", + "justification": "try me :)", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + ] + } + ], + "adminAction": "Pending", + "approvedPlans": null, + "comment": null, + "administrator": null, + "collectionIds": [] + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetApprovalRequestsList.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetApprovalRequestsList.json new file mode 100644 index 000000000000..bca9c63a358e --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetApprovalRequestsList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + }, + "id": "/providers/Microsoft.Marketplace/privateStores/9afd3c45-5230-4d58-9469-2cacc00bba68/requestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/requestApprovals", + "properties": { + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "offerDisplayName": "Offer Display name", + "plansDetails": [ + { + "planId": "testPlanA", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "Because I want to....", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + }, + { + "planId": "*", + "requestDate": "2021-02-01T10:23:17.6571572+02:00", + "justification": "try me :)", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + } + ], + "isClosed": false, + "messageCode": 0 + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStore.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStore.json new file mode 100644 index 000000000000..7072c63294a8 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStore.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "type": "Microsoft.Marketplace/privateStores", + "name": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "properties": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "availability": "enabled", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350345\"", + "tenantId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "isGov": false, + "collectionIds": [ + "ab80ed4-c5de-4593-b3c1-c46d4a3a56c7", + "a09107d4-c585-4594-b3c6-c46d4a3a56c8" + ], + "branding": { + "iconUrl": "https://some-images.someDomail.com/image/stroeIcon.12345678-4321", + "color": "blue" + } + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollection.json new file mode 100644 index 000000000000..b22ddf888ee6 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "properties": { + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "collectionName": "Default Collection", + "claim": "", + "allSubscriptions": true, + "subscriptionsList": [] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionOffer.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionOffer.json new file mode 100644 index 000000000000..42f75801c08e --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionOffer.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350000\"", + "specificPlanIdsLimitation": [ + "0001", + "0002", + "0003" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionsList.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionsList.json new file mode 100644 index 000000000000..eb3a1a5eb662 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreCollectionsList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "properties": { + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "collectionName": "Default Collection", + "claim": "", + "allSubscriptions": true, + "subscriptionsList": [] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + } + }, + { + "id": "providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections", + "type": "Microsoft.Marketplace/privateStores/collections", + "name": "fba3f52c-874a-4010-87cf-c1cfa6ed3490", + "properties": { + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "collectionName": "Dev collection", + "claim": "", + "allSubscriptions": false, + "subscriptionsList": [ + "7c927b63-59cf-4a0f-9d13-41e11f1ddf76" + ] + }, + "systemData": { + "createdBy": "user@somedoamin.com", + "createdByType": "User", + "createdAt": "2021-02-01T10:23:17.6571572+02:00", + "lastModifiedBy": "user@somedoamin.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-02-01T10:23:17.6571572+02:00" + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreOffers.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreOffers.json new file mode 100644 index 000000000000..2f5b918a97f6 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStoreOffers.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350000\"", + "specificPlanIdsLimitation": [ + "0001", + "0002", + "0003" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + }, + { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-3", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-3", + "offerDisplayName": "md-test-third-party-3", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0304-5e248b350043\"", + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStores.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStores.json new file mode 100644 index 000000000000..b282178aafcc --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetPrivateStores.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "type": "Microsoft.Marketplace/privateStores", + "name": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "properties": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "availability": "enabled", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350332\"", + "tenantId": "f686d426-123a-42db-81b7-ab578e110ccd", + "isGov": false, + "collectionIds": [ + "ab80ed4-c5de-4593-b3c1-c46d4a3a56c7", + "a09107d4-c585-4594-b3c6-c46d4a3a56c8" + ], + "branding": { + "iconUrl": "https://some-images.someDomail.com/image/stroeIcon.12345678-4321", + "color": "blue" + } + } + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetRequestApproval.json new file mode 100644 index 000000000000..b34c25f9d4eb --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/GetRequestApproval.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/requestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/requestApprovals", + "systemData": { + "createdBy": "test@somedomain.com", + "createdByType": "User", + "createdAt": "2020-10-05T17:18:19.1234567Z", + "lastModifiedBy": "testuser@somedomail.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-10-05T17:18:19.1234567Z" + }, + "properties": { + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "publisherId": "marketplacetestthirdparty", + "offerDisplayName": "Offer display Name", + "plansDetails": [ + { + "planId": "testPlanA", + "justification": "Because I want to....", + "requestDate": "2020-10-05T17:18:19.1234567Z", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + }, + { + "planId": "testPlanB", + "justification": "Because I want to....", + "requestDate": "2020-10-05T17:18:19.1234567Z", + "status": "Pending", + "subscriptionId": "", + "subscriptionName": "" + } + ], + "isClosed": false, + "messageCode": 0 + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/NotificationsState.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/NotificationsState.json new file mode 100644 index 000000000000..ae0eefc41f1c --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/NotificationsState.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "stopSellNotifications": [ + { + "offerId": "publisherId.legacyId", + "displayName": "Offer display name", + "isEntire": false, + "plans": [ + { + "planDisplayName": "test123", + "planId": "aaa" + } + ], + "messageCode": 10002, + "icon": "https://some-images.someDomail.com/image/apps.12345678-4321" + }, + { + "offerId": "publisherIdB.legacyIdB", + "displayName": "Offer display name B", + "isEntire": true, + "plans": null, + "messageCode": 10003, + "icon": "https://some-images.someDomail.com/image/apps.12345678-7654" + } + ], + "newNotifications": [ + { + "offerId": "publisherIdC.legacyIdC", + "displayName": "Offer display name C", + "isFuturePlansEnabled": false, + "plans": [ + { + "planDisplayName": "Display Name Test", + "planId": "plan-test" + } + ], + "messageCode": 10000, + "icon": "https://some-images.someDomail.com/image/apps.12345678-76545678" + } + ], + "approvalRequests": [ + { + "publisherId": "publisherId", + "offerId": "publisherId.legacyId", + "displayName": "Offer display name", + "plans": [ + { + "planDisplayName": "Plan Test display name", + "planId": "test-plan" + }, + { + "planDisplayName": "Plan Test display name B", + "planId": "test-planB" + } + ], + "icon": "https://some-images.someDomail.com/image/apps.12345678-09876567894321", + "messageCode": 0 + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollection.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollection.json new file mode 100644 index 000000000000..64651d20ebf4 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollection.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01", + "Operation": "DeletePrivateStoreCollection" + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollectionOffer.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollectionOffer.json new file mode 100644 index 000000000000..bafcf4549639 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PostPrivateStoreCollectionOffer.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "Operation": "DeletePrivateStoreCollectionOffer" + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStoreOffer_update.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStoreOffer_update.json new file mode 100644 index 000000000000..9b8b29d39878 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStoreOffer_update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350666\"" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/collections/56a1a02d-8cf8-45df-bf37-d5f7120fcb3d/offers/marketplacetestthirdparty.md-test-third-party-2", + "type": "Microsoft.Marketplace/privateStores/collections/offers", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "properties": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350666\"", + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStores_update.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStores_update.json new file mode 100644 index 000000000000..645637a74268 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/PrivateStores_update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01", + "payload": { + "properties": { + "availability": "disabled", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350345\"" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryOffers.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryOffers.json new file mode 100644 index 000000000000..3705158dfb11 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryOffers.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "api-version": "2021-06-01" + }, + "responses": { + "200": { + "body": { + "nextLink": "", + "value": [ + { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "offerDisplayName": "md-test-third-party-2", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0000-5e248b350000\"", + "specificPlanIdsLimitation": [ + "0001", + "0002", + "0003" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + }, + { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-3", + "offerDisplayName": "md-test-third-party-3", + "publisherDisplayName": "Marketplace Test Third Party", + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "eTag": "\"9301f4fd-0000-0100-0304-5e248b350043\"", + "specificPlanIdsLimitation": [ + "0001", + "0002" + ], + "modifiedAt": "05/29/2015 5:50", + "createdAt": "05/28/2015 5:50" + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryRequestApproval.json new file mode 100644 index 000000000000..5241f6ec23d6 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/QueryRequestApproval.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "planIds": [ + "testPlanA", + "testPlanB", + "*" + ] + } + } + }, + "responses": { + "200": { + "body": { + "uniqueOfferId": "marketplacetestthirdparty.md-test-third-party-2", + "plansDetails": { + "*": { + "planId": "*", + "status": "None", + "requestDate": null, + "justification": null, + "subscriptionId": "", + "subscriptionName": "" + }, + "byol": { + "planId": "testPlanA", + "status": "None", + "requestDate": null, + "justification": "", + "subscriptionId": "", + "subscriptionName": "" + }, + "hourly": { + "planId": "testPlanB", + "status": "ApprovedByAdmin", + "requestDate": null, + "justification": "", + "subscriptionId": "4ca4753c-5a1e-4913-b849-2c68880e03c2", + "subscriptionName": "Test subscription 2" + } + }, + "etag": null, + "messageCode": 0 + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/TransferOffers.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/TransferOffers.json new file mode 100644 index 000000000000..30d11e8a37bb --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/TransferOffers.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "collectionId": "56a1a02d-8cf8-45df-bf37-d5f7120fcb3d", + "api-version": "2021-06-01", + "payload": { + "properties": { + "targetCollections": [ + "c752f021-1c37-4af5-b82f-74c51c27b44a", + "f47ef1c7-e908-4f39-ae29-db181634ad8d" + ], + "operation": "copy", + "offerIdsList": [ + "marketplacetestthirdparty.md-test-third-party-2", + "marketplacetestthirdparty.md-test-third-party-3" + ] + } + } + }, + "responses": { + "200": { + "body": { + "succeeded": [ + { + "collectionId": "c752f021-1c37-4af5-b82f-74c51c27b44a", + "collectionName": "Test collection" + } + ], + "failed": [ + { + "collectionId": "f47ef1c7-e908-4f39-ae29-db181634ad8d", + "collectionName": "Test collection 2" + } + ] + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/UpdateAdminRequestApproval.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/UpdateAdminRequestApproval.json new file mode 100644 index 000000000000..a0f9c0fbb757 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/UpdateAdminRequestApproval.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "adminRequestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "adminAction": "Approved", + "approvedPlans": [ + "testPlan" + ], + "comment": "I'm ok with that", + "collectionIds": [ + "f8ee227e-85d7-477d-abbf-854d6decaf70", + "39246ad6-c521-4fed-8de7-77dede2e873f" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Marketplace/privateStores/a0e28e55-90c4-41d8-8e34-bb7ef7775406/adminRequestApprovals/marketplacetestthirdparty.md-test-third-party-2", + "name": "marketplacetestthirdparty.md-test-third-party-2", + "type": "/providers/Microsoft.Marketplace/privateStores/adminRequestApprovals", + "systemData": { + "createdBy": "test@somedomain.com", + "createdByType": "User", + "createdAt": "2020-10-05T17:18:19.1234567Z", + "lastModifiedBy": "testuser@somedomail.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-10-05T17:18:19.1234567Z" + }, + "properties": { + "publisherId": "marketplacetestthirdparty", + "offerId": "marketplacetestthirdparty.md-test-third-party-2", + "displayName": "Offer display name", + "plans": null, + "adminAction": "Approved", + "approvedPlans": [ + "testPlan" + ], + "collectionIds": [ + "f8ee227e-85d7-477d-abbf-854d6decaf70", + "39246ad6-c521-4fed-8de7-77dede2e873f" + ], + "comment": "I'm ok with that", + "administrator": "admin@someDomain.com" + } + } + } + } +} diff --git a/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/WithdrawPlan.json b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/WithdrawPlan.json new file mode 100644 index 000000000000..9aabe2f18dc1 --- /dev/null +++ b/specification/marketplace/resource-manager/Microsoft.Marketplace/stable/2021-06-01/examples/WithdrawPlan.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "privateStoreId": "a0e28e55-90c4-41d8-8e34-bb7ef7775406", + "requestApprovalId": "marketplacetestthirdparty.md-test-third-party-2", + "api-version": "2021-06-01", + "payload": { + "properties": { + "publisherId": "marketplacetestthirdparty", + "planId": "*" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/marketplace/resource-manager/readme.md b/specification/marketplace/resource-manager/readme.md index 06a8de6c4d7d..c33d257083e0 100644 --- a/specification/marketplace/resource-manager/readme.md +++ b/specification/marketplace/resource-manager/readme.md @@ -26,12 +26,25 @@ These are the global settings for the Marketplace API. ``` yaml openapi-type: arm -tag: package-2020-01-01 +tag: package-2021-06-01 ``` ### Composite packages The following packages may be composed from multiple api-versions. +### Tag: package-composite-v2 + +These settings apply only when `--tag=package-composite-v2` is specified on the command line. + +This section contains the "composite-v2" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v1" clients. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +``` yaml $(tag) == 'package-composite-v2' +input-file: +- Microsoft.Marketplace/stable/2021-06-01/Marketplace.json +``` + ### Tag: package-composite-v1 These settings apply only when `--tag=package-composite-v1` is specified on the command line. @@ -50,22 +63,31 @@ override-info: title: MarketplaceManagementClient ``` -### Tag: package-2019-12-01 +### Tag: package-2020-01-01 -These settings apply only when `--tag=package-2019-12-01` is specified on the command line. +These settings apply only when `--tag=package-2020-01-01` is specified on the command line. -``` yaml $(tag) == 'package-2019-12-01' +``` yaml $(tag) == 'package-2020-01-01' input-file: - - Microsoft.Marketplace/stable/2019-12-01/Marketplace.json + - Microsoft.Marketplace/stable/2020-01-01/Marketplace.json ``` -### Tag: package-2020-01-01 +### Tag: package-2020-12-01 -These settings apply only when `--tag=package-2020-01-01` is specified on the command line. +These settings apply only when `--tag=package-2020-12-01` is specified on the command line. -``` yaml $(tag) == 'package-2020-01-01' +``` yaml $(tag) == 'package-2020-12-01' input-file: - - Microsoft.Marketplace/stable/2020-01-01/Marketplace.json + - Microsoft.Marketplace/stable/2020-12-01/Marketplace.json +``` + +### Tag: package-2021-06-01 + +These settings apply only when `--tag=package-2021-06-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-06-01' +input-file: + - Microsoft.Marketplace/stable/2021-06-01/Marketplace.json ``` # Code Generation