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 |