New-WebServiceProxy
Crée un objet proxy de service web qui vous permet d’utiliser et de gérer le service Web dans Windows PowerShell.
Syntaxe
NoCredentials (Par défaut)
New-WebServiceProxy
[-Uri] <Uri>
[[-Class] <String>]
[[-Namespace] <String>]
[<CommonParameters>]
Credential
New-WebServiceProxy
[-Uri] <Uri>
[[-Class] <String>]
[[-Namespace] <String>]
[-Credential <PSCredential>]
[<CommonParameters>]
UseDefaultCredential
New-WebServiceProxy
[-Uri] <Uri>
[[-Class] <String>]
[[-Namespace] <String>]
[-UseDefaultCredential]
[<CommonParameters>]
Description
La cmdlet 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, en particulier sur Internet. Microsoft .NET Framework fournit des objets proxy de service web qui représentent le service Web en tant qu’objet .NET Framework.
Exemples
Exemple 1 : Créer un proxy pour un service web
PS C:\> $zip = New-WebServiceProxy -Uri "http://www.webservicex.net/uszip.asmx?WSDL"
Cette commande crée un proxy .NET Framework du service Web US Zip dans Windows PowerShell.
Exemple 2 : Créer un proxy pour un service Web et spécifier l’espace de noms et la classe
PS C:\> $URI = "http://www.webservicex.net/uszip.asmx?WSDL"
PS C:\> $zip = New-WebServiceProxy -Uri $URI -Namespace "WebServiceProxy" -Class "USZip"
Cette commande utilise l’applet de commande New-WebServiceProxy pour créer un proxy .NET Framework du service Web Zip us.
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 d’espace de noms et Classe pour spécifier l’espace de noms et la classe de l’objet.
Exemple 3 : Afficher les méthodes d’un proxy de service web
PS C:\> $zip | Get-Member -MemberType 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
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 allons utiliser ces méthodes dans l’exemple suivant.
Notez que l'TypeName de l’objet proxy, WebServiceProxy, reflète les noms d’espace de noms et de classes spécifiés dans l’exemple précédent.
Exemple 4 : Utiliser un proxy de service web
PS C:\> $zip.GetInfoByZip(20500).table
CITY : Washington
STATE : DC
ZIP : 20500
AREA_CODE : 202
TIME_ZONE : E
Cette commande utilise le proxy de service Web stocké dans la variable $zip. La commande utilise la méthode GetInfoByZip du proxy et sa propriété Table.
Paramètres
-Class
Spécifie un nom pour la classe proxy créée par l’applet de commande 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 (Uniform Resource Identifier).
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 |
| Alias: | Nom du fichier, FN |
Jeux de paramètres
(All)
| Position: | 1 |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Credential
Spécifie un compte d’utilisateur autorisé à effectuer 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, ou entrez un objet PSCredential, tel qu’un objet généré par l’applet de commande Get-Credential. Si vous tapez un nom d’utilisateur, cette applet de commande vous invite à entrer un mot de passe.
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 |
| Alias: | Cred |
Jeux de paramètres
Credential
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Namespace
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 de classe pour générer un nom complet pour la classe. La valeur par défaut est Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes plus un type généré à partir de l’URI.
Vous pouvez définir la valeur du paramètre Espace de noms afin de pouvoir accéder à plusieurs services Web portant le même nom.
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 |
| Alias: | NS |
Jeux de paramètres
(All)
| Position: | 2 |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Uri
Spécifie l’URI du service Web. Entrez un URI ou le chemin d’accès et le nom de fichier d’un fichier qui contient une description de service.
L’URI doit faire référence à une page .asmx ou à une page qui retourne une description de service.
Pour renvoyer une description de service d’un service Web créé à l’aide de ASP.NET, ajoutez « ? WSDL » vers l’URL du service Web (par exemple, https://www.contoso.com/MyWebService.asmx?WSDL).
Propriétés du paramètre
| Type: | Uri |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | WL, WSDL, Chemin |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-UseDefaultCredential
Indique que cette applet de commande utilise les informations d’identification par défaut. Cette applet de commande définit la propriété UseDefaultCredential dans l’objet proxy résultant sur True. Il s’agit d’une alternative à l’utilisation du paramètre Credential.
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 |
| Alias: | UDC |
Jeux de paramètres
UseDefaultCredential
| 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.
Entrées
None
Vous ne pouvez pas diriger d'entrée vers cette applet de commande.
Sorties
A Web service proxy object
Cette applet de commande retourne un objet proxy de service web. L’espace de noms et la classe de l’objet 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.
Notes
New-WebServiceProxy utilise la classe System.Net.WebClient pour charger le service Web spécifié.