Compartilhar via


New-WebServiceProxy

Cria um objeto de proxy de serviço Web que permite usar e gerenciar o serviço Web no Windows PowerShell.

Sintaxe

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

Descrição

O cmdlet New-WebServiceProxy permite usar um serviço Web no Windows PowerShell. O cmdlet se conecta com um serviço Web e cria um objeto de proxy de serviço Web no Windows PowerShell. Você pode usar o objeto de proxy para gerenciar o serviço Web.

Um serviço Web é um programa baseado em XML que troca dados em uma rede, principalmente na Internet. O Microsoft .NET Framework fornece objetos de proxy de serviço Web que representam o serviço Web como um objeto do .NET Framework.

Parâmetros

-Class <string>

Especifica um nome para a classe de proxy que o cmdlet cria para o serviço Web. O valor deste parâmetro é usado com o valor do parâmetro Namespace para fornecer um nome totalmente qualificado para a classe. O valor padrão é gerado a partir do URI.

Necessário?

false

Posição?

2

Valor padrão

Gerado a partir do URI

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Credential <PSCredential>

Especifica uma conta de usuário com permissão para executar essa ação. O padrão é o usuário atual. Isso é uma alternativa a usar o parâmetro UseDefaultCredential.

Digite um nome de usuário, como “User01” ou “Domain01\User01”. Ou insira um objeto PSCredential, como aquele gerado pelo cmdlet Get-Credential. Uma senha será solicitada após a digitação do nome do usuário.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Namespace <string>

Especifica um namespace para a nova classe.

O valor deste parâmetro é usado com o valor do parâmetro Class para gerar um nome totalmente qualificado para a classe. O valor padrão é Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes além de um tipo que é gerado a partir do URI.

Você pode definir o valor do parâmetro Namespace para que possa acessar vários serviços Web com o mesmo nome.

Necessário?

false

Posição?

3

Valor padrão

Microsoft.PowerShell.Commands.NewWebserviceProxy.AutogeneratedTypes

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-URI <Uri>

Especifica o URI do serviço Web. Insira um URI ou o caminho e o nome de um arquivo que contenha uma descrição de serviço.

O URI deve fazer referência uma página .asmx ou a uma página que retorne uma descrição de serviço. Para retornar uma descrição de serviço para um serviço Web criado usando ASP.NET, acrescente "?WSDL" à URL do serviço Web (por exemplo, https://www.contoso.com/MyWebService.asmx?WSDL).

Necessário?

true

Posição?

1

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-UseDefaultCredential

Define o parâmetro UseDefaultCredential no objeto de proxy resultante como True. Isso é uma alternativa a usar o parâmetro Credential.

Necessário?

false

Posição?

named

Valor padrão

False

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas

Nenhum

Este cmdlet não aceita entrada do pipeline.

Saídas

Um objeto de proxy de serviço Web

O namespace e a classe do objeto são determinados pelos parâmetros do comando. O valor padrão é gerado a partir do URI (Uniform Resource Identifier) de entrada.

Observações

New-WebServiceProxy usa a classe System.Net.WebClient para carregar o serviço Web especificado.

Exemplo 1

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

Descrição
-----------
Esse comando usa o comando New-WebServiceProxy para criar um proxy .NET Framework do serviço Web US Zip no Windows PowerShell.





Exemplo 2

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

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

Descrição
-----------
Esse comando usa o cmdlet New-WebServiceProxy para criar um proxy .NET Framework do serviço Web US Zip.

O primeiro comando armazena o URI do serviço Web na variável $URI.

O segundo comando cria o proxy do serviço Web. O comando usa o parâmetro URI para especificar o URI e os parâmetros Namespace e Class para especificar o namespace e a classe do objeto.





Exemplo 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

Descrição
-----------
Esse comando usa o cmdlet Get-Member para exibir os métodos do objeto de proxy do serviço Web na variável $zip. Usaremos esses métodos no exemplo a seguir.

Observe que o TypeName do objeto de proxy, WebServiceProxy, reflete o namespace e os nomes de classe especificados no exemplo anterior.





Exemplo 4

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

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

Descrição
-----------
Esse comando usa o proxy do serviço Web armazenado na variável Zip. O comando usa o método GetInfoByZip do proxy e sua propriedade Table.





Consulte também

Conceitos

New-Service