Export-ODataEndpointProxy

生成一个模块,其中包含用于管理 OData 终结点的 cmdlet。

语法

Default (默认值)

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 cmdlet 使用 OData 终结点的元数据来生成一个模块,其中包含可用于管理该 OData 终结点的 cmdlet。 该模块基于 CDXML。 在此 cmdlet 生成模块后,它将该模块保存到 OutputModule 参数指定的路径和文件名。

Export-ODataEndpointProxy 生成用于创建、读取、更新和删除(CRUD)作、非 CRUD作和关联作的 cmdlet。

Export-ODataEndpointProxy 为每个终结点资源生成一个 CDXML 文件。 生成模块后,可以编辑这些 CDXML 文件。 例如,如果要更改 cmdlet 的名词或谓词名称,以便与 Windows PowerShell cmdlet 命名准则保持一致,可以修改该文件。

生成的模块中的每个 cmdlet 都必须包含 ConnectionURI 参数才能连接到模块管理的终结点。

示例

示例 1:生成用于管理零售 Web 服务终结点的模块

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 参数的值,该命令提供一个哈希表,用于将资源集合名称映射到 cmdlet 集的所需名词。 在此示例中,产品是资源集合名称,商品 是名词。 若要允许连接到非 SSL 站点,HTTP 而不是 HTTPS,请添加 AllowUnsecureConnection 参数。

参数

-AllowClobber

指示此 cmdlet 替换现有模块。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:10
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-AllowUnsecureConnection

指示此模块可以连接到不受 SSL 保护的 URI。 除了 HTTPS 站点之外,该模块还可以管理 HTTP 站点。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:11
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-CmdletAdapter

指定 cmdlet 适配器。 此参数的可接受值为:ODataAdapter 和 NetworkControllerAdapter。

参数属性

类型:String
默认值:None
接受的值:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
支持通配符:False
不显示:False

参数集

(All)
Position:6
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-CreateRequestMethod

指定请求方法。 此参数的可接受值为:PUT、POST 和 PATCH。

参数属性

类型:String
默认值:None
接受的值:Put, Post, Patch
支持通配符:False
不显示:False

参数集

(All)
Position:4
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Credential

指定有权访问 OData 终结点的用户帐户。 默认值为当前用户。 如果远程计算机运行 Windows Vista 或更高版本的 Windows 操作系统,则 cmdlet 会提示你输入凭据。

参数属性

类型:PSCredential
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:3
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-CustomData

指定自定义数据的哈希表。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:9
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Force

指示此 cmdlet 覆盖现有 Modules 文件夹中同名的现有生成的模块。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:8
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Headers

指定 Web 请求的标头。 输入哈希表或字典。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:12
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-MetadataUri

指定终结点元数据的 URI。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:2
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-OutputModule

指定此 cmdlet 将生成的代理命令模块保存到的路径和模块名称。

此 cmdlet 将二进制模块、模块清单和格式化文件(如果适用)复制到指定文件夹。 如果仅指定模块的名称,Export-ODataEndpointProxy 将模块保存在 $HOME\Documents\WindowsPowerShell\Modules 文件夹中。 如果指定路径,cmdlet 将在该路径中创建模块文件夹。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-ResourceNameMapping

指定一个哈希表,其中包含用于自定义生成的 cmdlet 的映射。 在此哈希表中,资源集合名称是密钥。 所需的 cmdlet 名词是值。

例如,在哈希表中 @{Products = 'Merchandise'}Products 是用作键的资源集合名称。 商品 是生成的 cmdlet 名词。 生成的 cmdlet 名称可能与 Windows PowerShell cmdlet 命名准则不一致。 可以修改资源 CDXML 文件,以在此 cmdlet 创建模块后更改 cmdlet 名称。 有关详细信息,请参阅 强烈建议的发展准则。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:7
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-UpdateRequestMethod

指定更新请求方法。 此参数的可接受值为:PUT、POST 和 PATCH。

参数属性

类型:String
默认值:None
接受的值:Put, Post, Patch
支持通配符:False
不显示:False

参数集

(All)
Position:5
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Uri

指定终结点的 URI。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters