Export-ODataEndpointProxy
Создает модуль, содержащий командлеты для управления конечной точкой OData.
Синтаксис
Export-ODataEndpointProxy
[-Uri] <String>
[-OutputModule] <String>
[[-MetadataUri] <String>]
[[-Credential] <PSCredential>]
[[-CreateRequestMethod] <String>]
[[-UpdateRequestMethod] <String>]
[[-CmdletAdapter] <String>]
[[-ResourceNameMapping] <Hashtable>]
[-Force]
[[-CustomData] <Hashtable>]
[-AllowClobber]
[-AllowUnsecureConnection]
[[-Headers] <Hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Описание
Командлет Export-ODataEndpointProxy использует метаданные конечной точки OData для создания модуля, содержащего командлеты, которые можно использовать для управления этой конечной точкой OData. Модуль основан на CDXML. После создания этого командлета модуль сохраняет этот модуль в путь и имя файла, указанное параметром OutputModule.
Export-ODataEndpointProxy создает командлеты для операций создания, чтения, обновления и удаления (CRUD), действий, отличных от CRUD, и манипуляций с сопоставлениями.
Export-ODataEndpointProxy создает один CDXML-файл на ресурс конечной точки. Эти ФАЙЛЫ CDXML можно изменить после создания модуля. Например, если вы хотите изменить имена существительных или глаголов командлетов для согласования с рекомендациями по именованию командлетов Windows PowerShell, можно изменить файл.
Каждый командлет в созданном модуле должен включать параметр ConnectionURI, чтобы подключиться к конечной точке, которой управляет модуль.
Примеры
Пример 1. Создание модуля для управления конечной точкой веб-службы розничной торговли
PS C:\> Export-ODataEndpointProxy -Uri 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc' -MetadataUri 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc/$metadata' -AllowUnsecureConnection -OutputModule 'C:\Users\user\GeneratedScript.psm1' -ResourceNameMapping @{Products = 'Merchandise'}Эта команда создает модуль для управления конечной точкой розничной службы. Команда задает универсальный код ресурса (URI) конечной точки и универсальный код ресурса (URI) метаданных конечной точки. Команда также предоставляет выходной путь и имя модуля скрипта в качестве значения параметра OutputModule. Для значения параметра ResourceNameMapping команда предоставляет хэш-список, который сопоставляет имя коллекции ресурсов с нужным существительным для набора командлетов. В этом примере "Продукты" — это имя коллекции ресурсов, а "Товары" — это существительное. Чтобы разрешить подключения к сайтам, отличным от SSL, http, а не HTTPS, добавьте параметр AllowUnsecureConnection.
Параметры
-AllowClobber
Указывает, что этот командлет заменяет существующий модуль.
| Тип: | SwitchParameter |
| Position: | 10 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-AllowUnsecureConnection
Указывает, что этот модуль может подключаться к URI, которые не защищены SSL. Модуль может управлять сайтами HTTP в дополнение к сайтам HTTPS.
| Тип: | SwitchParameter |
| Position: | 11 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-CmdletAdapter
Указывает адаптер командлета. Допустимыми значениями этого параметра являются ODataAdapter и NetworkControllerAdapter.
| Тип: | String |
| Допустимые значения: | ODataAdapter, NetworkControllerAdapter, ODataV4Adapter |
| Position: | 6 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-Confirm
Запрашивает подтверждение перед запуском командлета.
| Тип: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Обязательно: | False |
| Принять входные данные конвейера: | False |
| Принять подстановочные знаки: | False |
-CreateRequestMethod
Задает метод запроса. Допустимые значения для этого параметра: PUT, POST и PATCH.
| Тип: | String |
| Допустимые значения: | Put, Post, Patch |
| Position: | 4 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-Credential
Указывает учетную запись пользователя, доступ к конечной точке OData. Значение по умолчанию — текущий пользователь. Если удаленный компьютер работает под управлением Windows Vista или более поздней версии операционной системы Windows, командлет запрашивает учетные данные.
| Тип: | PSCredential |
| Position: | 3 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-CustomData
Задает хэш-таблицу пользовательских данных.
| Тип: | Hashtable |
| Position: | 9 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-Force
Указывает, что этот командлет перезаписывает существующий созданный модуль того же имени в существующей папке Modules.
| Тип: | SwitchParameter |
| Position: | 8 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-Headers
Задает заголовки веб-запроса. Введите хэш-таблицу или словарь.
| Тип: | Hashtable |
| Position: | 12 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-MetadataUri
Задает универсальный код ресурса (URI) метаданных конечной точки.
| Тип: | String |
| Position: | 2 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-OutputModule
Указывает путь и имя модуля, в которые этот командлет сохраняет созданный модуль команд прокси-сервера.
Этот командлет копирует двоичный модуль, манифест модуля и файл форматирования, если применимо, в указанную папку. Если указать только имя модуля, Export-ODataEndpointProxy сохраняет модуль в папке $HOME\Documents\WindowsPowerShell\Modules. Если указать путь, командлет создает папку модуля в этом пути.
| Тип: | String |
| Position: | 1 |
| Default value: | None |
| Обязательно: | True |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-ResourceNameMapping
Указывает хэш-таблицы, содержащие сопоставления, которые позволяют настраивать созданные командлеты. В этой хэш-схеме имя коллекции ресурсов является ключом. Нужное имя командлета — это значение.
Например, в хэш-таблице @{Products = 'Merchandise'}Products — это имя коллекции ресурсов, которое служит ключом.
товар является итоговой существителью командлета. Созданные имена командлетов могут не соответствовать рекомендациям по именованию командлетов Windows PowerShell. Вы можете изменить файл CDXML ресурса, чтобы изменить имена командлетов после создания этого командлета. Дополнительные сведения см. в настоятельно рекомендуемых рекомендаций по разработке.
| Тип: | Hashtable |
| Position: | 7 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-UpdateRequestMethod
Задает метод запроса обновления. Допустимые значения для этого параметра: PUT, POST и PATCH.
| Тип: | String |
| Допустимые значения: | Put, Post, Patch |
| Position: | 5 |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-Uri
Задает универсальный код ресурса (URI) конечной точки.
| Тип: | String |
| Position: | 0 |
| Default value: | None |
| Обязательно: | True |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-WhatIf
Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.
| Тип: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Обязательно: | False |
| Принять входные данные конвейера: | False |
| Принять подстановочные знаки: | False |
Связанные ссылки
PowerShell