ITG.Yandex ========== Обёртки для API Яндекс - базовый модуль для поддержки API различных сервисов Яндекса. Версия модуля: **2.0.1** Функции модуля -------------- ### Admin #### Обзор [Get-Admin][] Метод (обёртка над Яндекс.API [get_admins][]). Метод позволяет получить список дополнительных администраторов домена. Get-Admin [-DomainName] Подробнее - [Get-Admin][]. #### Обзор [Register-Admin][] Метод (обёртка над Яндекс.API [set_admin][]) предназначен для указания логина дополнительного администратора домена. Register-Admin -DomainName [-Credential] [-PassThru] [-WhatIf] [-Confirm] Подробнее - [Register-Admin][]. #### Обзор [Remove-Admin][] Метод (обёртка над Яндекс.API [del_admin][]) предназначен для удаления дополнительного администратора домена. Remove-Admin -DomainName [-Credential] [-PassThru] [-WhatIf] [-Confirm] Подробнее - [Remove-Admin][]. ### API #### Обзор [Invoke-API][] Обёртка для вызовов методов API Яндекс. Предназначена для внутреннего использования. Invoke-API [[-HttpMethod] ] [[-Token] ] [-method] [-DomainName] [[-Params] ] [[-IsSuccessPredicate] ] [[-IsFailurePredicate] ] [[-ResultFilter] ] [[-SuccessMsg] ] [[-FailureMsg] ] [[-FailureMsgFilter] ] [[-UnknownErrorMsg] ] [-WhatIf] [-Confirm] Подробнее - [Invoke-API][]. ### Domain #### Обзор [Register-Domain][] Метод (обёртка над Яндекс.API [reg_domain][]) предназначен для регистрации домена на сервисах Яндекса. Register-Domain [-DomainName] [-Token] [-WhatIf] [-Confirm] Подробнее - [Register-Domain][]. #### Обзор [Remove-Domain][] Метод (обёртка над Яндекс.API [del_domain][]) предназначен для отключения домена от Яндекс.Почта для доменов. Remove-Domain [-DomainName] [-PassThru] [-WhatIf] [-Confirm] Подробнее - [Remove-Domain][]. ### Logo #### Обзор [Remove-Logo][] Метод (обёртка над Яндекс.API [del_logo][]) предназначен для удаления логотипа домена. Remove-Logo [-DomainName] [-PassThru] [-WhatIf] [-Confirm] Подробнее - [Remove-Logo][]. #### Обзор [Set-Logo][] Метод (обёртка над Яндекс.API [add_logo][]) предназначен для установки логотипа для домена. Set-Logo [-DomainName] [-Path] [-PassThru] [-WhatIf] [-Confirm] Подробнее - [Set-Logo][]. ### Token #### Обзор [Get-Token][] Метод (обёртка над Яндекс.API [get_token][]) предназначен для получения авторизационного токена. Get-Token [-DomainName] [-NoCache] Подробнее - [Get-Token][]. #### Обзор [Set-Token][] Установка токена для других методов API. Set-Token [-DomainName] [-Token] Подробнее - [Set-Token][]. Подробное описание функций модуля --------------------------------- #### Get-Admin Метод (обёртка над Яндекс.API [get_admins][]). Метод позволяет получить список дополнительных администраторов домена. ##### Синтаксис Get-Admin [-DomainName] ##### Компонент API Яндекс.Почты для доменов ##### Параметры - `DomainName ` имя домена, зарегистрированного на сервисах Яндекса Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?true (ByValue, ByPropertyName) Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Пример 1. Get-Admin -DomainName 'csm.nov.ru'; ##### См. также - [get_admins][] #### Register-Admin Метод (обёртка над Яндекс.API [set_admin][]) предназначен для указания логина дополнительного администратора домена. В качестве логина может быть указан только логин на @yandex.ru, но не на домене, делегированном на Яндекс. ##### Синтаксис Register-Admin -DomainName [-Credential] [-PassThru] [-WhatIf] [-Confirm] ##### Компонент API Яндекс.Почты для доменов ##### Параметры - `DomainName ` имя домена, зарегистрированного на сервисах Яндекса Требуется? true Позиция? named Значение по умолчанию Принимать входные данные конвейера?true (ByValue, ByPropertyName) Принимать подстановочные знаки?false - `Credential ` Логин дополнительного администратора на @yandex.ru Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `PassThru []` передавать домены далее по конвейеру или нет Требуется? false Позиция? named Значение по умолчанию False Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `WhatIf []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Confirm []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Пример 1. Register-Admin -DomainName 'csm.nov.ru' -Credential 'sergei.e.gushchin'; ##### См. также - [set_admin][] #### Remove-Admin Метод (обёртка над Яндекс.API [del_admin][]) предназначен для удаления дополнительного администратора домена. В качестве логина может быть указан только логин на @yandex.ru, но не на домене, делегированном на Яндекс. ##### Синтаксис Remove-Admin -DomainName [-Credential] [-PassThru] [-WhatIf] [-Confirm] ##### Компонент API Яндекс.Почты для доменов ##### Параметры - `DomainName ` имя домена, зарегистрированного на сервисах Яндекса Требуется? true Позиция? named Значение по умолчанию Принимать входные данные конвейера?true (ByValue, ByPropertyName) Принимать подстановочные знаки?false - `Credential ` Логин дополнительного администратора на @yandex.ru Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `PassThru []` передавать домены далее по конвейеру или нет Требуется? false Позиция? named Значение по умолчанию False Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `WhatIf []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Confirm []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Пример 1. Remove-Admin -DomainName 'csm.nov.ru' -Credential 'sergei.e.gushchin'; ##### См. также - [del_admin][] #### Invoke-API Обёртка для вызовов методов API Яндекс. Предназначена для внутреннего использования. ##### Синтаксис Invoke-API [[-HttpMethod] ] [[-Token] ] [-method] [-DomainName] [[-Params] ] [[-IsSuccessPredicate] ] [[-IsFailurePredicate] ] [[-ResultFilter] ] [[-SuccessMsg] ] [[-FailureMsg] ] [[-FailureMsgFilter] ] [[-UnknownErrorMsg] ] [-WhatIf] [-Confirm] ##### Компонент API Яндекс ##### Передаваемые по конвейеру данные - [xml] - Результат, возвращённый API. ##### Параметры - `HttpMethod ` HTTP метод вызова API Требуется? false Позиция? 1 Значение по умолчанию GET Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Token ` авторизационный токен, полученный через [Get-Token][] Требуется? false Позиция? 2 Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `method ` метод API - компонент url Требуется? true Позиция? 3 Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `DomainName ` имя домена для регистрации на сервисах Яндекса Требуется? true Позиция? 4 Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Params ` коллекция параметров метода API Требуется? false Позиция? 5 Значение по умолчанию @{} Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `IsSuccessPredicate ` предикат успешного выполнения метода API Требуется? false Позиция? 6 Значение по умолчанию { [bool]$_.action.status.success } Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `IsFailurePredicate ` предикат ошибки при выполнении метода API. Если ни один из предикатов не вернёт $true - генерируем неизвестную ошибку Требуется? false Позиция? 7 Значение по умолчанию { [bool]$_.action.status.error } Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `ResultFilter ` фильтр обработки результата. Если фильтр не задан - функция не возвращает результат Требуется? false Позиция? 8 Значение по умолчанию {} Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `SuccessMsg ` Шаблон сообщения об успешном выполнении API Требуется? false Позиция? 9 Значение по умолчанию "Метод API $method успешно выполнен для домена $DomainName." Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `FailureMsg ` Шаблон сообщения об ошибке вызова API Требуется? false Позиция? 10 Значение по умолчанию "Ошибка при вызове метода API $method для домена $DomainName" Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `FailureMsgFilter ` Фильтр обработки результата для выделения сообщения об ошибке Требуется? false Позиция? 11 Значение по умолчанию { $_.action.status.error.'#text' } Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `UnknownErrorMsg ` Шаблон сообщения о недиагностируемой ошибке вызова API Требуется? false Позиция? 12 Значение по умолчанию "Неизвестная ошибка при вызове метода API $method для домена $DomainName." Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `WhatIf []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Confirm []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. #### Register-Domain Метод регистрирует домен на сервисах Яндекса. Если домен уже подключен, то метод [reg_domain][] не выполняет никаких действий. ##### Синтаксис Register-Domain [-DomainName] [-Token] [-WhatIf] [-Confirm] ##### Компонент API Яндекс.Почты для доменов ##### Параметры - `DomainName ` имя домена для регистрации на сервисах Яндекса Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?true (ByValue, ByPropertyName) Принимать подстановочные знаки?false - `Token ` авторизационный токен, полученный через [Get-Token][], для другого, уже зарегистрированного домена Требуется? true Позиция? 2 Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `WhatIf []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Confirm []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Регистрация нескольких доменов $token = Get-Token -DomainName 'maindomain.ru'; 'domain1.ru', 'domain2.ru' | Register-Domain -Token $token; ##### См. также - [reg_domain][] #### Remove-Domain Метод позволяет отключить домен. Отключенный домен перестает выводиться в списке доменов. После отключения домен можно подключить заново. Отключение домена не влечет за собой изменения MX-записей. MX-записи нужно устанавливать отдельно на DNS-серверах, куда делегирован домен. ##### Синтаксис Remove-Domain [-DomainName] [-PassThru] [-WhatIf] [-Confirm] ##### Компонент API Яндекс.Почты для доменов ##### Параметры - `DomainName ` имя домена для регистрации на сервисах Яндекса Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?true (ByValue, ByPropertyName) Принимать подстановочные знаки?false - `PassThru []` передавать домены далее по конвейеру или нет Требуется? false Позиция? named Значение по умолчанию False Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `WhatIf []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Confirm []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Пример 1. Remove-Domain -DomainName 'test.ru'; ##### См. также - [del_domain][] #### Remove-Logo Метод позволяет удалить логотип домена. ##### Синтаксис Remove-Logo [-DomainName] [-PassThru] [-WhatIf] [-Confirm] ##### Компонент API Яндекс.Почты для доменов ##### Параметры - `DomainName ` имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?true (ByValue, ByPropertyName) Принимать подстановочные знаки?false - `PassThru []` передавать домены далее по конвейеру или нет Требуется? false Позиция? named Значение по умолчанию False Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `WhatIf []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Confirm []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Удаление логотипа для домена yourdomain.ru. Remove-Logo -DomainName 'yourdomain.ru'; 2. Удаление логотипа для нескольких доменов. 'domain1.ru', 'domain2.ru' | Remove-Logo; ##### См. также - [del_logo][] #### Set-Logo Метод позволяет установить логотип домена. Поддерживаются графические файлы форматов jpg, gif, png размером до 2 Мбайт. ##### Синтаксис Set-Logo [-DomainName] [-Path] [-PassThru] [-WhatIf] [-Confirm] ##### Компонент API Яндекс.Почты для доменов ##### Параметры - `DomainName ` имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?true (ByValue, ByPropertyName) Принимать подстановочные знаки?false - `Path ` путь к файлу логотипа. Поддерживаются графические файлы форматов jpg, gif, png размером до 2 Мбайт Требуется? true Позиция? 2 Значение по умолчанию Принимать входные данные конвейера?true (ByPropertyName) Принимать подстановочные знаки?false - `PassThru []` передавать домены далее по конвейеру или нет Требуется? false Позиция? named Значение по умолчанию False Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `WhatIf []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `Confirm []` Требуется? false Позиция? named Значение по умолчанию Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Установка логотипа для домена yourdomain.ru Set-Logo -DomainName 'yourdomain.ru' -Path 'c:\work\logo.png'; ##### См. также - [add_logo][] #### Get-Token Метод [get_token][] предназначен для получения авторизационного токена. Авторизационный токен используется для активации API Яндекс.Почты для доменов. Получать токен нужно только один раз. Чтобы получить токен, следует иметь подключенный домен, авторизоваться его администратором. Данная функция возвращает непосредственно токен, либо генерирует исключение. ##### Синтаксис Get-Token [-DomainName] [-NoCache] ##### Компонент API Яндекс ##### Передаваемые по конвейеру данные - [System.Security.SecureString] - собственно token ##### Параметры - `DomainName ` имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?true (ByValue) Принимать подстановочные знаки?false - `NoCache []` данный флаг указывает на необходимость принудительного запроса токена, минуя кеш Требуется? false Позиция? named Значение по умолчанию False Принимать входные данные конвейера?false Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Получение токена для домена yourdomain.ru. $token = Get-Token -DomainName 'yourdomain.ru'; ##### См. также - [get_token][] #### Set-Token Данный метод позволяет задать токен, полученный ранее через [Get-Token][], для последующих вызовов командлет данного модуля. ##### Синтаксис Set-Token [-DomainName] [-Token] ##### Компонент API Яндекс ##### Параметры - `DomainName ` имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса Требуется? true Позиция? 1 Значение по умолчанию Принимать входные данные конвейера?true (ByPropertyName) Принимать подстановочные знаки?false - `Token ` авторизационный токен, полученный через [Get-Token][] Требуется? true Позиция? 2 Значение по умолчанию Принимать входные данные конвейера?true (ByPropertyName) Принимать подстановочные знаки?false - `` Этот командлет поддерживает общие параметры: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer и OutVariable. Для получения дополнительных сведений см. раздел [about_CommonParameters][]. ##### Примеры использования 1. Задание токена для домена yourdomain.ru. Set-Token -DomainName 'yourdomain.ru' -Token $SecureStringToken; [about_CommonParameters]: http://go.microsoft.com/fwlink/?LinkID=113216 "Describes the parameters that can be used with any cmdlet." [add_logo]: http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_add_logo.xml [del_admin]: http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_del_admin.xml [del_domain]: http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_del_domain.xml [del_logo]: http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_del_logo.xml#domain-control_del_logo [get_admins]: http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_get_admins.xml [get_token]: http://api.yandex.ru/pdd/doc/api-pdd/reference/get-token.xml#get-token [Get-Admin]: <#get-admin> "Метод (обёртка над Яндекс.API get_admins). Метод позволяет получить список дополнительных администраторов домена." [Get-Token]: <#get-token> "Метод (обёртка над Яндекс.API get_token) предназначен для получения авторизационного токена." [Invoke-API]: <#invoke-api> "Обёртка для вызовов методов API Яндекс. Предназначена для внутреннего использования." [reg_domain]: http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_reg_domain.xml [Register-Admin]: <#register-admin> "Метод (обёртка над Яндекс.API set_admin) предназначен для указания логина дополнительного администратора домена." [Register-Domain]: <#register-domain> "Метод (обёртка над Яндекс.API reg_domain) предназначен для регистрации домена на сервисах Яндекса." [Remove-Admin]: <#remove-admin> "Метод (обёртка над Яндекс.API del_admin) предназначен для удаления дополнительного администратора домена." [Remove-Domain]: <#remove-domain> "Метод (обёртка над Яндекс.API del_domain) предназначен для отключения домена от Яндекс.Почта для доменов." [Remove-Logo]: <#remove-logo> "Метод (обёртка над Яндекс.API del_logo) предназначен для удаления логотипа домена." [set_admin]: http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_add_admin.xml [Set-Logo]: <#set-logo> "Метод (обёртка над Яндекс.API add_logo) предназначен для установки логотипа для домена." [Set-Token]: <#set-token> "Установка токена для других методов API." --------------------------------------- Генератор: [ITG.Readme](http://github.com/IT-Service/ITG.Readme "Модуль PowerShell для генерации readme для модулей PowerShell").