共用方式為


Manage customer accounts - Get customers

擷取合作夥伴客戶的區段。 您也可以套用客戶的選擇性篩選。 客戶只能依其公司名稱或功能變數名稱開頭的字串進行篩選。 目前不支援完整搜尋。 客戶可以使用 {Microsoft.Partner.Core.Query.Filters.FieldFilterOperation.StartsWith} 篩選作業進行篩選,並指定:DisplayName (公司名稱) 或 DefaultDomainName 做為篩選字段。

GET https://api.partnercenter.microsoft.com/v{version}/customers
GET https://api.partnercenter.microsoft.com/v{version}/customers?seekOperation={seekOperation}&size={size}&filter.operator={filter.operator}

URI 參數

名稱 位於 必要 類型 Description
version
path True

string

filter.operator
query

integer

int32
seekOperation
query

integer

int32

搜尋作業。

size
query

integer

int32

要傳回的客戶數目上限。

要求標頭

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

名稱 必要 類型 Description
Authorization True

string

授權持有人令牌

ms-correlationid

string

用於在內部追蹤要求。 如果未提供 ms-correlationid,伺服器會為每個要求產生新的要求

ms-cv

string

用於在內部追蹤要求。 如果未提供 ms-cv,伺服器將會為每個要求產生新的要求

ms-requestid

string

用於要求等冪性。 如果未提供 ms-requestid,伺服器將會為每個要求產生新的要求

回應

名稱 類型 Description
200 OK

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

要求成功。 回應本文包含符合篩選條件的客戶清單。 如果回應是以頁面大小分頁,則會包含接續令牌。 此令牌可以傳遞至 /customers?seek= 以尋找客戶結果。

Media Types: "application/json", "text/json"

定義

名稱 Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Service.Customers.Contracts.V1.Address
Microsoft.Partner.Service.Customers.Contracts.V1.Customer
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile
Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile
Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials
System.Collections.Generic.KeyValuePair[System.String,System.String]
System.Security.SecureString
名稱 類型 Description
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

名稱 類型 Description
etag

string

objectType

string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Service.Customers.Contracts.V1.Customer]

名稱 類型 Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

Microsoft.Partner.Service.Customers.Contracts.V1.Customer[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

名稱 類型 Description
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Service.Customers.Contracts.V1.Address

名稱 類型 Description
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

名稱 類型 Description
allowDelegatedAccess

boolean

associatedPartnerId

string

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

billingProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

commerceId

string

companyProfile

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

customDomains

string[]

id

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

relationshipToPartner enum:
  • advisor
  • microsoft_support
  • none
  • reseller
  • syndication
  • unknown
userCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerBillingProfile

名稱 類型 Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

culture

string

defaultAddress

Microsoft.Partner.Service.Customers.Contracts.V1.Address

email

string

firstName

string

id

string

language

string

lastName

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

Microsoft.Partner.Service.Customers.Contracts.V1.CustomerCompanyProfile

名稱 類型 Description
address

Microsoft.Partner.Service.Customers.Contracts.V1.Address

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

companyName

string

domain

string

email

string

links

Microsoft.Partner.Core.Collections.ResourceLinks

organizationRegistrationNumber

string

tenantId

string

Microsoft.Partner.Service.Customers.Contracts.V1.UserCredentials

名稱 類型 Description
password

System.Security.SecureString

userName

string

System.Collections.Generic.KeyValuePair[System.String,System.String]

名稱 類型 Description
key

string

value

string

System.Security.SecureString

名稱 類型 Description
length

integer