Compartir a través de


Export-ODataEndpointProxy

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

Sintaxis

Default (valor predeterminado)

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 cmdlet Export-ODataEndpointProxy 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 las 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.

Cada cmdlet de un módulo generado debe 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 el 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 Mercancías 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.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:10
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes: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.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:11
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-CmdletAdapter

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Valores aceptados:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:6
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False
Alias:cf

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-CreateRequestMethod

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Valores aceptados:Put, Post, Patch
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:4
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes: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.

Propiedades de parámetro

Tipo:PSCredential
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:3
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-CustomData

Especifica una tabla hash de datos personalizados.

Propiedades de parámetro

Tipo:Hashtable
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:9
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Force

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

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:8
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Headers

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

Propiedades de parámetro

Tipo:Hashtable
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:12
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-MetadataUri

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:2
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes: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 carpeta $HOME\Documents\WindowsPowerShell\Modules. Si especifica una ruta de acceso, el cmdlet crea la carpeta del módulo en esa ruta de acceso.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes: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 hash @{Products = 'Merchandise'}, Products es el nombre de la colección de recursos que actúa como clave. Merchandise 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.

Propiedades de parámetro

Tipo:Hashtable
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:7
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-UpdateRequestMethod

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Valores aceptados:Put, Post, Patch
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:5
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Uri

Especifica el URI del punto de conexión.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-WhatIf

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

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False
Alias:Wi

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.