New-WebServiceProxy

Article
01/13/2010

Crée un objet proxy de service Web qui vous permet d'utiliser et de gérer le service Web dans Windows PowerShell.

Syntaxe

New-WebServiceProxy [-URI] <Uri> [[-Class] <string>] [[-Namespace] <string>] [<CommonParameters>]

New-WebServiceProxy [-URI] <Uri> [[-Class] <string>] [[-Namespace] <string>] [-Credential <PSCredential>] [<CommonParameters>]

New-WebServiceProxy [-URI] <Uri> [[-Class] <string>] [[-Namespace] <string>] [-UseDefaultCredential] [<CommonParameters>]

Description

L'applet de commande New-WebServiceProxy vous permet d'utiliser un service Web dans Windows PowerShell. L'applet de commande se connecte à un service Web et crée un objet proxy de service Web dans Windows PowerShell. Vous pouvez utiliser l'objet proxy pour gérer le service Web.

Un service Web est un programme XML qui échange des données sur un réseau, notamment sur Internet. Microsoft .NET Framework fournit des objets proxy de service Web qui représentent le service Web sous la forme d'un objet .NET Framework.

Paramètres

-Class <string>

Spécifie le nom de la classe proxy que l'applet de commande crée pour le service Web. La valeur de ce paramètre est utilisée avec le paramètre Namespace pour fournir un nom complet pour la classe. La valeur par défaut est générée à partir de l'URI.

Obligatoire ?	false
Position ?	2
Valeur par défaut	Generated from the URI
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Credential <PSCredential>

Spécifie un compte d'utilisateur qui a l'autorisation d'exécuter cette action. La valeur par défaut est l'utilisateur actuel. Il s'agit d'une alternative à l'utilisation du paramètre UseDefaultCredential.

Tapez un nom d'utilisateur, tel que « User01 » ou « Domain01\User01 ». Vous pouvez également entrer un objet PSCredential, tel que celui généré par l'applet de commande Get-Credential. Si vous tapez un nom d'utilisateur, vous êtes invité à entrer un mot de passe.

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Namespace <string>

Spécifie un espace de noms pour la nouvelle classe.

La valeur de ce paramètre est utilisée avec la valeur du paramètre Class pour générer un nom complet pour la classe. La valeur par défaut est Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes plus un type qui est généré à partir de l'URI.

Vous pouvez définir la valeur du paramètre Namespace de manière à pouvoir accéder à plusieurs services Web avec le même nom.

Obligatoire ?	false
Position ?	3
Valeur par défaut	Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-URI <Uri>

Spécifie l'URI du service Web. Entrez un URI ou le nom et le chemin d'accès d'un fichier qui contient une description du service.

L'URI doit faire référence à une page .asmx ou à une page qui retourne une description du service. Pour retourner une description d'un service Web qui a été créé à l'aide d'ASP.NET, ajoutez « ?WSDL » à l'URL de ce service Web (par exemple, https://www.contoso.com/MyWebService.asmx?WSDL).

Obligatoire ?	true
Position ?	1
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-UseDefaultCredential

Affecte la valeur True au paramètre UseDefaultCredential dans l'objet proxy résultant. Il s'agit d'une alternative à l'utilisation du paramètre Credential.

Obligatoire ?	false
Position ?	named
Valeur par défaut	False
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.

Entrées et sorties

Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.

Entrées

None

Cette applet de commande n'accepte pas d'entrée provenant du pipeline.

Sorties

Un objet proxy de service Web

L'espace de noms et la classe des objets sont déterminés par les paramètres de la commande. La valeur par défaut est générée à partir de l'URI d'entrée (URI, Uniform Resource Identifier).

Remarques

New-WebServiceProxy utilise la classe System.Net.WebClient pour charger le service Web spécifié.

Exemple 1

C:\PS>$zip = New-WebServiceProxy -uri http://www.webservicex.net/uszip.asmx?WSDL

Description
-----------
Cette commande utilise la commande New-WebServiceProxy pour créer un proxy .NET Framework du service US Zip Web dans Windows PowerShell.

Exemple 2

C:\PS>$URI = "http://www.webservicex.net/uszip.asmx?WSDL" 

C:\PS> $zip = New-WebServiceProxy -uri $URI -namespace WebServiceProxy -class ZipClass

Description
-----------
Cette commande utilise l'applet de commande New-WebServiceProxy pour créer un proxy .NET Framework du service US Zip Web.

La première commande stocke l'URI du service Web dans la variable $URI.

La deuxième commande crée le proxy de service Web. La commande utilise le paramètre URI pour spécifier l'URI et les paramètres Namespace et Class pour spécifier l'espace de noms et la classe de l'objet.

Exemple 3

C:\PS>$zip | get-member -type method

   TypeName: WebServiceProxy.USZip

Name                      MemberType Definition
----                      ---------- ----------
Abort                     Method     System.Void Abort(
BeginGetInfoByAreaCode    Method     System.IAsyncResul
BeginGetInfoByCity        Method     System.IAsyncResul
BeginGetInfoByState       Method     System.IAsyncResul
BeginGetInfoByZIP         Method     System.IAsyncResul
CreateObjRef              Method     System.Runtime.Rem
Discover                  Method     System.Void Discov
Dispose                   Method     System.Void Dispos
EndGetInfoByAreaCode      Method     System.Xml.XmlNode
EndGetInfoByCity          Method     System.Xml.XmlNode
EndGetInfoByState         Method     System.Xml.XmlNode
EndGetInfoByZIP           Method     System.Xml.XmlNode
Equals                    Method     System.Boolean Equ
GetHashCode               Method     System.Int32 GetHa
GetInfoByAreaCode         Method     System.Xml.XmlNode
GetInfoByCity             Method     System.Xml.XmlNode
GetInfoByState            Method     System.Xml.XmlNode
GetInfoByZIP              Method     System.Xml.XmlNode
GetLifetimeService        Method     System.Object GetL
GetType                   Method     System.Type GetTyp
InitializeLifetimeService Method     System.Object Init
ToString                  Method     System.String ToSt

Description
-----------
Cette commande utilise l'applet de commande Get-Member pour afficher les méthodes de l'objet proxy de service Web dans la variable $zip. Nous utiliserons ces méthodes dans l'exemple suivant.

Notez que le paramètre TypeName de l'objet proxy (WebServiceProxy) reprend le nom de l'espace de noms et le nom de la classe qui ont été spécifiés dans l'exemple précédent.

Exemple 4

C:\PS>$zip.getinfobyzip(20500).table

CITY      : Washington
STATE     : DC
ZIP       : 20500
AREA_CODE : 202
TIME_ZONE : E

Description
-----------
Cette commande utilise le proxy de service Web stocké dans la variable Zip. La commande utilise la méthode GetInfoByZip du proxy, ainsi que sa propriété Table.

Voir aussi

Concepts

New-Service

Partager via