New-WebServiceProxy

Creates a Web service proxy object that lets you use and manage the Web service in Windows PowerShell.
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>]

The New-WebServiceProxy cmdlet lets you use a Web service in Windows PowerShell. The cmdlet connects to a Web service and creates a Web service proxy object in Windows PowerShell. You can use the proxy object to manage the Web service.

A Web service is an XML-based program that exchanges data over a network, especially over the Internet. The Microsoft .NET Framework provides Web service proxy objects that represent the Web service as a .NET Framework object.

Parameters
-Class [<String>]

Specifies a name for the proxy class that the cmdlet creates for the Web service. The value of this parameter is used together with the Namespace parameter to provide a fully qualified name for the class. The default value is generated from the Uniform Resource Identifier (URI).

-Credential [<PSCredential>]

Specifies a user account that has permission to perform this action. The default is the current user. This is an alternative to using the UseDefaultCredential parameter.

Type a user name, such as User01 or Domain01User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, this cmdlet prompts you for a password.

-Namespace [<String>]

Specifies a namespace for the new class.

The value of this parameter is used together with the value of the Class parameter to generate a fully qualified name for the class. The default value is Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes plus a type that is generated from the URI.

You can set the value of the Namespace parameter so that you can access multiple Web services that have the same name.

-Uri <Uri>

  • This value is required

Specifies the URI of the Web service. Enter a URI or the path and file name of a file that contains a service description.

The URI must refer to an .asmx page or to a page that returns a service description. To return a service description of a Web service that was created by using ASP.NET, append ?WSDL to the URL of the Web service, for example: http://www.contoso.com/MyWebService.asmx?WSDL.

-UseDefaultCredential [<SwitchParameter>]

Indicates that this cmdlet uses the default credential. This cmdlet sets the UseDefaultCredential property in the resulting proxy object to True. This is an alternative to using the Credential parameter.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

A Web service proxy object

This cmdlet returns a Web service proxy object. The namespace and class of the object are determined by the parameters of the command. The default is generated from the input URI.

Examples
  1. Create a proxy for a Web service:
    PS C:> $zip = New-WebServiceProxy -Uri "http://www.webservicex.net/uszip.asmx?WSDL"
    

    This command creates a .NET Framework proxy of the US Zip Web service in Windows PowerShell.

  2. Create a proxy for a Web service and specify namespace and class:
    PS C:> $URI = "http://www.webservicex.net/uszip.asmx?WSDL"
    PS C:>  $zip = New-WebServiceProxy -Uri $URI -Namespace "WebServiceProxy" -Class "USZip"
    

    This command uses the New-WebServiceProxy cmdlet to create a .NET Framework proxy of the US Zip Web service.

    The first command stores the URI of the Web service in the $URI variable.

    The second command creates the Web service proxy. The command uses the Uri parameter to specify the URI and the Namespace and Class parameters to specify the namespace and class of the object.

  3. Display methods of a Web service proxy:
    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

    This command uses the Get-Member cmdlet to display the methods of the Web service proxy object in the $zip variable. We will use these methods in the following example.

    Notice that the TypeName of the proxy object, WebServiceProxy, reflects the namespace and class names that were specified in the previous example.

  4. Use a Web service proxy:
    PS C:> $zip.GetInfoByZip(20500).table
    CITY      : Washington
    STATE     : DC
    ZIP       : 20500
    AREA_CODE : 202
    TIME_ZONE : E
    

    This command uses the Web service proxy stored in the $zip variable. The command uses the GetInfoByZip method of the proxy and its Table property.

Additional Notes
 New-WebServiceProxy uses the System.Net.WebClient class to load the specified Web service.
Related Links

New-Service