HelpCache/Microsoft.PowerShell.ODataUtils-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Updatable Help Version 5.0.1.0 --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-ODataEndpointProxy</command:name> <maml:description> <maml:para>Generates a module that contains cmdlets to manage an OData endpoint.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>ODataEndpointProxy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>Export-ODataEndpointProxy generates cmdlets for create, read, update, and delete (CRUD) operations, non-CRUD actions, and association manipulation.</maml:para> <maml:para>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.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-ODataEndpointProxy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1" aliases=""> <maml:name>Uri</maml:name> <maml:description> <maml:para>Specifies the endpoint’s URI; for example, 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc'. For best results, enclose the URI in single quotation marks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>OutputModule</maml:name> <maml:description> <maml:para>Specifies the path and module name to which you want the generated module of proxy commands exported. For example, C:\Users\user\GeneratedScript.psm1.</maml:para> <maml:para>A binary module, module manifest, and formatting file (if applicable) are copied to the specified folder. If you only specify the name of the module, such as GeneratedScript.psm1, Export-ODataEndpointProxy saves the module in the $home\Documents\WindowsPowerShell\Modules folder by default. If you specify a fully qualified path, the module folder is created in that path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>MetadataUri</maml:name> <maml:description> <maml:para>The URI of the endpoint’s metadata; for example, 'http://services.odata.org/v3/(S(snyruuepthagutkb2yulwldgf1))/odata/odata.svc/$metadata'. For best results, enclose the URI in single quotation marks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has access to the OData endpoint. The default is the current user. This parameter is required, and you are prompted to provide credentials, if a remote computer is running Windows Vista or a later release of the Windows operating system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases=""> <maml:name>ResourceNameMapping</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains mappings that let you customize the generated cmdlets. In this hashtable, you use the resource collection name as the key, with the desired cmdlet noun as the value. For example, -ResourceNameMapping @{Products = 'Merchandise'}, where Products represents the resource collection name that becomes the key, and Merchandise represents the resulting cmdlet noun. The generated cmdlet names might not align to Windows PowerShell <maml:navigationLink><maml:linkText>cmdlet naming conventions</maml:linkText><maml:uri></maml:uri></maml:navigationLink>, but you can edit the resource CDXML file to change the cmdlet names after Export-ODataEndpointProxy has created the module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the cmdlet to overwrite an existing, generated module of the same name in an existing Modules folder.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies a user account that has access to the OData endpoint. The default is the current user. This parameter is required, and you are prompted to provide credentials, if a remote computer is running Windows Vista or a later release of the Windows operating system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the cmdlet to overwrite an existing, generated module of the same name in an existing Modules folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>MetadataUri</maml:name> <maml:description> <maml:para>The URI of the endpoint’s metadata; for example, 'http://services.odata.org/v3/(S(snyruuepthagutkb2yulwldgf1))/odata/odata.svc/$metadata'. For best results, enclose the URI in single quotation marks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>OutputModule</maml:name> <maml:description> <maml:para>Specifies the path and module name to which you want the generated module of proxy commands exported. For example, C:\Users\user\GeneratedScript.psm1.</maml:para> <maml:para>A binary module, module manifest, and formatting file (if applicable) are copied to the specified folder. If you only specify the name of the module, such as GeneratedScript.psm1, Export-ODataEndpointProxy saves the module in the $home\Documents\WindowsPowerShell\Modules folder by default. If you specify a fully qualified path, the module folder is created in that path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases=""> <maml:name>ResourceNameMapping</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains mappings that let you customize the generated cmdlets. In this hashtable, you use the resource collection name as the key, with the desired cmdlet noun as the value. For example, -ResourceNameMapping @{Products = 'Merchandise'}, where Products represents the resource collection name that becomes the key, and Merchandise represents the resulting cmdlet noun. The generated cmdlet names might not align to Windows PowerShell <maml:navigationLink><maml:linkText>cmdlet naming conventions</maml:linkText><maml:uri></maml:uri></maml:navigationLink>, but you can edit the resource CDXML file to change the cmdlet names after Export-ODataEndpointProxy has created the module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1" aliases=""> <maml:name>Uri</maml:name> <maml:description> <maml:para>Specifies the endpoint’s URI; for example, 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc'. For best results, enclose the URI in single quotation marks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Generate a module to manage a retail web service endpoint</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>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' -OutputModule C:\Users\user\GeneratedScript.psm1 -ResourceNameMapping @{Products = 'Merchandise'} </dev:code> <dev:remarks> <maml:para>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.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=510069</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Creating a Management OData Web Service</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>OData Library</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>What is the OData Protocol?</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-RestMethod</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |