Manage customer accounts - Get customers
检索合作伙伴客户的段。 还可以应用对客户的可选筛选。 客户只能按其公司名称或域名开头的字符串进行筛选。 目前不支持完全搜索。 可以使用 {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} 筛选操作并指定：DisplayName（公司名称）或 DefaultDomainName 作为筛选器字段进行筛选。
GET https://api.partnercenter.microsoft.com/v{version}/customersGET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
version
|
path | True |
string |
|
|
filter.
|
query |
integer int32 |
||
|
seek
|
query |
integer int32 |
搜寻操作。 |
|
|
size
|
query |
integer int32 |
要返回的最大客户数。 |
请求头
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| Authorization | True |
string |
授权持有者令牌 |
| ms-correlationid |
string |
用于在内部跟踪请求。 如果未提供 ms-correlationid，则服务器将为每个请求生成一个新请求 |
|
| ms-cv |
string |
用于在内部跟踪请求。 如果未提供 ms-cv，服务器将为每个请求生成一个新请求 |
|
| ms-requestid |
string |
用于请求的幂等性。 如果未提供 ms-requestid，服务器将为每个请求生成一个新请求 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
请求成功。 响应正文包含与筛选器匹配的客户列表。 如果响应按页面大小分页，则包含延续标记。 此令牌可以传递给 /customers？seek= 以查找客户结果。 Media Types: "application/json", "text/json" |
定义
Microsoft.Partner.Core.Collections.Link
| 名称 | 类型 | 说明 |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| method |
string |
|
| uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
| 名称 | 类型 | 说明 |
|---|---|---|
| etag |
string |
|
| objectType |
string |
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
| 名称 | 类型 | 说明 |
|---|---|---|
| attributes | ||
| items | ||
| links | ||
| totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
| 名称 | 类型 | 说明 |
|---|---|---|
| next | ||
| previous | ||
| self |
Microsoft.Partner.Service.Customers.Contracts.V1.Address
| 名称 | 类型 | 说明 |
|---|---|---|
| addressLine1 |
string |
|
| addressLine2 |
string |
|
| addressLine3 |
string |
|
| city |
string |
|
| country |
string |
|
| district |
string |
|
| emailAddress |
string |
|
| firstName |
string |
|
| id |
string |
|
| lastName |
string |
|
| middleName |
string |
|
| phoneNumber |
string |
|
| postalCode |
string |
|
| region |
string |
|
| state |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
| 名称 | 类型 | 说明 |
|---|---|---|
| allowDelegatedAccess |
boolean |
|
| associatedPartnerId |
string |
|
| attributes | ||
| billingProfile |
Microsoft. |
|
| commerceId |
string |
|
| companyProfile |
Microsoft. |
|
| customDomains |
string[] |
|
| id |
string |
|
| links | ||
| relationshipToPartner |
enum:
|
|
| userCredentials |
Microsoft. |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
| 名称 | 类型 | 说明 |
|---|---|---|
| attributes | ||
| companyName |
string |
|
| culture |
string |
|
| defaultAddress | ||
|
string |
||
| firstName |
string |
|
| id |
string |
|
| language |
string |
|
| lastName |
string |
|
| links |
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
| 名称 | 类型 | 说明 |
|---|---|---|
| address | ||
| attributes | ||
| companyName |
string |
|
| domain |
string |
|
|
string |
||
| links | ||
| organizationRegistrationNumber |
string |
|
| tenantId |
string |
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
| 名称 | 类型 | 说明 |
|---|---|---|
| password | ||
| userName |
string |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| 名称 | 类型 | 说明 |
|---|---|---|
| key |
string |
|
| value |
string |
System.Security.SecureString
| 名称 | 类型 | 说明 |
|---|---|---|
| length |
integer |