Export-ODataEndpointProxy
Génère un module qui contient des applets de commande pour gérer un point de terminaison OData.
Syntaxe
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 Export-ODataEndpointProxy de commande 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 pour 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 d’accès 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 la marchandise 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.
| Type: | SwitchParameter |
| Position: | 10 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | 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.
| Type: | SwitchParameter |
| Position: | 11 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-CmdletAdapter
Spécifie l’adaptateur d’applet de commande. Les valeurs acceptables pour ce paramètre sont : ODataAdapter et NetworkControllerAdapter.
| Type: | String |
| Valeurs acceptées: | ODataAdapter, NetworkControllerAdapter, ODataV4Adapter |
| Position: | 6 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
| Type: | SwitchParameter |
| Alias: | cf |
| Position: | Named |
| Valeur par défaut: | False |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
-CreateRequestMethod
Spécifie la méthode de requête. Les valeurs acceptables pour ce paramètre sont : PUT, POST et PATCH.
| Type: | String |
| Valeurs acceptées: | Put, Post, Patch |
| Position: | 4 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | 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.
| Type: | PSCredential |
| Position: | 3 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-CustomData
Spécifie une table de hachage de données personnalisées.
| Type: | Hashtable |
| Position: | 9 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Force
Indique que cette applet de commande remplace un module généré existant du même nom dans un dossier existant Modules .
| Type: | SwitchParameter |
| Position: | 8 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Headers
Spécifie les en-têtes de la demande web. Entrez une table de hachage ou un dictionnaire.
| Type: | Hashtable |
| Position: | 12 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-MetadataUri
Spécifie l’URI des métadonnées du point de terminaison.
| Type: | String |
| Position: | 2 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | 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 enregistrez le module dans le $HOME\Documents\WindowsPowerShell\Modules dossier. Si vous spécifiez un chemin d’accès, l’applet de commande crée le dossier de module dans ce chemin.
| Type: | String |
| Position: | 1 |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | 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 @{Products = 'Merchandise'}de hachage, Products est le nom de la collection de ressources qui sert de clé. La marchandise 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.
| Type: | Hashtable |
| Position: | 7 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-UpdateRequestMethod
Spécifie la méthode de demande de mise à jour. Les valeurs acceptables pour ce paramètre sont : PUT, POST et PATCH.
| Type: | String |
| Valeurs acceptées: | Put, Post, Patch |
| Position: | 5 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-Uri
Spécifie l’URI du point de terminaison.
| Type: | String |
| Position: | 0 |
| Valeur par défaut: | None |
| Obligatoire: | True |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
-WhatIf
Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
| Type: | SwitchParameter |
| Alias: | wi |
| Position: | Named |
| Valeur par défaut: | False |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
