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

  • Статья

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

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

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

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

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

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

    Внимание

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

    Партнерам рекомендуется продолжать использовать 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 запроса
GET {baseURL}/v1/agreement?agreementType={тип соглашения} HTTP/1.1

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

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

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

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

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

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

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

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

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

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

Нет.

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

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: ab993325-1605-4cf4-bac4-fb584142a31b

Ответ 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: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "totalCount": 1,
    "items": [
        {
            "templateId": "117a77b0-9360-443b-8795-c6dedc750cf9",
            "agreementType": "MicrosoftCustomerAgreement",
            "agreementLink": "https://aka.ms/customeragreement",
            "versionRank": 0
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}