PowerShell Logo Small

Export-ODataEndpointProxy



This is the built-in help made by Microsoft for the command 'Export-ODataEndpointProxy', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Generates a module that contains cmdlets to manage an OData endpoint.

SYNTAX


Export-ODataEndpointProxy [-Uri] <String> [[-CustomData] [<Hashtable>]] [[-AllowClobber]] [[-AllowUnsecureConnection]] [-OutputModule] <String> [[-MetadataUri] [<String>]]
[[-Credential] [<PSCredential>]] [[-CreateRequestMethod] {Put | Post | Patch}] [[-UpdateRequestMethod] {Put | Post | Patch}] [[-CmdletAdapter] {ODataAdapter |
NetworkControllerAdapter}] [[-ResourceNameMapping] [<Hashtable>]] [[-Force]] [-Confirm] [-WhatIf] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


Export-ODataEndpointProxy uses an OData endpoint's metadata to generate a module, based on CDXML, that contains cmdlets you can use to manage an OData endpoint. After
generating the module, Export-ODataEndpointProxy saves the module to the path and file name specified by the OutputModule parameter.


Export-ODataEndpointProxy generates cmdlets for create, read, update, and delete (CRUD) operations, non-CRUD actions, and association manipulation.


Export-ODataEndpointProxy generates one CDXML file per endpoint resource. You can edit these CDXML files after the new module is generated (for example, if you need to
change the noun or verb names of the cmdlets to align with Windows PowerShell cmdlet naming guidelines. To connect with the endpoint it was generated to manage, every cmdlet
in a generated module includes a ConnectionURI parameter.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=510069
Creating a Management OData Web Service
OData Library
What is the OData Protocol?
Invoke-RestMethod

REMARKS

<

Examples


Example 1: Generate a module to manage a retail web service endpoint

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'}



This example generates a module to manage a retail service endpoint. The command specifies the endpoint’s URI, and the URI of the endpoint metadata; the command also
provides an output path and script module name as the value of the OutputModule parameter. For the value of the ResourceNameMapping parameter, the command provides a
hashtable that maps the resource collection name (Products, in this case) with the desired noun for the cmdlet set, Merchandise. To allow connections to non-SSL sites (HTTP,
as opposed to HTTPS), add the AllowUnsecureConnection parameter.