Obter um cliente por ID
Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government
Obtém um recurso Customer que corresponde a uma ID de cliente.
Pré-requisitos
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário oferece suporte a credenciais de aplicativo+usuário ou autenticação somente de aplicativo.
Uma ID do cliente (
customer-tenant-id). Se você não souber a ID do cliente, poderá procurá-la no Partner Center. Selecione o espaço de trabalho Clientes na página inicial do Partner Center. Selecione o cliente na lista Cliente e, em seguida, selecione Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Detalhes da Conta do Cliente. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).
Importante
A chamada Get Customer ID API não retornará os seguintes atributos na resposta se o parceiro não tiver acesso DAP no locatário do cliente. Caso contrário, ele retornará todos os atributos listados no exemplo de resposta.
- CompanyProfileAddress
- CompanyProfileEmail
- Domíniopersonalizado
Funções GDAP
Você precisará de pelo menos uma das seguintes funções GDAP para chamar Obter uma organização de cliente para CompanyProfileAddress, CompanyProfileEmail e Obter um domínio personalizado do cliente para CustomDomain:
- Administrador Global
- Gravador de diretório
- Leitor Global
C#
Para obter um cliente por ID, use sua coleção IAggregatePartner.Customers, chame o método ById() e chame os métodos Get() ou GetAsync().
// IAggregatePartner partnerOperations;
// string customerIdToRetrieve;
Customer customerInfo = partnerOperations.Customers.ById(customerIdToRetrieve).Get();
Exemplo: Aplicativo de teste de console. Projeto: PartnerSDK.FeatureSamples Classe: CustomerInformation.cs
Java
O SDK Java do Partner Center pode ser usado para gerenciar recursos do Partner Center. É um projeto de código aberto mantido pela comunidade de parceiros e não é oficialmente suportado pela Microsoft. Caso se depare com um problema, você pode obter ajuda da comunidade ou abrir um problema no GitHub.
Para obter um cliente por ID, use sua função IAggregatePartner.getCustomers, chame a função byId() e chame a função get().
// IAggregatePartner partnerOperations;
// String customerIdToRetrieve;
Customer customerInfo = partnerOperations.getCustomers().byId(customerIdToRetrieve).get();
PowerShell
O módulo PowerShell do Partner Center pode ser usado para gerenciar recursos do Partner Center. É um projeto de código aberto mantido pela comunidade de parceiros e não é oficialmente suportado pela Microsoft. Caso se depare com um problema, você pode obter ajuda da comunidade ou abrir um problema no GitHub.
Para obter um cliente por ID, execute o comando Get-PartnerCustomer e especifique o parâmetro CustomerId.
Get-PartnerCustomer -CustomerId '2ca7de6c-c05c-46b5-b689-32e53573a97a'
Solicitação REST
Sintaxe da solicitação
| Método | URI da solicitação |
|---|---|
| GET | {baseURL}/v1/customers/{customer-tenant-id} HTTP/1.1 |
Parâmetro do URI
Use o seguinte parâmetro de consulta para um cliente específico.
| Nome | Type | Obrigatório | Descrição |
|---|---|---|---|
| id de locatário do cliente | guid | S | O valor é um ID de cliente-locatário formatado por GUID que permite ao revendedor filtrar os resultados de um determinado cliente que pertence ao revendedor. |
Cabeçalhos de solicitação
Para obter mais informações, confira Cabeçalhos REST do Partner Center.
Corpo da solicitação
None.
Exemplo de solicitação
GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-CorrelationId: a176c585-b5de-4d65-824c-67a6deb45cd9
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
Resposta REST
Se bem-sucedido, esse método retorna um recurso Customer no corpo da resposta.
Códigos de êxito e de erro de resposta
Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de Erro.
Exemplo de resposta
HTTP/1.1 200 OK
Content-Length: 1530
Content-Type: application/json; charset=utf-8
MS-CorrelationId: a176c585-b5de-4d65-824c-67a6deb45cd9
MS-RequestId: 74ca1db9-df92-41c6-a362-a16433b0542b
{
"id": "eebd1b55-5360-4438-a11d-5c06918c3014",
"commerceId": "99e6a635-48e7-424d-9059-c9db944e3c54",
"companyProfile": {
"tenantId": "eebd1b55-5360-4438-a11d-5c06918c3014",
"domain": "abcdefgh1234.onmicrosoft.com",
"companyName": "1kl as kjk",
"address": {
"country": "US",
"region": "wa",
"city": "redmond",
"addressLine1": "1 ms way",
"postalCode": "98052",
"phoneNumber": "1234567890"
},
"email": "a@a.com",
"links": {
"self": {
"uri": "/customers/eebd1b55-5360-4438-a11d-5c06918c3014/profiles/company",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "CustomerCompanyProfile"
}
},
"billingProfile": {
"id": "eeada110-69d6-4cc9-b093-75feb7ca9d3f",
"firstName": "d0d89d776d03471c819bf772191ed728",
"lastName": "kjkAJJAAAAAAAAAAAAAAAAAAAA",
"email": "a@a.com",
"culture": "en-US",
"language": "en",
"companyName": "1kl as kjkAAAAAAAAAAAAAAAJJJJJJJJJJJAAAAAJJJJJJJJJJJAAJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJJAJJJJJAJJAAAAJAJJAAAAAAAAAAAAAAAAAAAA",
"defaultAddress": {
"country": "US",
"city": "redmond",
"state": "WA",
"addressLine1": "1 ms way",
"postalCode": "98052",
"firstName": "1kl as",
"lastName": "kjk",
"phoneNumber": "1234567890"
},
"links": {
"self": {
"uri": "/customers/eebd1b55-5360-4438-a11d-5c06918c3014/profiles/billing",
"method": "GET",
"headers": [
]
}
},
"attributes": {
"etag": "-4242348048554929329",
"objectType": "CustomerBillingProfile"
}
},
"relationshipToPartner": "reseller",
"allowDelegatedAccess": true,
"customDomains": [
"abcdefgh1234.onmicrosoft.com"
],
"links": {
"self": {
"uri": "/customers/eebd1b55-5360-4438-a11d-5c06918c3014",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Customer"
}
}
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de