Compartilhar via

Export-ODataEndpointProxy

Módulo:
Microsoft.PowerShell.ODataUtils Module

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

Sintaxe

Default (Default) 

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 cmdlet Export-ODataEndpointProxy 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 CRUD (criar, ler, atualizar e excluir), 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 substantivo ou verbo dos cmdlets para se alinhar com as diretrizes de nomenclatura do cmdlet 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 gerenciado pelo módulo.

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 um 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 de Mercadorias é 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.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:10
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-AllowUnsecureConnection

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:11
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-CmdletAdapter

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:6
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Confirm

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CreateRequestMethod

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Put, Post, Patch
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:4
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:PSCredential
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:3
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-CustomData

Especifica uma tabela de hash de dados personalizados.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:9
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Force

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:8
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Headers

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

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:12
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-MetadataUri

Especifica o URI dos metadados do ponto de extremidade.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:2
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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 módulo na pasta $HOME\Documents\WindowsPowerShell\Modules. Se você especificar um caminho, o cmdlet criará a pasta do módulo nesse caminho.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ResourceNameMapping

Especifica um hashtable que contém mapeamentos que permitem personalizar os cmdlets gerados. Neste hashtable, o nome da coleção de recursos é a chave. O substantivo de cmdlet desejado é o valor.

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

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:7
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Put, Post, Patch
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:5
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Uri

Especifica o URI do ponto de extremidade.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.