Pobieranie listy urządzeń dla określonej partii i klienta
Dotyczy: Centrum partnerskie
W tym artykule opisano sposób pobierania kolekcji urządzeń w określonej partii urządzeń dla określonego klienta. Każdy zasób urządzenia zawiera szczegółowe informacje o urządzeniu.
Wymagania wstępne
Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie zarówno przy użyciu autonomicznych poświadczeń aplikacji, jak i aplikacji i użytkownika.
Identyfikator klienta (
customer-tenant-id
). Jeśli nie znasz identyfikatora klienta, możesz go wyszukać w Centrum partnerskim , wybierając obszar roboczy Klienci , a następnie klienta z listy klienta, a następnie pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta . Identyfikator Firmy Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id
).Identyfikator partii urządzenia.
C#
Aby pobrać kolekcję urządzeń w określonej partii urządzeń dla określonego klienta:
Wywołaj metodę IAggregatePartner.Customers.ById z identyfikatorem klienta, aby pobrać interfejs do operacji na określonym kliencie.
Wywołaj metodę DeviceBatches.ById , aby uzyskać interfejs operacji zbierania wsadowego dla określonej partii.
Pobierz właściwość Devices , aby uzyskać interfejs operacji zbierania urządzeń dla partii.
Wywołaj metodę Get lub GetAsync , aby pobrać kolekcję urządzeń.
IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedDeviceBatchId;
var devices =
partnerOperations.Customers.ById(selectedCustomerId).DeviceBatches.ById(selectedDeviceBatchId).Devices.Get();
Aby zapoznać się z przykładem, zobacz następujące kwestie:
- Przykład: aplikacja testowa konsoli
- Projekt: Przykłady zestawu SDK Centrum partnerskiego
- Klasa: GetDevices.cs
Żądanie REST
Składnia żądania
Metoda | Identyfikator URI żądania |
---|---|
GET | {baseURL}/v1/customers/{customer-id}/deviceBatches/{devicebatch-id}/devices HTTP/1.1 |
Parametry identyfikatora URI
Podczas tworzenia żądania użyj następujących parametrów ścieżki.
Nazwa | Typ | Wymagane | Opis |
---|---|---|---|
customer-id | ciąg | Tak | Ciąg sformatowany za pomocą identyfikatora GUID, który identyfikuje klienta. |
devicebatch-id | ciąg | Tak | Identyfikator ciągu identyfikujący partię urządzenia. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
Brak
Przykład żądania
GET https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/deviceBatches/testbatch/devices HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Host: api.partnercenter.microsoft.com
Odpowiedź REST
W przypadku powodzenia treść odpowiedzi zawiera stronicowany zbiór zasobów urządzenia . Kolekcja zawiera 100 urządzeń na stronie. Aby pobrać następną stronę 100 urządzeń, kontynuacjaToken w treści odpowiedzi musi zostać uwzględniona w kolejnym żądaniu jako nagłówek MS-ContinuationToken.
Kody powodzenia odpowiedzi i błędów
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.
Przykład odpowiedzi
HTTP/1.1 200 OK
Content-Length: 1742
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 7b3e2e00-b330-4480-9d84-59ace713427f
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 17:52:41 GMT
{
"totalCount": 2,
"items":
[{
"id": "7c141ea9-2816-4e15-a819-53f6856499ff",
"serialNumber": "2R9-ZNP67",
"productKey": "00329-00000-0003-AA6069",
"modelName": "Precision WorkStation T7500",
"oemManufacturerName":"Dell Inc.",
"policies":[{
"key": "o_o_b_e",
"value": null
}
],
"uploadedDate":"2017-08-09T14:43:26.0092288-07:00",
" attributes": {
"objectType": "Device"
}
}, {
"id": "e528a62f-5031-49f4-bea7-5fafe47388fd",
"serialNumber": "1234567890",
"productKey": "12345-67890-09876-54321-13579",
"modelName": "HP Z420 Workstation",
"oemManufacturerName": "Hewlett-Packard",
"policies": [{
"key": "o_o_b_e",
"value": null
}
],
"uploadedDate": "2017-08-09T14:35:51.3126144-07:00",
"attributes": {
"objectType": "Device"
}
}
],
"attributes": {
"objectType": "Collection"
}
}