Freigeben über

New-WebServiceProxy

Modul:
Microsoft.PowerShell.Management Module

Erstellt ein Webdienstproxyobjekt, mit dem Sie den Webdienst in Windows PowerShell verwenden und verwalten können.

Syntax

NoCredentials (Standard) 

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>]

Beschreibung

Mit dem Cmdlet New-WebServiceProxy können Sie einen Webdienst in Windows PowerShell verwenden. Das Cmdlet stellt eine Verbindung mit einem Webdienst her und erstellt ein Webdienstproxyobjekt in Windows PowerShell. Sie können das Proxyobjekt verwenden, um den Webdienst zu verwalten.

Ein Webdienst ist ein XML-basiertes Programm, das Daten über ein Netzwerk austauscht, insbesondere über das Internet. Microsoft .NET Framework stellt Webdienstproxyobjekte bereit, die den Webdienst als .NET Framework-Objekt darstellen.

Beispiele

Beispiel 1: Erstellen eines Proxys für einen Webdienst

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

Mit diesem Befehl wird ein .NET Framework-Proxy des US-amerikanischen Zip-Webdiensts in Windows PowerShell erstellt.

Beispiel 2: Erstellen eines Proxys für einen Webdienst und Angeben von Namespace und Klasse

PS C:\> $URI = "http://www.webservicex.net/uszip.asmx?WSDL"
PS C:\> $zip = New-WebServiceProxy -Uri $URI -Namespace "WebServiceProxy" -Class "USZip"

Mit diesem Befehl wird das Cmdlet New-WebServiceProxy verwendet, um einen .NET Framework-Proxy des US Zip-Webdiensts zu erstellen.

Der erste Befehl speichert den URI des Webdiensts in der Variablen $URI.

Mit dem zweiten Befehl wird der Webdienstproxy erstellt. Der Befehl verwendet den URI--Parameter, um den URI und den Namespace- und Class Parameter anzugeben, um den Namespace und die Klasse des Objekts anzugeben.

Beispiel 3: Anzeigen von Methoden eines Webdienstproxys

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

Mit diesem Befehl wird das Cmdlet Get-Member verwendet, um die Methoden des Webdienstproxyobjekts in der Variablen $zip anzuzeigen. Wir werden diese Methoden im folgenden Beispiel verwenden.

Beachten Sie, dass der TypeName- des Proxyobjekts, WebServiceProxy, den Namespace- und Klassennamen widerspiegelt, die im vorherigen Beispiel angegeben wurden.

Beispiel 4: Verwenden eines Webdienstproxys

PS C:\> $zip.GetInfoByZip(20500).table
CITY      : Washington
STATE     : DC
ZIP       : 20500
AREA_CODE : 202
TIME_ZONE : E

Dieser Befehl verwendet den Webdienst-Proxy, der in der Variablen $zip gespeichert ist. Der Befehl verwendet die GetInfoByZip-Methode des Proxys und dessen Table-Eigenschaft.

Parameter

-Class

Gibt einen Namen für die Proxyklasse an, die vom Cmdlet für den Webdienst erstellt wird. Der Wert dieses Parameters wird zusammen mit dem Namespace Parameter verwendet, um einen vollqualifizierten Namen für die Klasse bereitzustellen. Der Standardwert wird aus dem URI (Uniform Resource Identifier) generiert.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Dateiname, FN

Parametersätze

(All)
Position:1
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Credential

Gibt ein Benutzerkonto an, das über die Berechtigung zum Ausführen dieser Aktion verfügt. Die Standardeinstellung ist der aktuelle Benutzer. Dies ist eine Alternative zur Verwendung des parameters UseDefaultCredential.

Geben Sie einen Benutzernamen ein, z. B. "User01" oder "Domain01\User01", oder geben Sie ein PSCredential--Objekt ein, z. B. ein Objekt, das vom Cmdlet Get-Credential generiert wird. Wenn Sie einen Benutzernamen eingeben, werden Sie von diesem Cmdlet aufgefordert, ein Kennwort einzugeben.

Parametereigenschaften

Typ:PSCredential
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Cred

Parametersätze

Credential
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Namespace

Gibt einen Namespace für die neue Klasse an.

Der Wert dieses Parameters wird zusammen mit dem Wert des parameters Class verwendet, um einen vollqualifizierten Namen für die Klasse zu generieren. Der Standardwert ist Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes plus einen Typ, der aus dem URI generiert wird.

Sie können den Wert des Namespace--Parameters festlegen, sodass Sie auf mehrere Webdienste zugreifen können, die denselben Namen haben.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:NS

Parametersätze

(All)
Position:2
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Uri

Gibt den URI des Webdiensts an. Geben Sie einen URI oder den Pfad und Dateinamen einer Datei ein, die eine Dienstbeschreibung enthält.

Der URI muss auf eine ASMX-Seite oder auf eine Seite verweisen, die eine Dienstbeschreibung zurückgibt. Um eine Dienstbeschreibung eines Webdiensts zurückzugeben, der mit ASP.NET erstellt wurde, fügen Sie "? WSDL" an die URL des Web-Service (z. B https://www.contoso.com/MyWebService.asmx?WSDL. ).

Parametereigenschaften

Typ:Uri
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:WL, WSDL, Pfad

Parametersätze

(All)
Position:0
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-UseDefaultCredential

Gibt an, dass dieses Cmdlet die Standardanmeldeinformationen verwendet. Mit diesem Cmdlet wird die eigenschaft UseDefaultCredential im resultierenden Proxyobjekt auf True festgelegt. Dies ist eine Alternative zur Verwendung des parameters Credential.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:UDC

Parametersätze

UseDefaultCredential
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

None

Eingaben können nicht an dieses Cmdlet weitergereicht werden.

Ausgaben

A Web service proxy object

Dieses Cmdlet gibt ein Webdienstproxyobjekt zurück. Der Namespace und die Klasse des Objekts werden durch die Parameter des Befehls bestimmt. Der Standardwert wird aus dem Eingabe-URI generiert.

Hinweise

  • New-WebServiceProxy verwendet die System.Net.WebClient-Klasse , um den angegebenen Webdienst zu laden.