Поделиться через


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

применимо к: Центр партнеров

не применяется к: Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud для государственных организаций США

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

Перед тем как можно получить метаданные соглашения для клиентского соглашения Майкрософт, необходимо получить следующие метаданные:

Необходимые условия

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

    Важный

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

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

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

.NET (версия 1.14 или более позднюю)

Чтобы получить метаданные соглашения для клиентского соглашения Майкрософт, выполните следующие действия.

  1. Сначала получите коллекцию IAggregatePartner.AgreementDetails.

  2. Вызовите метод ByAgreementType, чтобы отфильтровать коллекцию в клиентском соглашении Майкрософт.

  3. Наконец, вызовите метод Get или GetAsync.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

var microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();

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

Запрос REST

Чтобы получить метаданные соглашения для клиентского соглашения Майкрософт, выполните следующие действия.

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

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

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

Метод Запрос URI
ПОЛУЧИТЬ {baseURL}/v1/agreement?agreementType={тип соглашения} HTTP/1.1

Параметры URI

Используйте следующие параметры URI с запросом:

Имя Тип Обязательно Описание
тип соглашения струна Нет Используйте этот параметр для области ответа запроса на определенный тип соглашения. Поддерживаемые значения:

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

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

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

Примечание. Если параметр URI не указан, по умолчанию запрос использует MicrosoftCloudAgreement для обратной совместимости.

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

Для получения дополнительной информации см. заголовки REST API Центра партнеров.

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

Нет.

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

GET https://api.partnercenter.microsoft.com/v1/agreements?agreementType=MicrosoftCustomerAgreement HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

Ответ REST

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

Коды успеха и ошибок ответа

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

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

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

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}