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

Export-ODataEndpointProxy

  • Ссылка
Модуль:
Microsoft.PowerShell.ODataUtils

Создает модуль, содержащий командлеты для управления конечной точкой 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, можно изменить файл.

Каждый командлет в созданном модуле должен включать параметр Подключение ionURI, чтобы подключиться к конечной точке, которой управляет модуль.

Примеры

Пример 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, добавьте параметр AllowUnsecure Подключение ion.

Параметры

-AllowClobber

Указывает, что этот командлет заменяет существующий модуль.

Type:SwitchParameter
Position:10
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AllowUnsecureConnection

Указывает, что этот модуль может подключаться к URI, которые не защищены SSL. Модуль может управлять сайтами HTTP в дополнение к сайтам HTTPS.

Type:SwitchParameter
Position:11
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-CmdletAdapter

Указывает адаптер командлета. Допустимыми значениями этого параметра являются ODataAdapter и NetworkControllerAdapter.

Type:String
Accepted values:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Запрос подтверждения перед выполнением командлета.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CreateRequestMethod

Задает метод запроса. Допустимые значения для этого параметра: PUT, POST и PATCH.

Type:String
Accepted values:Put, Post, Patch
Position:4
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Credential

Указывает учетную запись пользователя, доступ к конечной точке OData. Значение по умолчанию: текущий пользователь. Если удаленный компьютер работает под управлением Windows Vista или более поздней версии операционной системы Windows, командлет запрашивает учетные данные.

Type:PSCredential
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-CustomData

Задает хэш-таблицу пользовательских данных.

Type:Hashtable
Position:9
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Указывает, что этот командлет перезаписывает существующий созданный модуль того же имени в существующей Modules папке.

Type:SwitchParameter
Position:8
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Headers

Задает заголовки веб-запроса. Введите словарь или хэш-таблицу.

Type:Hashtable
Position:12
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MetadataUri

Задает универсальный код ресурса (URI) метаданных конечной точки.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OutputModule

Указывает путь и имя модуля, в которые этот командлет сохраняет созданный модуль команд прокси-сервера.

Этот командлет копирует двоичный модуль, манифест модуля и файл форматирования, если применимо, в указанную папку. Если указать только имя модуля, Export-ODataEndpointProxy сохраните модуль в папке $HOME\Documents\WindowsPowerShell\Modules . Если указать путь, командлет создает папку модуля в этом пути.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceNameMapping

Указывает хэш-таблицы, содержащие сопоставления, которые позволяют настраивать созданные командлеты. В этой хэш-схеме имя коллекции ресурсов является ключом. Нужное имя командлета — это значение.

Например, в хэш-таблице @{Products = 'Merchandise'}продукты — это имя коллекции ресурсов, которое служит ключом. Товар является результирующей существительным командлетом. Созданные имена командлетов могут не соответствовать рекомендациям по именованию командлетов Windows PowerShell. Вы можете изменить файл CDXML ресурса, чтобы изменить имена командлетов после создания этого командлета. Дополнительные сведения см. в руководстве по разработке с настоятельной поддержкой.

Type:Hashtable
Position:7
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UpdateRequestMethod

Задает метод запроса обновления. Допустимые значения для этого параметра: PUT, POST и PATCH.

Type:String
Accepted values:Put, Post, Patch
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Uri

Задает универсальный код ресурса (URI) конечной точки.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False