Partager via

Export-ODataEndpointProxy

Module:
Microsoft.PowerShell.ODataUtils Module

Génère un module qui contient des applets de commande pour gérer un point de terminaison OData.

Syntaxe

Default (Par défaut) 

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

L’applet de commande Export-ODataEndpointProxy utilise les métadonnées d’un point de terminaison OData pour générer un module qui contient des applets de commande que vous pouvez utiliser pour gérer ce point de terminaison OData. Le module est basé sur CDXML. Une fois cette applet de commande générée, elle enregistre ce module dans le chemin d’accès et le nom de fichier spécifiés par le paramètre OutputModule.

Export-ODataEndpointProxy génère des applets de commande pour les opérations de création, de lecture, de mise à jour et de suppression (CRUD), d’actions non CRUD et de manipulation d’association.

Export-ODataEndpointProxy génère un fichier CDXML par ressource de point de terminaison. Vous pouvez modifier ces fichiers CDXML une fois le module généré. Par exemple, si vous souhaitez modifier le nom ou les noms de verbes des applets de commande pour s’aligner sur les instructions d’affectation de noms des applets de commande Windows PowerShell, vous pouvez modifier le fichier.

Chaque applet de commande d’un module généré doit inclure un paramètre ConnectionURI afin de se connecter au point de terminaison que le module gère.

Exemples

Exemple 1 : Générer un module pour gérer un point de terminaison de service web de vente au détail

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

Cette commande génère un module pour gérer un point de terminaison de service de vente au détail. La commande spécifie l’URI du point de terminaison et l’URI des métadonnées de point de terminaison. La commande fournit également un chemin de sortie et un nom de module de script comme valeur du paramètre OutputModule. Pour la valeur du paramètre ResourceNameMapping, la commande fournit une table de hachage qui mappe le nom de la collection de ressources au nom souhaité pour l’ensemble d’applets de commande. Dans cet exemple, Products est le nom de la collection de ressources et Merchandise est le nom. Pour autoriser les connexions à des sites non SSL, HTTP, par opposition à HTTPS, ajoutez le paramètre AllowUnsecureConnection.

Paramètres

-AllowClobber

Indique que cette applet de commande remplace un module existant.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:10
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-AllowUnsecureConnection

Indique que ce module peut se connecter à des URI qui ne sont pas sécurisés par SSL. Le module peut gérer des sites HTTP en plus des sites HTTPS.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:11
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-CmdletAdapter

Spécifie l’adaptateur d’applet de commande. Les valeurs acceptables pour ce paramètre sont : ODataAdapter et NetworkControllerAdapter.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:6
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CreateRequestMethod

Spécifie la méthode de requête. Les valeurs acceptables pour ce paramètre sont : PUT, POST et PATCH.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:Put, Post, Patch
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:4
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Credential

Spécifie un compte d’utilisateur qui a accès au point de terminaison OData. La valeur par défaut est l’utilisateur actuel. Si un ordinateur distant exécute Windows Vista ou une version ultérieure du système d’exploitation Windows, l’applet de commande vous invite à entrer des informations d’identification.

Propriétés du paramètre

Type:PSCredential
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:3
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-CustomData

Spécifie une table de hachage de données personnalisées.

Propriétés du paramètre

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:9
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Force

Indique que cette applet de commande remplace un module généré existant du même nom dans un dossier de Modules existant.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:8
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Headers

Spécifie les en-têtes de la requête web. Entrez une table de hachage ou un dictionnaire.

Propriétés du paramètre

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:12
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-MetadataUri

Spécifie l’URI des métadonnées du point de terminaison.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:2
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-OutputModule

Spécifie le chemin d’accès et le nom du module dans lequel cette applet de commande enregistre le module généré de commandes proxy.

Cette applet de commande copie un module binaire, un manifeste de module et un fichier de mise en forme, le cas échéant, dans le dossier spécifié. Si vous spécifiez uniquement le nom du module, Export-ODataEndpointProxy enregistre le module dans le dossier $HOME\Documents\WindowsPowerShell\Modules. Si vous spécifiez un chemin d’accès, l’applet de commande crée le dossier de module dans ce chemin.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:1
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ResourceNameMapping

Spécifie une table de hachage qui contient des mappages qui vous permettent de personnaliser les applets de commande générées. Dans cette table de hachage, le nom de la collection de ressources est la clé. Le nom de l’applet de commande souhaité est la valeur.

Par exemple, dans la table de hachage @{Products = 'Merchandise'}, Products est le nom de la collection de ressources qui sert de clé. l' de marchandises est le nom d’applet de commande résultant. Les noms d’applets de commande générés peuvent ne pas s’aligner sur les instructions d’affectation de noms des applets de commande Windows PowerShell. Vous pouvez modifier le fichier CDXML de ressource pour modifier les noms d’applets de commande une fois que cette applet de commande a créé le module. Pour plus d’informations, consultez recommandations de développement fortement encouragées.

Propriétés du paramètre

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:7
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-UpdateRequestMethod

Spécifie la méthode de demande de mise à jour. Les valeurs acceptables pour ce paramètre sont : PUT, POST et PATCH.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:Put, Post, Patch
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:5
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Uri

Spécifie l’URI du point de terminaison.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.