Skip to content

Commit 744e3de

Browse files
authored
Merge pull request #110768 from anbene/api-docs
Updating CPP API Docs
2 parents 5867962 + 4d16ab7 commit 744e3de

14 files changed

+141
-101
lines changed

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-cancel-operations.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,14 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: reference
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

12-
# Cancel operation
12+
# Cancel operation
13+
14+
> [!NOTE]
15+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the changes listed in [Cloud Partner Portal API Reference](https://docs.microsoft.com/azure/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview) to ensure your code continues to work after the migration to Partner Center.
1316
1417
This API cancels an operation currently in progress on the offer. Use the [Retrieve operations
1518
API](./cloud-partner-portal-api-retrieve-operations.md) to get an
@@ -18,13 +21,10 @@ operation, however in some complex scenarios a new operation may be
1821
required to cancel an existing one. In this case, the HTTP response body
1922
contains the operation's location that should be used to query status.
2023

21-
You can provide a comma-separated list of email addresses with the
22-
request, and the API will notify these addresses about the progress of
23-
the operation.
24-
2524
`POST https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/cancel?api-version=2017-10-31`
2625

27-
URI parameters
26+
## URI parameters
27+
2828
--------------
2929

3030
| **Name** | **Description** | **Data type** |
@@ -34,8 +34,7 @@ URI parameters
3434
| api-version | Current version of API | Date |
3535
| | | |
3636

37-
38-
Header
37+
## Header
3938
------
4039

4140
| **Name** | **Value** |
@@ -44,8 +43,7 @@ Header
4443
| Authorization | Bearer YOUR TOKEN |
4544
| | |
4645

47-
48-
Body example
46+
## Body example
4947
------------
5048

5149
### Request
@@ -65,20 +63,23 @@ Body example
6563
| notification-emails | Comma separated list of email Ids to be notified of the progress of the publishing operation. |
6664
| | |
6765

68-
6966
### Response
7067

71-
`Operation-Location: https://cloudpartner.azure.com/api/publishers/contoso/offers/contoso-virtualmachineoffer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8`
68+
#### Migrated offers
69+
70+
`Location: /api/publishers/contoso/offers/contoso-offer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8?api-version=2017-10-31`
7271

72+
#### Non-migrated offers
73+
74+
`Location: /api/operations/contoso$contoso-offer$2$preview?api-version=2017-10-31`
7375

7476
### Response Header
7577

7678
| **Name** | **Value** |
7779
| --------- | ---------- |
78-
| Operation-Location | URL, which can be queried to determine the current status of the operation. |
80+
| Location | The relative path to retrieve this operation's status. |
7981
| | |
8082

81-
8283
### Response status codes
8384

8485
| **Code** | **Description** |

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-concurrency-control.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: conceptual
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

1212
# Concurrency Control
1313

14+
> [!NOTE]
15+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the changes listed in [Cloud Partner Portal API Reference](https://docs.microsoft.com/azure/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview) to ensure your code continues to work after the migration to Partner Center.
16+
1417
Every call to the Cloud Partner Portal publishing APIs must explicitly
1518
specify which concurrency control strategy to use. Failure to provide
1619
the **If-Match** header will result in an HTTP 400 error response. We

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-considerations.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,18 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: conceptual
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

1212
# API Considerations
1313

14-
1514
API versioning
1615
--------------
1716

17+
> [!NOTE]
18+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the changes listed in [Cloud Partner Portal API Reference](https://docs.microsoft.com/azure/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview) to ensure your code continues to work after the migration to Partner Center.
19+
1820
There may be multiple versions of the API that are available at the same
1921
time. Clients must indicate which version they wish to invoke use by
2022
providing the `api-version` parameter as part of the query string.

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-creating-offer.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: reference
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

1212
Create or modify an offer
1313
=========================
1414

15+
> [!NOTE]
16+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the changes listed in [Cloud Partner Portal API Reference](https://docs.microsoft.com/azure/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview) to ensure your code continues to work after the migration to Partner Center.
17+
1518
This call updates a specific offer within the publisher namespace or creates a new offer.
1619

1720
`PUT https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>?api-version=2017-10-31`

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-go-live.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,22 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: reference
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

12-
Go Live
13-
=======
12+
# Go Live
13+
14+
> [!NOTE]
15+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the changes listed in [Cloud Partner Portal API Reference](https://docs.microsoft.com/azure/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview) to ensure your code continues to work after the migration to Partner Center.
1416
1517
This API starts the process for pushing an app to production. This operation is usually
1618
long-running. This call uses the notification email list
1719
from the [Publish](./cloud-partner-portal-api-publish-offer.md) API operation.
1820

1921
`POST https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/golive?api-version=2017-10-31`
2022

21-
URI parameters
23+
## URI parameters
2224
--------------
2325

2426
| **Name** | **Description** | **Data type** |
@@ -28,8 +30,7 @@ URI parameters
2830
| api-version | Latest version of the API | Date |
2931
| | | |
3032

31-
32-
Header
33+
## Header
3334
------
3435

3536
| **Name** | **Value** |
@@ -38,23 +39,25 @@ Header
3839
| Authorization | `Bearer YOUR_TOKEN` |
3940
| | |
4041

41-
42-
Body example
43-
------------
42+
## Body example
4443

4544
### Response
4645

47-
`Operation-Location: https://cloudpartner.azure.com/api/publishers/contoso/offers/contoso-virtualmachineoffer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8`
46+
#### Migrated offers
4847

48+
`Location: /api/publishers/contoso/offers/contoso-offer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8?api-version=2017-10-31`
49+
50+
#### Non-migrated offers
51+
52+
`Location: /api/operations/contoso$contoso-offer$2$preview?api-version=2017-10-31`
4953

5054
### Response Header
5155

5256
| **Name** | **Value** |
5357
| -------- | ---------- |
54-
| Operation-Location | URL to query to determine the current status of the operation |
58+
| Location | The relative path to retrieve this operation's status |
5559
| | |
5660

57-
5861
### Response status codes
5962

6063
| **Code** | **Description** |

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: conceptual
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

1212

13-
Cloud Partner Portal API Reference
14-
==================================
13+
# Cloud Partner Portal API Reference
14+
15+
> [!NOTE]
16+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the [Changes to CPP APIs](#changes-to-cpp-apis-after-the-migration-to-partner-center) listed in this document to ensure your code continues to work after the migration to Partner Center.
1517
1618
The Cloud Partner Portal REST APIs allow the programmatic retrieval and
1719
manipulation of workloads, offers, and publisher profiles. The APIs use
@@ -21,47 +23,48 @@ This reference provides the technical details for the Cloud Partner
2123
Portal REST APIs. The payload samples in this document are for reference
2224
only and are subject to change as new functionality is added.
2325

24-
25-
Prerequisites and considerations
26-
-------------------------------
26+
## Prerequisites and considerations
2727

2828
Before using the APIs, you should review:
2929

3030
- The [Prerequisites](./cloud-partner-portal-api-prerequisites.md) article to
3131
learn how to add a service principal to your account, and get an
32-
Azure Active Directory (Azure AD) access token for authentication.
33-
- The two [concurrency control](./cloud-partner-portal-api-concurrency-control.md).
34-
strategies available for calling these APIs.
35-
- Additional API [considerations](./cloud-partner-portal-api-considerations.md), such as
36-
versioning and error handling.
32+
Azure Active Directory (Azure AD) access token for authentication.
33+
- The two [concurrency control](./cloud-partner-portal-api-concurrency-control.md) strategies available for calling these APIs.
34+
- Additional API [considerations](./cloud-partner-portal-api-considerations.md), such as versioning and error handling.
3735

36+
## Changes to CPP APIs after the migration to Partner Center
3837

39-
Common tasks
40-
------------
41-
This reference details APIs to perform the following common tasks.
38+
| **API** | **Change description** | **Impact** |
39+
| ------- | ---------------------- | ---------- |
40+
| POST Publish, GoLive, Cancel | For migrated offers, the response header will have a different format but will continue to work in the same way, denoting a relative path to retrieve the operation status. | When sending any of the corresponding POST requests for an offer, the Location header will have one of two format depending on the migration status of the offer:<ul><li>Non-migrated offers<br>`/api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31`</li><li>Migrated offers<br>`/api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31`</li> |
41+
| GET Operation | For offer types that previously supported 'notification-email' field in the response, this field will be deprecated and no longer returned for migrated offers. | For migrated offers, we'll no longer send notifications to the list of emails specified in the requests. Instead, the API service will align with the notification email process in Partner Center to send emails. Specifically, notifications will be sent to the email address set in the Seller contact info section of your Account settings in Partner Center, to notify you of operation progress.<br><br>Please review the email address set in the Seller contact info section of your [Account settings](https://partner.microsoft.com/dashboard/account/management) in Partner Center to ensure the correct email is provided for notifications. |
4242

43+
## Common tasks
44+
45+
This reference details APIs to perform the following common tasks.
4346

4447
### Offers
4548

46-
- [Retrieve all offers](./cloud-partner-portal-api-retrieve-offers.md)
47-
- [Retrieve a specific offer](./cloud-partner-portal-api-retrieve-specific-offer.md)
48-
- [Retrieve offer status](./cloud-partner-portal-api-retrieve-offer-status.md)
49-
- [Create an offer](./cloud-partner-portal-api-creating-offer.md)
50-
- [Publish an offer](./cloud-partner-portal-api-publish-offer.md)
49+
- [Retrieve all offers](./cloud-partner-portal-api-retrieve-offers.md)
50+
- [Retrieve a specific offer](./cloud-partner-portal-api-retrieve-specific-offer.md)
51+
- [Retrieve offer status](./cloud-partner-portal-api-retrieve-offer-status.md)
52+
- [Create an offer](./cloud-partner-portal-api-creating-offer.md)
53+
- [Publish an offer](./cloud-partner-portal-api-publish-offer.md)
5154

5255
### Operations
5356

54-
- [Retrieve operations](./cloud-partner-portal-api-retrieve-operations.md)
55-
- [Cancel operations](./cloud-partner-portal-api-cancel-operations.md)
57+
- [Retrieve operations](./cloud-partner-portal-api-retrieve-operations.md)
58+
- [Cancel operations](./cloud-partner-portal-api-cancel-operations.md)
5659

5760
### Publish an app
5861

59-
- [Go live](./cloud-partner-portal-api-go-live.md)
62+
- [Go live](./cloud-partner-portal-api-go-live.md)
6063

6164
### Other tasks
6265

63-
- [Set pricing for virtual machine offers](./cloud-partner-portal-api-setting-price.md)
66+
- [Set pricing for virtual machine offers](./cloud-partner-portal-api-setting-price.md)
6467

6568
### Troubleshooting
6669

67-
- [Troubleshooting authentication errors](./cloud-partner-portal-api-troubleshooting-authentication-errors.md)
70+
- [Troubleshooting authentication errors](./cloud-partner-portal-api-troubleshooting-authentication-errors.md)

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-prerequisites.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: conceptual
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

1212

1313
API Prerequisites
1414
================
1515

16+
> [!NOTE]
17+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the changes listed in [Cloud Partner Portal API Reference](https://docs.microsoft.com/azure/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview) to ensure your code continues to work after the migration to Partner Center.
18+
1619
There are two required programmatic assets that you need to use the Cloud Partner Portal APIs: a service principal and an Azure Active Directory (Azure AD) access token.
1720

1821

@@ -40,7 +43,7 @@ Use the following steps to add the service principal:
4043

4144
- A **Friendly Name** for the service principal, for example `spAccount`.
4245
- The **Application ID**. To find this identifier, go to the [Azure
43-
Portal](https://portal.azure.com), click **Azure Active Directory**,
46+
portal](https://portal.azure.com), click **Azure Active Directory**,
4447
choose **App registrations**, and click on your app.
4548
- The **Tenant ID**, also known as the **Directory ID**, for your
4649
Azure AD tenant. You can find this identifier in the Azure Active Directory

articles/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-publish-offer.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@ author: dsindona
55
ms.service: marketplace
66
ms.subservice: partnercenter-marketplace-publisher
77
ms.topic: reference
8-
ms.date: 09/13/2018
8+
ms.date: 04/08/2020
99
ms.author: dsindona
1010
---
1111

1212

13-
Publish an offer
14-
================
13+
# Publish an offer
14+
15+
> [!NOTE]
16+
> The Cloud Partner Portal APIs are integrated with Partner Center and will continue to work after your offers are migrated to Partner Center. The integration introduces small changes. Review the changes listed in [Cloud Partner Portal API Reference](https://docs.microsoft.com/azure/marketplace/cloud-partner-portal-orig/cloud-partner-portal-api-overview) to ensure your code continues to work after the migration to Partner Center.
1517
1618
Starts the publishing process for the specified offer. This call is a long running operation.
1719

1820
`POST https://cloudpartner.azure.com/api/publishers/<publisherId>/offers/<offerId>/publish?api-version=2017-10-31`
1921

20-
URI parameters
22+
## URI parameters
2123
--------------
2224

2325
| **Name** | **Description** | **Data type** |
@@ -27,8 +29,7 @@ URI parameters
2729
| api-version | Latest version of the API | Date |
2830
| | |
2931

30-
31-
Header
32+
## Header
3233
------
3334

3435
| **Name** | **Value** |
@@ -38,7 +39,7 @@ Header
3839
| | |
3940

4041

41-
Body example
42+
## Body example
4243
------------
4344

4445
### Request
@@ -62,14 +63,20 @@ Body example
6263

6364
### Response
6465

65-
`Operation-Location: /api/operations/contoso$56615b67-2185-49fe-80d2-c4ddf77bb2e8$2$preview?api-version=2017-10-31`
66+
#### Migrated offers
67+
68+
`Location: /api/publishers/contoso/offers/contoso-offer/operations/56615b67-2185-49fe-80d2-c4ddf77bb2e8?api-version=2017-10-31`
69+
70+
#### Non-migrated offers
71+
72+
`Location: /api/operations/contoso$contoso-offer$2$preview?api-version=2017-10-31`
6673

6774

6875
### Response Header
6976

7077
| **Name** | **Value** |
7178
| -------------------- | ---------------------------------------------------------------------------- |
72-
| Operation-Location | URL that can be queried to determine the current status of the operation. |
79+
| Location | The relative path to retrieve this operation's status |
7380
| | |
7481

7582

0 commit comments

Comments
 (0)