Obter metadados do contrato do Microsoft Cloud
Aplica-se a: Partner Center
Não se aplica a: Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government
O recurso AgreementMetaData é atualmente suportado pelo Partner Center apenas na nuvem pública da Microsoft.
O Contrato de Cliente da Microsoft substituiu o Contrato de Nuvem da Microsoft, a partir de 2021. Se o cliente assinou anteriormente um Contrato de Nuvem da Microsoft, seu último histórico de contrato conhecido estará disponível, além do histórico do Contrato de Cliente da Microsoft.
Pré-requisitos
Se você estiver usando o SDK do Partner Center .NET, a versão 1.9 ou mais recente será necessária.
Importante
A partir de junho de 2023, a versão 3.4.0 mais recente do SDK do Partner Center .NET foi arquivada. Você pode baixar a versão do SDK no GitHub, juntamente com um arquivo leiame que contém informações úteis.
Os parceiros são incentivados a continuar a usar as APIs REST do Partner Center.
Se você estiver usando o SDK Java do Partner Center, a versão 1.8 ou mais recente será necessária.
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário oferece suporte à autenticação de aplicativo + usuário.
.NET (versão 1.14 ou mais recente)
Para recuperar os metadados do contrato do Microsoft Cloud Agreement:
Primeiro, recupere a coleção IAggregatePartner.AgreementDetails .
Chame o método ByAgreementType para filtrar a coleção para o Microsoft Cloud Agreement.++++++++++++++++++++++++
Finalmente, chame Get ou GetAsync método.
// IAggregatePartner partnerOperations;
string agreementType = "MicrosoftCloudAgreement";
var microsoftCloudAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();
Um exemplo completo pode ser encontrado na classe GetAgreementDetails do projeto de aplicativo de teste de console.
.NET (versão 1.9 - 1.13)
Para recuperar metadados de contrato para o Microsoft Cloud Agreement:
Primeiro, recupere a coleção IAggregatePartner.AgreementDetails e, em seguida, chame os métodos Get ou GetAsync . Em seguida, procure o item dentro da coleção, que corresponde ao Microsoft Cloud Agreement:
// IAggregatePartner partnerOperations;
var agreements = partnerOperations.AgreementDetails.Get();
AgreementMetaData microsoftCloudAgreement = agreements.Items.FirstOrDefault (agr => agr.AgreementType == AgreementType.MicrosoftCloudAgreement);
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 recuperar metadados de contrato para o Microsoft Cloud Agreement:
Primeiro, chame a função IAggregatePartner.getAgreementDetails e, em seguida, chame a função get . Em seguida, procure o item dentro da coleção, que corresponde ao Microsoft Cloud Agreement:
// IAggregatePartner partnerOperations;
ResourceCollection<AgreementMetaData> agreements = partnerOperations.getAgreements().get();
AgreementMetaData microsoftCloudAgreement;
for (AgreementMetaData metadata : agreements)
{
if(metadata.getAgreementType() == AgreementType.MicrosoftCloudAgreement)
{
microsoftCloudAgreement = metadata;
}
}
Um exemplo completo pode ser encontrado na classe GetAgreementDetails do projeto de aplicativo de teste de console.
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 recuperar metadados de contrato para o Microsoft Cloud Agreement:
Use o comando Get-PartnerAgreementDetail. Em seguida, procure o item dentro da coleção, que corresponde ao Microsoft Cloud Agreement:
Get-PartnerAgreementDetail | Where-Object {$_.AgreementType -eq 'MicrosoftCloudAgreement'} | Select-Object -First 1
Solicitação REST
Para recuperar metadados de contrato para o Microsoft Cloud Agreement, primeiro crie uma Solicitação REST para recuperar a coleção AgreementMetaData . Em seguida, procure o item na coleção que corresponde ao Microsoft Cloud Agreement.
Sintaxe da solicitação
| Método | URI da solicitação |
|---|---|
| GET | {baseURL}/v1/agreements HTTP/1.1 |
Parâmetros do URI
Use os seguintes parâmetros de URI com sua solicitação:
| Nome | Digitar | Obrigatória | Descrição |
|---|---|---|---|
| tipo de acordo | string | Não | Use esse parâmetro para definir o escopo da resposta da consulta para um tipo de contrato específico. Os valores suportados são: MicrosoftCloudAgreement que inclui metadados de contrato somente do tipo MicrosoftCloudAgreement MicrosoftCustomerAgreement que inclui metadados de contrato somente do tipo MicrosoftCustomerAgreement. * que retorna todos os metadados do contrato. (Não use * a menos que seu código tenha a lógica de tempo de execução necessária para lidar com tipos de contrato desconhecidos, pois a Microsoft pode introduzir metadados de contrato com novos tipos de contrato a qualquer momento.) Nota: Se o parâmetro URI não for especificado, o padrão da consulta será MicrosoftCloudAgreement para compatibilidade com versões anteriores. |
Cabeçalhos da solicitação
Para obter mais informações, confira Cabeçalhos REST do Partner Center.
Corpo da solicitação
Nenhum.
Exemplo de solicitação
GET https://api.partnercenter.microsoft.com/v1/agreements HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
Resposta REST
Se bem-sucedido, esse método retorna uma coleção de recursos AgreementMetaData 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 sucesso ou falha e outras informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para obter a lista completa, confira Códigos de erro REST do Partner Center.
Exemplo de resposta
HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
{
"totalCount": 1,
"items": [
{
"templateId": "998b88de-aa99-4388-a42c-1b3517d49490",
"agreementType": "MicrosoftCloudAgreement",
"agreementLink": "https://learn.microsoft.com/partner-center/agreements",
"versionRank": 0
}
],
"links": {
"self": {
"uri": "/agreements",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}
Para identificar o recurso na resposta que corresponde ao Microsoft Cloud Agreement, procure o recurso cuja propriedade agreementType tem o valor "MicrosoftCloudAgreement".
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