Compartilhar via

Export-ODataEndpointProxy

  • Referência
Módulo:
Microsoft.PowerShell.ODataUtils

Gera um módulo que contém cmdlets para gerenciar um ponto de extremidade OData.

Syntax

Export-ODataEndpointProxy
      [-Uri] <String>
      [-OutputModule] <String>
      [[-MetadataUri] <String>]
      [[-Credential] <PSCredential>]
      [[-CreateRequestMethod] <String>]
      [[-UpdateRequestMethod] <String>]
      [[-CmdletAdapter] <String>]
      [[-ResourceNameMapping] <Hashtable>]
      [-Force]
      [[-CustomData] <Hashtable>]
      [-AllowClobber]
      [-AllowUnsecureConnection]
      [[-Headers] <Hashtable>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O Export-ODataEndpointProxy cmdlet usa os metadados de um ponto de extremidade OData para gerar um módulo que contém cmdlets que você pode usar para gerenciar esse ponto de extremidade OData. O módulo é baseado em CDXML. Depois que esse cmdlet gera o módulo, ele salva esse módulo no caminho e no nome do arquivo especificados pelo parâmetro OutputModule .

Export-ODataEndpointProxy gera cmdlets para operações de criação, leitura, atualização e exclusão (CRUD), ações não CRUD e manipulação de associação.

Export-ODataEndpointProxy gera um arquivo CDXML por recurso de ponto de extremidade. Você pode editar esses arquivos CDXML depois que o módulo é gerado. Por exemplo, se você quiser alterar os nomes de substantivos ou verbos dos cmdlets para se alinhar às diretrizes de nomenclatura de cmdlets do Windows PowerShell, poderá modificar o arquivo.

Cada cmdlet em um módulo gerado deve incluir um parâmetro ConnectionURI para se conectar ao ponto de extremidade que o módulo gerencia.

Exemplos

Exemplo 1: Gerar um módulo para gerenciar um ponto de extremidade de serviço Web de varejo

PS C:\> Export-ODataEndpointProxy -Uri 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc' -MetadataUri 'http://services.odata.org/v3/(S(snyobsk1hhutkb2yulwldgf1))/odata/odata.svc/$metadata' -AllowUnsecureConnection -OutputModule 'C:\Users\user\GeneratedScript.psm1' -ResourceNameMapping @{Products = 'Merchandise'}

Esse comando gera um módulo para gerenciar um ponto de extremidade de serviço de varejo. O comando especifica o URI do ponto de extremidade e o URI dos metadados do ponto de extremidade. O comando também fornece um caminho de saída e um nome de módulo de script como o valor do parâmetro OutputModule . Para o valor do parâmetro ResourceNameMapping, o comando fornece uma hashtable que mapeia o nome da coleção de recursos para o substantivo desejado para o conjunto de cmdlets. Neste exemplo, Products é o nome da coleção de recursos e Merchandise é o substantivo. Para permitir conexões com sites não-SSL, HTTP, em vez de HTTPS, adicione o parâmetro AllowUnsecureConnection .

Parâmetros

-AllowClobber

Indica que esse cmdlet substitui um módulo existente.

Type:SwitchParameter
Position:10
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AllowUnsecureConnection

Indica que este módulo pode se conectar a URIs que não são protegidos por SSL. O módulo pode gerenciar sites HTTP além de sites HTTPS.

Type:SwitchParameter
Position:11
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-CmdletAdapter

Especifica o adaptador de cmdlet. Os valores aceitáveis para esse parâmetro são: ODataAdapter e NetworkControllerAdapter.

Type:String
Accepted values:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CreateRequestMethod

Especifica o método de solicitação. Os valores aceitáveis para esse parâmetro são: PUT, POST e PATCH.

Type:String
Accepted values:Put, Post, Patch
Position:4
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Credential

Especifica uma conta de usuário que tem acesso ao ponto de extremidade OData. O valor padrão é o usuário atual. Se um computador remoto executar o Windows Vista ou uma versão posterior do sistema operacional Windows, o cmdlet solicitará credenciais.

Type:PSCredential
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-CustomData

Especifica uma tabela de hash de dados personalizados.

Type:Hashtable
Position:9
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Indica que esse cmdlet substitui um módulo gerado existente com o mesmo nome em uma pasta existente Modules .

Type:SwitchParameter
Position:8
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Headers

Especifica os cabeçalhos da solicitação da Web. Insira uma tabela de hash ou dicionário.

Type:Hashtable
Position:12
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MetadataUri

Especifica o URI dos metadados do ponto de extremidade.

Type:String
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OutputModule

Especifica o caminho e o nome do módulo no qual esse cmdlet salva o módulo gerado de comandos proxy.

Esse cmdlet copia um módulo binário, um manifesto de módulo e um arquivo de formatação, se aplicável, para a pasta especificada. Se você especificar apenas o nome do módulo, Export-ODataEndpointProxy salvará o $HOME\Documents\WindowsPowerShell\Modules módulo na pasta. Se você especificar um caminho, o cmdlet criará a pasta do módulo nesse caminho.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceNameMapping

Especifica uma tabela de hash que contém mapeamentos que permitem personalizar os cmdlets gerados. Nesta tabela de hash, o nome da coleção de recursos é a chave. O substantivo do cmdlet desejado é o valor.

Por exemplo, na tabela @{Products = 'Merchandise'}de hash , Products é o nome da coleção de recursos que serve como chave. Merchandise é o substantivo do cmdlet resultante. Os nomes de cmdlet gerados podem não estar alinhados às diretrizes de nomenclatura de cmdlet do Windows PowerShell. Você pode modificar o arquivo CDXML do recurso para alterar os nomes dos cmdlets depois que esse cmdlet criar o módulo. Para obter mais informações, consulte Diretrizes de desenvolvimento fortemente incentivadas.

Type:Hashtable
Position:7
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UpdateRequestMethod

Especifica o método de solicitação de atualização. Os valores aceitáveis para esse parâmetro são: PUT, POST e PATCH.

Type:String
Accepted values:Put, Post, Patch
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Uri

Especifica o URI do ponto de extremidade.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False