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

  • Статья

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

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

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

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

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

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

    Внимание

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

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

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

  • Страна или регион клиента, к которому применяется шаблон Клиентское соглашение Майкрософт.

  • Язык, в котором должен быть локализован шаблон Клиентское соглашение Майкрософт.

Внимание

  • Клиентское соглашение Майкрософт — это страна или регион. При запросе ссылки на скачивание шаблона Клиентское соглашение Майкрософт обязательно укажите правильную страну или регион в зависимости от расположения клиента. или список поддерживаемых стран или регионов, см . список поддерживаемых стран или регионов и языков.
  • Для некоторых стран или регионов Клиентское соглашение Майкрософт доступна на нескольких языках. Для лучшего взаимодействия с клиентами выберите язык, который лучше всего соответствует потребностям клиента. Список поддерживаемых языков см. в списке поддерживаемых стран и регионов и языков.
  • Этот метод поддерживается только с Клиентское соглашение Майкрософт.

.NET

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

  1. Получите метаданные для Клиентского соглашения Майкрософт. Для этого требуется значение templateId Клиентского соглашения Майкрософт. Дополнительные сведения см. в статье Получение метаданных для Клиентского соглашения Майкрософт.

    // IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

  2. Используйте коллекцию IAggregatePartner.AgreementTemplates.

  3. Вызовите метод ById и укажите templateId Клиентское соглашение Майкрософт.

  4. Получение свойства Document.

  5. Вызовите метод ByCountry и укажите страну или регион клиента, к которому применяется шаблон соглашения. Запрос по умолчанию используется для США , если метод не указан. Список поддерживаемых кодов страны или региона см. в списке поддерживаемых стран и регионов. Этот метод учитывает регистр.

  6. Вызовите метод ByLanguage и укажите язык, в который должен быть локализован шаблон соглашения. Запрос по умолчанию используется для en-US , если метод не указан или указан код страны или региона, не поддерживается для указанной страны или региона. Список поддерживаемых языковых кодов см. в списке поддерживаемых стран и регионов и языков.

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

    // IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

var agreementDocument = partnerOperations.   AgreementTemplates.ById   (microsoftCustomerAgreementDetails.   TemplateId).Document.ByCountry   (customerCountry).ByLanguage   (languageForLocalization).Get();

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

Запрос REST

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

  1. Получите метаданные для Клиентского соглашения Майкрософт. Для этого требуется значение templateId Клиентского соглашения Майкрософт. Дополнительные сведения см. в статье Получение метаданных для Клиентского соглашения Майкрософт.

  2. Создайте запрос REST для получения ресурса AgreementDocument. Пример см. в примере синтаксиса запроса. Необходимо указать следующие сведения:

    • Шаблон Идентификатор Клиентское соглашение Майкрософт
    • Страна или регион, к которому применяется шаблон Клиентское соглашение Майкрософт
    • Язык, в котором должен быть локализован шаблон Клиентское соглашение Майкрософт

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

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

Способ URI запроса
GET {baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}&country={country} HTTP/1.1

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

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

Имя. Type Обязательно Описание
agreement-template-id строка Да Уникальный идентификатор типа соглашения. Чтобы получить templateId для Клиентского соглашения Майкрософт, можете извлечь метаданные соглашения для Клиентского соглашения Майкрософт. Дополнительные сведения см. в статье Получение метаданных для Клиентского соглашения Майкрософт. Этот параметр учитывает регистр.
country string Нет Указывает страну или регион, к которому применяется шаблон соглашения. Запрос по умолчанию используется для США , если параметр не указан. Список поддерживаемых кодов страны или региона см. в списке поддерживаемых стран и регионов.
язык string Нет Указывает язык, на котором должен быть локализован шаблон соглашения. Запрос по умолчанию используется для en-US , если параметр не указан или код страны или региона, указанный в не поддерживаемом для указанной страны или региона. Список поддерживаемых кодов страны или региона см. в списке поддерживаемых стран и регионов.

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

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

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

Нет.

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

GET https://api.partnercenter.microsoft.com/v1/agreementtemplates/117a77b0-9360-443b-8795-c6dedc750cf9/document?language=en-US&country=US HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b

Ответ REST

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

Ресурс имеет свойство downloadUri , содержащее строку URL-адреса, которую можно использовать для скачивания шаблона соглашения. При каждом выполнении запроса возвращается другая ссылка. Срок действия этой ссылки истекает через пять минут.

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

Каждый ответ содержит код состояния 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
{
    "displayUri":"https://wopihost.int.l2o.microsoft.com/v1/officehost/agreement/files/Preview...",
    "downloadUri":"https://l2oagreementintbn2.blob.core.windows.net/agreementscontainer/Preview...",
    "language":"en-US",
    "country":"US"
}

Список поддерживаемых стран и регионов и языков

Внимание

Свойство кода страны или региона учитывает регистр. Не забудьте использовать правильный регистр, указанный в этой таблице:

Страна/регион Код страны Поддерживаемые языковые коды
Аландские острова AX en-US
Афганистан AF en-US
Албания AL en-US
Алжир DZ en-US, fr-FR, en-US
Американское Самоа AS en-US
Андорра AD en-US
Ангола AO en-US, pt-PT
Ангилья ИИ en-US
Антарктика AQ en-US
Антигуа и Барбуда ГД en-US
Аргентина расчеты с клиентами en-US, es-ES
Армения 4 млн en-US
Аруба AW en-US
Австралия AU en-US
Австрия AT en-US, de-DE
Азербайджан AZ en-US
Багамские о-ва BS en-US
Бахрейн BH en-US, ar-SA
Бангладеш BD en-US
Барбадос BB en-US
Беларусь BY en-US, ru-RU
Бельгия BE en-US, nl-NL
Белиз BZ en-US, es-ES
Бенин BJ en-US
Бермудские о-ва BM en-US
Бутан BT en-US
Боливия 80 en-US, es-ES
Бонэйр BQ en-US
Босния и Герцеговина BA en-US
Ботсвана BW en-US
Остров Буве BV en-US
Бразилия BR en-US, pt-BR
Британская территория в Индийском океане IO en-US
Виргинские о-ва (Великобритания) VG en-US
Бруней-Даруссалам BN en-US
Болгария BG en-US, bg-BG
Буркина-Фасо BF en-US
Бурунди служба en-US
Кот-д'Ивуар CI en-US, fr-FR
Кабо-Верде C en-US, pt-PT
Камбоджа KH en-US
Камерун ТМ en-US, fr-FR
Канада Целостности и доступности en-US, fr-FR
Острова Кайман Кентукки en-US, en-US
Центрально-Африканская Республика CF en-US
Чад TD en-US
Чили CL en-US, es-ES
Остров Рождества CX en-US
Кокосовые о-ва CC en-US
Колумбия CO en-US, es-ES
Коморы КМ en-US
Демократическая Республика Конго CD en-US
Конго CG en-US
Острова Кука OK en-US
Коста-Рика CR en-US, es-ES
Хорватия HR en-US, hr-HR
Кюрасао CW en-US
Кипр CY en-US
Чехия CZ en-US, cs-CZ
Дания DK en-US, da-DK
Джибути DJ en-US
Доминика DM en-US
Доминиканская Республика DO en-US, es-ES
Эквадор EC en-US
Египет EG en-US, ar-SA
Эль-Сальвадор SV en-US, es-ES
Экваториальная Гвинея GQ en-US
Эритрея ER en-US
Эстония EE en-US, et-EE
Эсватини SZ en-US
Эфиопия ET en-US
Фолклендские о-ва FK en-US
Фарерские о-ва FO en-US
Фиджи FJ en-US
Финляндия FI en-US, fi-FI
Франция FR en-US, fr-FR
Французская Гвиана GH en-US, fr-FR
Французская Полинезия ТФ en-US
Французские Южные Территории TF en-US
Габон Общедоступная версия en-US
Гамбия GM en-US
Грузия GE en-US
Германия DE en-US, de-DE
Гана GH en-US
Гибралтар Отпуск товаров en-US
Греция GR en-US, el-GR
Гренландия GL en-US
Гренада GD en-US
Гваделупа GP en-US
Гуам GU en-US
Гватемала GT en-US, es-ES
Гернси GG en-US
Гвинея GN en-US
Гвинея-Бисау GW en-US
Гайана GY en-US
Гаити HT en-US
Остров Херд и острова Макдональд HM en-US
Гондурас HN en-US, es-ES
Гонконг Специальный Администратор istrative регион HK en-US, zh-HK
Венгрия HU en-US, hu-HU
Исландия IS en-US
Индия В en-US, hi-IN
Индонезия Идентификатор en-US, id-ID
Ирак IQ en-US, ar-SA
Ирландия IE en-US
Остров Мэн "IM" (Обмен мгновенными сообщениями); en-US
Израиль IL en-US, he-IL
Италия IT en-US, it-IT
Ямайка JM en-US
Ян-Майен XJ en-US
Япония JP en-US, ja-JP
Джерси JE en-US
Иордания JO en-US, ar-SA
Казахстан KZ en-US, kk-KZ
Кения KE en-US
Кирибати KI en-US
Республика Корея KR en-US, ko-KR
Косово XK en-US
Кувейт KW en-US, ar-SA
Киргизстан KG en-US, ru-RU
Лаос ЛАТИНСКАЯ АМЕРИКА en-US
Латвия Lv en-US, lv-LV
Ливан LB en-US, ar-SA
Лесото LS en-US
Либерия LR en-US
Ливия LY en-US, ar-SA
Лихтенштейн LI en-US, de-DE
Литва LT en-US, lt-LT
Люксембург LU en-US, fr-FR
Специальный Администратор истативный регион Macao МО en-US, zh-HK
Мадагаскар MG en-US
Малави MW en-US
Малайзия MY en-US, ms-MY
Мальдивы MV en-US
Мали ML en-US
Мальта MT en-US
Маршалловы о-ва MH en-US
Мартиника MQ en-US
Мавритания МИ en-US
Маврикий MU en-US, ar-SA
Майотта YT en-US
Мексика MX en-US, es-ES
Федеративные Штаты Микронезии FM en-US
Молдова MD en-US, ro-RO
Монако MC en-US, fr-FR
Монголия MN en-US
Черногория СООБ en-US
Монтсеррат MS en-US
Марокко MA en-US, fr-FR, en-US
Мозамбик MZ en-US
Мьянма MM en-US
Намибия Неприменимо en-US
Науру NR en-US
Непал NP en-US
Нидерланды NL en-US, nl-NL
Новая Каледония NC en-US
Новая Зеландия Новая Зеландия en-US
Никарагуа NI en-US, es-ES
Нигер NE en-US
Нигерия NG en-US
Ниуэ NU en-US
О-в Норфолк NF en-US
Северные Марианские о-ва MP en-US
Северная Македония MK en-US
Норвегия Нет en-US, nb-NO
Оман 0 млн en-US, ar-SA
Пакистан PK en-US
Палау PW en-US
Палестинская Автономия PS en-US
Панама Пенсильвания en-US, es-ES
Папуа — Новая Гвинея Р en-US
Парагвай PY en-US, es-ES
Перу PE en-US, es-ES
Филиппины PH en-US
О-ва Питкэрн PN en-US
Польша PL en-US, pl-PL
Португалия PT en-US, pt-PT
Пуэрто-Рико PR en-US, en-US
Катар Контроль качества en-US, ar-SA
Реюньон RE en-US
Румыния 0 en-US, ro-RO
Россия ЕЗ en-US, ru-RU
Руанда RW en-US, fr-FR
Сан-Томе и Принсипи ST en-US, fr-FR
Саба XS en-US
Сен-Бартелеми BL en-US
Сент-Киттс и Невис KN en-US
Сент-Люсия LC en-US, en-US
Сен-Мартен MF en-US, en-US
Сен-Пьер и Микелон PM en-US
Сент-Винсент и Гренадины VC en-US
Самоа WS en-US
Сан-Марино SM en-US
Саудовская Аравия SA en-US
Сенегал SN en-US, fr-FR
Сербия RS en-US, sr-Latn-RS, en-US
Сейшельские Острова SC en-US
Сьерра-Леоне SL en-US
Сингапур ПЗ en-US, zh-SG
Синт-Эстатиус XE en-US
Синт-Мартен SX en-US, en-US
Словакия 5 тыс. en-US, sk-SK
Словения SI en-US, sl-SI
Соломоновы Острова SB en-US
Сомали SO en-US
ЮАР ZA en-US
Южная Джорджия и Южные Сандвичевы острова GS en-US
Южный Судан SS en-US
Испания ES en-US, es-ES, en-US, en-US
Шри-Ланка LK en-US
О-ва Св. Елены, Вознесения и Тристан-да-Кунья SH en-US
Суринам SR en-US
Шпицберген SJ en-US
Швеция SE en-US, sv-SE
Швейцария CH en-US, fr-FR, en-US, en-US
Тайвань TW en-US, zh-HK
Таджикистан TJ en-US
Танзания TZ en-US
Таиланд TH en-US, th-TH
Тимор-Лесте TL en-US
Того TG en-US
Токелау TK en-US
Тонга TO en-US
Тринидад и Тобаго TT en-US
Тунис ИО en-US, fr-FR, en-US
Турция TR en-US, tr-TR
Туркменистан TM en-US
Острова Теркс и Кайкос TC en-US
Тувалу TV en-US
США Малые Тихоокеанские Отдаленные Острова США МЕРА en-US
США (США) VI en-US
Уганда UG en-US
Украина UA en-US, uk-UA
ОАЭ AE en-US, ar-SA
Соединенное Королевство ГБ en-US
Соединенные Штаты US en-US
Уругвай UY en-US, es-ES
Узбекистан UZ en-US, ru-RU
Вануату VU en-US
Ватикан VA en-US
Венесуэла VE en-US, es-ES
Вьетнам VN en-US, vi-VN
Уоллис и Футуна WF en-US
Йемен YE en-US, ar-SA
Замбия ZM en-US
Зимбабве ZW en-US