Compartir a través de

Export-ODataEndpointProxy

  • Referencia
Módulo:
Microsoft.PowerShell.ODataUtils

Genera un módulo que contiene cmdlets para administrar un punto de conexión de OData.

Sintaxis

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>]

Description

El Export-ODataEndpointProxy cmdlet usa los metadatos de un punto de conexión de OData para generar un módulo que contiene cmdlets que puede usar para administrar ese punto de conexión de OData. El módulo se basa en CDXML. Una vez que este cmdlet genera el módulo, guarda ese módulo en la ruta de acceso y el nombre de archivo especificados por el parámetro OutputModule .

Export-ODataEndpointProxy genera cmdlets para operaciones de creación, lectura, actualización y eliminación (CRUD), acciones que no son CRUD y manipulación de asociaciones.

Export-ODataEndpointProxy genera un archivo CDXML por recurso de punto de conexión. Puede editar estos archivos CDXML una vez generado el módulo. Por ejemplo, si desea cambiar los nombres de nombre o verbo de los cmdlets para que se alineen con las directrices de nomenclatura de cmdlets de Windows PowerShell, puede modificar el archivo.

Todos los cmdlets de un módulo generado deben incluir un parámetro ConnectionURI para conectarse al punto de conexión que administra el módulo.

Ejemplos

Ejemplo 1: Generación de un módulo para administrar un punto de conexión de servicio web minorista

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

Este comando genera un módulo para administrar un punto de conexión de servicio comercial. El comando especifica el URI del punto de conexión y el URI de los metadatos del punto de conexión. El comando también proporciona una ruta de acceso de salida y un nombre del módulo de script como valor del parámetro OutputModule . Para el valor del parámetro ResourceNameMapping , el comando proporciona una tabla hash que asigna el nombre de la colección de recursos al nombre deseado para el conjunto de cmdlets. En este ejemplo, Products es el nombre de la colección de recursos y La mercancía es el nombre. Para permitir conexiones a sitios que no son SSL, HTTP, en lugar de HTTPS, agregue el parámetro AllowUnsecureConnection .

Parámetros

-AllowClobber

Indica que este cmdlet reemplaza a un módulo existente.

Tipo:SwitchParameter
Posición:10
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-AllowUnsecureConnection

Indica que este módulo puede conectarse a los URI que no están protegidos por SSL. El módulo puede administrar sitios HTTP además de sitios HTTPS.

Tipo:SwitchParameter
Posición:11
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-CmdletAdapter

Especifica el adaptador de cmdlet. Los valores aceptables para este parámetro son: ODataAdapter y NetworkControllerAdapter.

Tipo:String
Valores aceptados:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Posición:6
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-CreateRequestMethod

Especifica el método de solicitud. Los valores aceptables para este parámetro son: PUT, POST y PATCH.

Tipo:String
Valores aceptados:Put, Post, Patch
Posición:4
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Credential

Especifica una cuenta de usuario que tiene acceso al punto de conexión de OData. El valor predeterminado es el usuario actual. Si un equipo remoto ejecuta Windows Vista o una versión posterior del sistema operativo Windows, el cmdlet le pedirá credenciales.

Tipo:PSCredential
Posición:3
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-CustomData

Especifica una tabla hash de datos personalizados.

Tipo:Hashtable
Posición:9
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Force

Indica que este cmdlet sobrescribe un módulo generado existente con el mismo nombre en una carpeta existente Modules .

Tipo:SwitchParameter
Posición:8
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Headers

Especifica los encabezados de la solicitud web. Especifique una tabla hash o un diccionario.

Tipo:Hashtable
Posición:12
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-MetadataUri

Especifica el URI de los metadatos del punto de conexión.

Tipo:String
Posición:2
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-OutputModule

Especifica la ruta de acceso y el nombre del módulo en el que este cmdlet guarda el módulo generado de comandos proxy.

Este cmdlet copia un módulo binario, un manifiesto de módulo y un archivo de formato, si procede, en la carpeta especificada. Si especifica solo el nombre del módulo, Export-ODataEndpointProxy guarda el módulo en la $HOME\Documents\WindowsPowerShell\Modules carpeta . Si especifica una ruta de acceso, el cmdlet crea la carpeta del módulo en esa ruta de acceso.

Tipo:String
Posición:1
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ResourceNameMapping

Especifica una tabla hash que contiene asignaciones que permiten personalizar los cmdlets generados. En esta tabla hash, el nombre de la colección de recursos es la clave. El nombre del cmdlet deseado es el valor.

Por ejemplo, en la tabla @{Products = 'Merchandise'}hash , Products es el nombre de la colección de recursos que actúa como clave. La mercancía es el nombre del cmdlet resultante. Es posible que los nombres de cmdlet generados no se alineen con las directrices de nomenclatura de cmdlets de Windows PowerShell. Puede modificar el archivo CDXML de recursos para cambiar los nombres de cmdlet después de que este cmdlet cree el módulo. Para obtener más información, vea Instrucciones de desarrollo fuertemente fomentadas.

Tipo:Hashtable
Posición:7
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-UpdateRequestMethod

Especifica el método de solicitud de actualización. Los valores aceptables para este parámetro son: PUT, POST y PATCH.

Tipo:String
Valores aceptados:Put, Post, Patch
Posición:5
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Uri

Especifica el URI del punto de conexión.

Tipo:String
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False