Abrufen einer Liste von Kunden
Gilt für: Partner Center | Partner Center-Betrieb durch 21Vianet | Partner Center für Microsoft Cloud for US Government
In diesem Artikel wird beschrieben, wie Sie eine Sammlung von Ressourcen abrufen, die alle Kunden eines Partners darstellt.
Tipp
Sie können diesen Vorgang auch in Partner Center ausführen. Wählen Sie auf der Startseite den Arbeitsbereich Kunden aus, und zeigen Sie dann Kunden mithilfe der Liste Kunden im Menü an.
Voraussetzungen
- Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt die Authentifizierung mit eigenständigen App- und App+Benutzeranmeldeinformationen.
C#
So rufen Sie eine Liste aller Kunden ab:
Verwenden Sie die IAggregatePartner.Customers-Auflistung , um ein IPartner-Objekt zu erstellen.
Rufen Sie die Kundenliste mit den Methoden Query() oder QueryAsync() ab. (Anweisungen zum Erstellen einer Abfrage finden Sie in der QueryFactory-Klasse .)
// 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);
Ein Beispiel finden Sie im Folgenden:
- „Beispiel: Konsolentest der App
- Projekt: PartnerSDK.FeatureSamples
- Klasse: CustomerPaging.cs
Java
Das Partner Center Java SDK kann zum Verwalten von Partner Center-Ressourcen verwendet werden. Es handelt sich um ein Open-Source-Projekt, das von der Partnercommunity verwaltet wird und nicht offiziell von Microsoft unterstützt wird. Sie können Hilfe von der Community erhalten oder ein Issue auf GitHub öffnen, wenn ein Problem auftritt.
So rufen Sie eine Liste aller Kunden ab:
Verwenden Sie die Funktion [IAggregatePartner.getCustomers], um einen Verweis auf die Kundenvorgänge abzurufen.
Rufen Sie die Kundenliste mithilfe der funktion query() ab.
// 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
Das Partner Center PowerShell-Modul kann zum Verwalten von Partner Center-Ressourcen verwendet werden. Es handelt sich um ein Open-Source-Projekt, das von der Partnercommunity verwaltet wird und nicht offiziell von Microsoft unterstützt wird. Sie können Hilfe von der Community erhalten oder ein Issue auf GitHub öffnen, wenn ein Problem auftritt.
Führen Sie den Befehl Get-PartnerCustomer ohne Parameter aus, um eine vollständige Kundenliste zu erhalten.
Get-PartnerCustomer
REST-Anforderung
Anforderungssyntax
Methode | Anforderungs-URI |
---|---|
GET | {baseURL}/v1/customers?size={size} HTTP/1.1 |
URI-Parameter
Verwenden Sie den folgenden Abfrageparameter, um eine Liste von Kunden abzurufen.
Name | Typ | Erforderlich | BESCHREIBUNG |
---|---|---|---|
size | int | J | Die Anzahl der jeweils angezeigten Ergebnisse. |
Anforderungsheader
Weitere Informationen finden Sie unter Partner Center-REST-Header.
Anforderungstext
Keine.
Anforderungsbeispiel
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-Antwort
Bei erfolgreicher Ausführung gibt diese Methode eine Sammlung von Customer-Ressourcen im Antworttext zurück.
Erfolgs- und Fehlercodes der Antwort
Jede Antwort enthält einen HTTP-Statuscode, der Aufschluss darüber gibt, ob der Vorgang erfolgreich war, sowie ggf. zusätzliche Debuginformationen. Verwende ein Tool für die Netzwerkablaufverfolgung, um diesen Code, den Fehlertyp und zusätzliche Parameter zu lesen. Eine vollständige Liste finden Sie unter Fehlercodes.
Antwortbeispiel
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"
}
}