< Back
Export-ODataEndpointProxy
Post
NAME Export-ODataEndpointProxy
SYNOPSIS
Generates a module that contains cmdlets to manage an OData endpoint.
SYNTAX
Export-ODataEndpointProxy [-Uri] <String> [-OutputModule] <String> [[-AllowClobber]] [[-AllowUnsecureConnection]] [[-Headers] <Hashtable>]
[[-MetadataUri] <String>] [[-Credential] <PSCredential>] [[-CreateRequestMethod] {Put | Post | Patch}] [[-UpdateRequestMethod] {Put | Post |
Patch}] [[-CmdletAdapter] {ODataAdapter | NetworkControllerAdapter | ODataV4Adapter}] [[-ResourceNameMapping] <Hashtable>] [[-Force]]
[[-CustomData] <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Export-ODataEndpointProxy cmdlet uses the metadata of an OData endpoint to generate a module that contains cmdlets you can use to manage that
OData endpoint. The module is based on CDXML. After this cmdlet generates the module, it saves that 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
module is generated. For example, if you want to change the noun or verb names of the cmdlets to align with Windows PowerShell cmdlet naming
guidelines, you can modify the file.
Every cmdlet in a generated module must include a ConnectionURI parameter in order to connect to the endpoint that the module manages.
PARAMETERS
-AllowClobber [<SwitchParameter>]
Indicates that this cmdlet replaces an existing module.
Required? false
Position? 10
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AllowUnsecureConnection [<SwitchParameter>]
Indicates that this module can connect to URIs that are not SSL-secured. The module can manage HTTP sites in addition to HTTPS sites.
Required? false
Position? 11
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CmdletAdapter <String>
Specifies the cmdlet adapter. The acceptable values for this parameter are: ODataAdapter and NetworkControllerAdapter.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-CreateRequestMethod <String>
Specifies the request method. The acceptable values for this parameter are: PUT, POST, and PATCH.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has access to the OData endpoint. The default value is the current user. If a remote computer runs Windows Vista
or a later release of the Windows operating system, the cmdlet prompts you for credentials.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CustomData <Hashtable>
Specifies a hash table of custom data.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet overwrites an existing generated module of the same name in an existing `Modules` folder.
Required? false
Position? 8
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Headers <Hashtable>
@{Text=}
Required? false
Position? 12
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MetadataUri <String>
Specifies the URI of the metadata of the endpoint.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OutputModule <String>
Specifies the path and module name to which this cmdlet saves the generated module of proxy commands.
This cmdlet copies a binary module, module manifest, and formatting file, if applicable, to the specified folder. If you specify only the name
of the module, Export-ODataEndpointProxy saves the module in the `$home\\Documents\\WindowsPowerShell\\Modules` folder. If you specify a path,
the cmdlet creates the module folder in that path.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceNameMapping <Hashtable>
Specifies a hashtable that contains mappings that let you customize the generated cmdlets. In this hashtable, the resource collection name is
the key. The desired cmdlet noun is the value.
For example, in the hash table @{Products = 'Merchandise'}, Products is the resource collection name that serves as the key. Merchandise is
the resulting cmdlet noun. The generated cmdlet names might not align to Windows PowerShellcmdlet naming guidelines. You can modify the
resource CDXML file to change the cmdlet names after this cmdlet creates the module. For more information, see Strongly Encouraged Development
Guidelineshttp://msdn.microsoft.com/library/dd878270(v=vs.85).aspx (http://msdn.microsoft.com/library/dd878 ... s.85).aspx) in the Microsoft
Developer Network library.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UpdateRequestMethod <String>
Specifies the update request method. The acceptable values for this parameter are: PUT, POST, and PATCH.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Uri <String>
Specifies the URI of the endpoint.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
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 command generates a module to manage a retail service endpoint. The command specifies the URI of the endpoint 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 to the desired noun for the cmdlet set. In
this example, Products is the resource collection name and Merchandise is the noun. To allow connections to non-SSL sites, HTTP, as opposed to
HTTPS, add the AllowUnsecureConnection parameter.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=510069
OData Library http://technet.microsoft.com/windowsser ... s.85).aspx
What is the OData Protocol? http://www.odata.org/
SYNOPSIS
Generates a module that contains cmdlets to manage an OData endpoint.
SYNTAX
Export-ODataEndpointProxy [-Uri] <String> [-OutputModule] <String> [[-AllowClobber]] [[-AllowUnsecureConnection]] [[-Headers] <Hashtable>]
[[-MetadataUri] <String>] [[-Credential] <PSCredential>] [[-CreateRequestMethod] {Put | Post | Patch}] [[-UpdateRequestMethod] {Put | Post |
Patch}] [[-CmdletAdapter] {ODataAdapter | NetworkControllerAdapter | ODataV4Adapter}] [[-ResourceNameMapping] <Hashtable>] [[-Force]]
[[-CustomData] <Hashtable>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Export-ODataEndpointProxy cmdlet uses the metadata of an OData endpoint to generate a module that contains cmdlets you can use to manage that
OData endpoint. The module is based on CDXML. After this cmdlet generates the module, it saves that 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
module is generated. For example, if you want to change the noun or verb names of the cmdlets to align with Windows PowerShell cmdlet naming
guidelines, you can modify the file.
Every cmdlet in a generated module must include a ConnectionURI parameter in order to connect to the endpoint that the module manages.
PARAMETERS
-AllowClobber [<SwitchParameter>]
Indicates that this cmdlet replaces an existing module.
Required? false
Position? 10
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AllowUnsecureConnection [<SwitchParameter>]
Indicates that this module can connect to URIs that are not SSL-secured. The module can manage HTTP sites in addition to HTTPS sites.
Required? false
Position? 11
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CmdletAdapter <String>
Specifies the cmdlet adapter. The acceptable values for this parameter are: ODataAdapter and NetworkControllerAdapter.
Required? false
Position? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-CreateRequestMethod <String>
Specifies the request method. The acceptable values for this parameter are: PUT, POST, and PATCH.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has access to the OData endpoint. The default value is the current user. If a remote computer runs Windows Vista
or a later release of the Windows operating system, the cmdlet prompts you for credentials.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CustomData <Hashtable>
Specifies a hash table of custom data.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Force [<SwitchParameter>]
Indicates that this cmdlet overwrites an existing generated module of the same name in an existing `Modules` folder.
Required? false
Position? 8
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Headers <Hashtable>
@{Text=}
Required? false
Position? 12
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MetadataUri <String>
Specifies the URI of the metadata of the endpoint.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OutputModule <String>
Specifies the path and module name to which this cmdlet saves the generated module of proxy commands.
This cmdlet copies a binary module, module manifest, and formatting file, if applicable, to the specified folder. If you specify only the name
of the module, Export-ODataEndpointProxy saves the module in the `$home\\Documents\\WindowsPowerShell\\Modules` folder. If you specify a path,
the cmdlet creates the module folder in that path.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceNameMapping <Hashtable>
Specifies a hashtable that contains mappings that let you customize the generated cmdlets. In this hashtable, the resource collection name is
the key. The desired cmdlet noun is the value.
For example, in the hash table @{Products = 'Merchandise'}, Products is the resource collection name that serves as the key. Merchandise is
the resulting cmdlet noun. The generated cmdlet names might not align to Windows PowerShellcmdlet naming guidelines. You can modify the
resource CDXML file to change the cmdlet names after this cmdlet creates the module. For more information, see Strongly Encouraged Development
Guidelineshttp://msdn.microsoft.com/library/dd878270(v=vs.85).aspx (http://msdn.microsoft.com/library/dd878 ... s.85).aspx) in the Microsoft
Developer Network library.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UpdateRequestMethod <String>
Specifies the update request method. The acceptable values for this parameter are: PUT, POST, and PATCH.
Required? false
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Uri <String>
Specifies the URI of the endpoint.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
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 command generates a module to manage a retail service endpoint. The command specifies the URI of the endpoint 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 to the desired noun for the cmdlet set. In
this example, Products is the resource collection name and Merchandise is the noun. To allow connections to non-SSL sites, HTTP, as opposed to
HTTPS, add the AllowUnsecureConnection parameter.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=510069
OData Library http://technet.microsoft.com/windowsser ... s.85).aspx
What is the OData Protocol? http://www.odata.org/