取得客戶清單
適用于:合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |適用于 Microsoft Cloud for US Government 的合作夥伴中心
本文說明如何取得代表所有合作夥伴客戶的資源集合。
提示
您也可以在合作夥伴中心執行這項作業。 在 [首頁] 頁面上,選取 [ 客戶] 工作區,然後使用功能表中的 [ 客戶] 清單 來檢視客戶。
必要條件
- 認證,如合作夥伴中心驗證所述。 此案例支援使用獨立應用程式和 App+使用者認證進行驗證。
C#
若要取得所有客戶的清單:
使用 IAggregatePartner.Customers 集合來建立 IPartner 物件。
使用 Query () 或 QueryAsync () 方法擷取客戶清單。 (如需建立查詢的指示,請參閱 QueryFactory 類別.)
// IAggregatePartner partnerOperations;
// All the operations executed on this partner operation instance will share the same correlation Id but will differ in request Id
IPartner scopedPartnerOperations = partnerOperations.With(RequestContextFactory.Instance.Create(Guid.NewGuid()));
// read customers into chunks of 40s
var customersBatch = scopedPartnerOperations.Customers.Query(QueryFactory.Instance.BuildIndexedQuery(40));
var customersEnumerator = scopedPartnerOperations.Enumerators.Customers.Create(customersBatch);
如需範例,請參閱下列各項:
- 範例: 主控台測試應用程式
- 專案: PartnerSDK.FeatureSamples
- 類別: CustomerPaging.cs
Java
合作夥伴中心 JAVA SDK可用來管理合作夥伴中心資源。 這是由合作夥伴社群維護的開放原始碼專案,Microsoft 未正式支援。 如果您遇到問題,可以從社群取得協助或在 GitHub 上提出問題。
若要取得所有客戶的清單:
使用 [IAggregatePartner.getCustomers] 函式來取得客戶作業的參考。
使用 查詢 () 函式擷取客戶清單。
// Query the customers, get the first page if a page size was set, otherwise get all customers
SeekBasedResourceCollection<Customer> customersPage = partnerOperations.getCustomers().query(QueryFactory.getInstance().buildIndexedQuery(40));
// Create a customer enumerator which will aid us in traversing the customer pages
IResourceCollectionEnumerator<SeekBasedResourceCollection<Customer>> customersEnumerator =
partnerOperations.getEnumerators().getCustomers().create( customersPage );
int pageNumber = 1;
while (customersEnumerator.hasValue())
{
/*
* Use the customersEnumerator.getCurrent() function to
* access the current page of customers.
*/
// Get the next page of customers
customersEnumerator.next();
}
PowerShell
合作夥伴中心 PowerShell 模組可用來管理合作夥伴中心資源。 這是由合作夥伴社群維護的開放原始碼專案,Microsoft 未正式支援。 如果您遇到問題,可以從社群取得協助或在 GitHub 上提出問題。
執行沒有參數的 Get-PartnerCustomer 命令,以取得完整的客戶清單。
Get-PartnerCustomer
REST 要求
要求的語法
方法 | 要求 URI |
---|---|
GET | {baseURL}/v1/customers?size={size} HTTP/1.1 |
URI 參數
使用下列查詢參數來取得客戶清單。
名稱 | 類型 | 必要 | 描述 |
---|---|---|---|
size | int | Y | 要一次顯示的結果數目。 |
要求標頭
如需詳細資訊,請參閱合作夥伴中心 REST 標頭。
要求本文
無。
要求範例
GET https://api.partnercenter.microsoft.com/v1/customers?size=40 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 3705fc6d-4127-4a87-bdba-9658f73fe019
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
REST 回應
如果成功,這個方法會在回應本文中傳回 Customer 資源的集合。
回應成功和錯誤碼
每個回應都隨附 HTTP 狀態碼,會指出成功與否以及其他的偵錯資訊。 請使用網路追蹤工具來讀取此錯誤碼、錯誤類型和其他參數。 如需完整清單,請參閱 錯誤碼。
回應範例
HTTP/1.1 200 OK
Content-Length: 15650
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 3705fc6d-4127-4a87-bdba-9658f73fe019
Date: Fri, 20 Nov 2015 01:08:23 GMT
{
"totalCount": 2,
"items": [{
"id": "b44bb1fb-c595-45b0-9e09-d657365580bf",
"companyProfile": {
"tenantId": "<guid>",
"domain": "domain",
"companyName": "companyName",
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"relationshipToPartner": "reseller",
"attributes": {
"objectType": "Customer"
}
},
{
"id": "45c44870-ef77-4fdd-b6fe-3dacb075cff2",
"companyProfile": {
"tenantId": "<guid>",
"domain": "domain",
"companyName": "companyName",
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"relationshipToPartner": "reseller",
"attributes": {
"objectType": "Customer"
}
}],
"links": {
"self": {
"uri": "/v1/customers?size=40",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}