Hämta en lista över kunder
Gäller för: Partnercenter | Partnercenter som drivs av 21Vianet | Partnercenter för Microsoft Cloud for US Government
Den här artikeln beskriver hur du hämtar en samling resurser som representerar alla en partners kunder.
Tips
Du kan också utföra den här åtgärden i Partnercenter. På sidan Start väljer du arbetsytan Kunder och visar sedan kunder med hjälp av listan Kunder på menyn.
Förutsättningar
- Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och app+användarautentiseringsuppgifter.
C#
Så här hämtar du en lista över alla kunder:
Använd samlingen IAggregatePartner.Customers för att skapa ett IPartner-objekt .
Hämta kundlistan med metoderna Query() eller QueryAsync(). (Anvisningar om hur du skapar en fråga finns i klassen 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);
Ett exempel finns i följande:
- Exempel: Konsoltestapp
- Projekt: PartnerSDK.FeatureSamples
- Klass: CustomerPaging.cs
Java
Java SDK för Partnercenter kan användas för att hantera Partnercenter-resurser. Det är ett projekt med öppen källkod som underhålls av partnercommunityn och som inte stöds officiellt av Microsoft. Du kan få hjälp från communityn eller öppna ett problem på GitHub om du får problem.
Så här hämtar du en lista över alla kunder:
Använd funktionen [IAggregatePartner.getCustomers] för att hämta en referens till kundåtgärderna.
Hämta kundlistan med hjälp av funktionen query().
// 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-modulen i Partnercenter kan användas för att hantera Partnercenter-resurser. Det är ett projekt med öppen källkod som underhålls av partnercommunityn och som inte stöds officiellt av Microsoft. Du kan få hjälp från communityn eller öppna ett problem på GitHub om du får problem.
Kör kommandot Get-PartnerCustomer utan parametrar för att få en fullständig lista över kunder.
Get-PartnerCustomer
REST-begäran
Begärandesyntax
Metod | URI för förfrågan |
---|---|
GET | {baseURL}/v1/customers?size={size} HTTP/1.1 |
URI-parameter
Använd följande frågeparameter för att hämta en lista över kunder.
Namn | Typ | Obligatorisk | Beskrivning |
---|---|---|---|
Storlek | Int | Y | Antalet resultat som ska visas samtidigt. |
Begärandehuvuden
Mer information finns i REST-huvuden för Partnercenter.
Begärandetext
Inga.
Exempel på begäran
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-svar
Om det lyckas returnerar den här metoden en samling kundresurser i svarstexten.
Lyckade svar och felkoder
Varje svar levereras med en HTTP-statuskod som anger lyckat eller misslyckat och ytterligare felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och ytterligare parametrar. En fullständig lista finns i Felkoder.
Exempel på svar
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"
}
}