Export-ODataEndpointProxy
Gera um módulo que contém cmdlets para gerenciar um ponto de extremidade OData.
Sintaxe
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 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 for 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 tabela de hash 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.
Tipo: | SwitchParameter |
Cargo: | 10 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-AllowUnsecureConnection
Indica que esse 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.
Tipo: | SwitchParameter |
Cargo: | 11 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-CmdletAdapter
Especifica o adaptador de cmdlet. Os valores aceitáveis para esse parâmetro são: ODataAdapter e NetworkControllerAdapter.
Tipo: | String |
Valores aceitos: | ODataAdapter, NetworkControllerAdapter, ODataV4Adapter |
Cargo: | 6 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-CreateRequestMethod
Especifica o método de solicitação. Os valores aceitáveis para esse parâmetro são: PUT, POST e PATCH.
Tipo: | String |
Valores aceitos: | Put, Post, Patch |
Cargo: | 4 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | 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á as credenciais.
Tipo: | PSCredential |
Cargo: | 3 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-CustomData
Especifica uma tabela de hash de dados personalizados.
Tipo: | Hashtable |
Cargo: | 9 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Force
Indica que esse cmdlet substitui um módulo gerado existente com o mesmo nome em uma pasta existente Modules
.
Tipo: | SwitchParameter |
Cargo: | 8 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Headers
Especifica os cabeçalhos da solicitação da Web. Insira uma tabela de hash ou dicionário.
Tipo: | Hashtable |
Cargo: | 12 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-MetadataUri
Especifica o URI dos metadados do ponto de extremidade.
Tipo: | String |
Cargo: | 2 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | 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, o salvará Export-ODataEndpointProxy
o $HOME\Documents\WindowsPowerShell\Modules
módulo na pasta. Se você especificar um caminho, o cmdlet criará a pasta do módulo nesse caminho.
Tipo: | String |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | 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 de cmdlet desejado é o valor.
Por exemplo, na tabela @{Products = 'Merchandise'}
de hash , Products é o nome da coleção de recursos que serve como chave. Mercadoria é o substantivo do cmdlet resultante. Os nomes de cmdlet gerados podem não estar alinhados às diretrizes de nomenclatura de cmdlets do Windows PowerShell. Você pode modificar o arquivo CDXML de 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.
Tipo: | Hashtable |
Cargo: | 7 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | 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.
Tipo: | String |
Valores aceitos: | Put, Post, Patch |
Cargo: | 5 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Uri
Especifica o URI do ponto de extremidade.
Tipo: | String |
Cargo: | 0 |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |