Получение списка клиентов
Область применения: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud for US Government
В этой статье описывается, как получить коллекцию ресурсов, представляющих всех клиентов партнера.
Совет
Эту операцию также можно выполнить в Центре партнеров. На домашней странице выберите рабочую область Клиенты и просмотрите клиентов с помощью списка Клиенты в меню.
Предварительные условия
- Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. В этом сценарии поддерживается проверка подлинности с использованием учетных данных автономного приложения и приложения и пользователя.
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
Пакет SDK для Java для Центра партнеров можно использовать для управления ресурсами Центра партнеров. Это проект с открытым исходным кодом, поддерживаемый сообществом партнеров и не поддерживаемый корпорацией Майкрософт. При необходимости вы можете получить помощь от сообщества или опубликовать проблему в GitHub.
Чтобы получить список всех клиентов, выполните указанные ниже действия.
Используйте функцию [IAggregatePartner.getCustomers], чтобы получить ссылку на операции клиента.
Получите список клиентов с помощью функции 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 Центра партнеров можно использовать для управления ресурсами Центра партнеров. Это проект с открытым исходным кодом, поддерживаемый сообществом партнеров и не поддерживаемый корпорацией Майкрософт. При необходимости вы можете получить помощь от сообщества или опубликовать проблему в GitHub.
Выполните команду Get-PartnerCustomer без параметров, чтобы получить полный список клиентов.
Get-PartnerCustomer
Запрос REST
Синтаксис запроса
Метод | Универсальный код ресурса (URI) запроса |
---|---|
GET | {baseURL}/v1/customers?size={size} HTTP/1.1 |
Параметр универсального кода ресурса (URI)
Используйте следующий параметр запроса, чтобы получить список клиентов.
Имя | Тип | Обязательно | Описание |
---|---|---|---|
size | int | Да | Количество результатов, которые будут отображаться за один раз. |
Заголовки запроса
Дополнительные сведения см. в статье о заголовках 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"
}
}