Sdílet prostřednictvím

New-WebServiceProxy

  • Reference
Modul:
Microsoft.PowerShell.Management

Vytvoří objekt proxy webové služby, který umožňuje používat a spravovat webovou službu v prostředí 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

Rutina New-WebServiceProxy umožňuje používat webovou službu ve Windows PowerShellu. Rutina se připojí k webové službě a vytvoří objekt proxy webové služby ve Windows PowerShellu. Ke správě webové služby můžete použít objekt proxy.

Webová služba je program založený na jazyce XML, který vyměňuje data přes síť, zejména přes internet. Rozhraní Microsoft .NET Framework poskytuje objekty proxy webových služeb, které představují webovou službu jako objekt rozhraní .NET Framework.

Příklady

Příklad 1: Vytvoření proxy serveru pro webovou službu

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

Tento příkaz vytvoří proxy rozhraní .NET Framework webové služby ZIP v prostředí Windows PowerShell.

Příklad 2: Vytvoření proxy serveru pro webovou službu a určení oboru názvů a třídy

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

Tento příkaz používá rutinu New-WebServiceProxy k vytvoření proxy rozhraní .NET Framework webové služby ZIP v USA.

První příkaz uloží identifikátor URI webové služby do proměnné $URI.

Druhý příkaz vytvoří proxy webové služby. Příkaz pomocí parametru URI určuje identifikátor URI a obor názvů a třídy k určení oboru názvů a třídy objektu.

Příklad 3: Zobrazení metod proxy webové služby

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

Tento příkaz používá rutinu Get-Member k zobrazení metod objektu proxy webové služby v proměnné $zip. Tyto metody použijeme v následujícím příkladu.

Všimněte si, že TypeName objektu proxy, WebServiceProxy, odráží obor názvů a názvy tříd, které byly zadány v předchozím příkladu.

Příklad 4: Použití proxy webové služby

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

Tento příkaz používá proxy webové služby uložené v proměnné $zip. Příkaz používá GetInfoByZip metodu proxy a jeho Table vlastnost.

Parametry

-Class

Určuje název třídy proxy, kterou rutina vytvoří pro webovou službu. Hodnota tohoto parametru se používá společně s parametrem Namespace k zadání plně kvalifikovaného názvu třídy. Výchozí hodnota se vygeneruje z identifikátoru URI (Uniform Resource Identifier).

Typ:String
Aliasy:FileName, FN
Position:1
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Credential

Určuje uživatelský účet, který má oprávnění k provedení této akce. Výchozí hodnota je aktuální uživatel. Toto je alternativa k použití parametru UseDefaultCredential.

Zadejte uživatelské jméno, například User01 nebo Domain01\User01, nebo zadejte PSCredential objekt, například objekt vygenerovaný rutinou Get-Credential. Pokud zadáte uživatelské jméno, tato rutina vás vyzve k zadání hesla.

Typ:PSCredential
Aliasy:Cred
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Namespace

Určuje obor názvů pro novou třídu.

Hodnota tohoto parametru se používá společně s hodnotou parametru Class k vygenerování plně kvalifikovaného názvu třídy. Výchozí hodnota je Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes plus typ vygenerovaný z identifikátoru URI.

Hodnotu parametru Obor názvů můžete nastavit tak, abyste měli přístup k více webovým službám se stejným názvem.

Typ:String
Aliasy:NS
Position:2
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Uri

Určuje identifikátor URI webové služby. Zadejte identifikátor URI nebo cestu a název souboru, který obsahuje popis služby.

Identifikátor URI musí odkazovat na stránku .asmx nebo na stránku, která vrací popis služby. Chcete-li vrátit popis služby webové služby vytvořené pomocí ASP.NET, připojte "? WSDL na adresu URL webové služby (například https://www.contoso.com/MyWebService.asmx?WSDL).

Typ:Uri
Aliasy:WL, WSDL, Path
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-UseDefaultCredential

Označuje, že tato rutina používá výchozí přihlašovací údaje. Tato rutina nastaví vlastnost UseDefaultCredential ve výsledném objektu proxy na hodnotu True. Toto je alternativa k použití parametru credential.

Typ:SwitchParameter
Aliasy:UDC
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Vstup do této rutiny nelze převést.

Výstupy

A Web service proxy object

Tato rutina vrátí objekt proxy webové služby. Obor názvů a třída objektu jsou určeny parametry příkazu. Výchozí hodnota se vygeneruje ze vstupního identifikátoru URI.

Poznámky

  • New-WebServiceProxy používá třídu System.Net.WebClient k načtení zadané webové služby.