Получение подтверждения принятия клиентом условий клиентского соглашения Майкрософт

  • Статья

Область применения: Центр партнеров

Вне области применения: Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud for US Government

Ресурс соглашения в настоящее время поддерживается Центром партнеров только в общедоступном облаке Майкрософт.

В этой статье объясняется, как получить подтверждение принятия клиентом Клиентское соглашение Майкрософт.

Необходимые компоненты

  • Если вы используете пакет SDK для .NET для Центра партнеров, требуется версия 1.14 или более новая.

    Внимание

    По состоянию на июнь 2023 г. последняя версия пакета SDK для .NET для Центра партнеров 3.4.0 теперь архивируется. Вы можете скачать выпуск пакета SDK из GitHub вместе с файлом чтения, содержащим полезные сведения.

    Партнерам рекомендуется продолжать использовать REST API Центра партнеров.

  • Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает только проверку подлинности приложения и пользователя.

  • Идентификатор клиента (customer-tenant-id). Если вы не знаете идентификатор клиента, его можно найти в Центре партнеров, выбрав рабочую область "Клиенты" , затем клиент из списка клиентов, а затем учетная запись. На странице "Учетная запись клиента" найдите идентификатор Майкрософт в разделе "Сведения о учетной записи клиента". Идентификатор Майкрософт совпадает с идентификатором клиента (customer-tenant-id).

.NET

Чтобы получить подтверждение принятия клиентом, которое ранее было предоставлено:

  • Используйте коллекцию IAggregatePartner.Customers и вызовите метод ById с указанным идентификатором клиента.

  • Извлеките свойство Agreements и отфильтруйте результаты до Клиентское соглашение Майкрософт путем вызова метода ByAgreementType.

  • Вызов метода Get или GetAsync .

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

var customerAgreements = partnerOperations.Customers.ById(selectedCustomerId).Agreements.ByAgreementType(agreementType).Get();

Полный пример можно найти в классе GetCustomerAgreements из проекта тестового приложения консоли.

Запрос REST

Чтобы получить подтверждение принятия клиентом, которое ранее было предоставлено:

  1. Создайте запрос REST для получения коллекции соглашений для клиента.

  2. Используйте параметр запроса agreementType, чтобы область результаты только Клиентское соглашение Майкрософт.

Синтаксис запроса

Используйте следующий синтаксис запроса:

Способ URI запроса
GET {baseURL}/v1/customers/{customer-tenant-id}/agreement?agreementType={agreement-type} HTTP/1.1

Параметры универсального кода ресурса (URI)

С запросом можно использовать следующие параметры URI:

Имя. Type Обязательно Описание
customer-tenant-id GUID Да Это значение — это идентификатор GUID, отформатированный CustomerTenantId , который позволяет указать клиента.
тип соглашения строка Нет Этот параметр возвращает все метаданные соглашения. Используйте этот параметр, чтобы область ответ запроса на конкретный тип соглашения. Поддерживаемые значения:

MicrosoftCloudAgreement , который включает только метаданные соглашения типа MicrosoftCloudAgreement.

MicrosoftCustomerAgreement, который включает только метаданные соглашения типа MicrosoftCustomerAgreement.

* возвращает все метаданные соглашения. (Не используйте * , если код не имеет необходимой логики для обработки непредвиденных типов соглашений.)

Примечание. Если параметр URI не указан, запрос по умолчанию используется в MicrosoftCloudAgreement для обратной совместимости. Корпорация Майкрософт может в любое время вводить метаданные соглашения с новыми типами соглашений.

Заголовки запросов

Дополнительные сведения см. в статье о заголовках REST Центра партнеров.

Текст запроса

Нет.

Пример запроса

GET https://api.partnercenter.microsoft.com/v1/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/agreements?agreementType=MicrosoftCustomerAgreement HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b

Ответ REST

В случае успешного выполнения этот метод возвращает коллекцию ресурсов Соглашения в тексте ответа.

Коды успешного выполнения и ошибок в ответе

Каждый ответ содержит код состояния HTTP, указывающий на успешность или сбой, а также другие сведения об отладке.

Используйте средство трассировки сети для чтения этого кода, типа ошибки и других параметров. Полный список ответов есть в статье Коды ошибок REST в Центре партнеров.

Пример ответа

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": 2,
    "items":
    [
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-26T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        },
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber:"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-27T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        }
    ]
}