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 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 alinhá-los com as 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'}Este 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 hash que mapeia o nome da coleção de recursos para o nome pretendido para o conjunto de cmdlet. 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 |
| Position: | 10 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | 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.
| Tipo: | SwitchParameter |
| Position: | 11 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-CmdletAdapter
Especifica o adaptador de cmdlet. Os valores aceitáveis para este parâmetro são: ODataAdapter e NetworkControllerAdapter.
| Tipo: | String |
| Valores aceites: | ODataAdapter, NetworkControllerAdapter, ODataV4Adapter |
| Position: | 6 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Confirm
Solicita a sua confirmação antes de executar o cmdlet.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
-CreateRequestMethod
Especifica o método de solicitação. Os valores aceitáveis para este parâmetro são: PUT, POST e PATCH.
| Tipo: | String |
| Valores aceites: | Put, Post, Patch |
| Position: | 4 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | 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.
| Tipo: | PSCredential |
| Position: | 3 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-CustomData
Especifica uma tabela hash de dados personalizados.
| Tipo: | Hashtable |
| Position: | 9 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Force
Indica que esse cmdlet substitui um módulo gerado existente com o mesmo nome em uma pasta existente Modules .
| Tipo: | SwitchParameter |
| Position: | 8 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Headers
Especifica os cabeçalhos da solicitação da Web. Introduza uma tabela hash ou um dicionário.
| Tipo: | Hashtable |
| Position: | 12 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-MetadataUri
Especifica o URI dos metadados do ponto de extremidade.
| Tipo: | String |
| Position: | 2 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-OutputModule
Especifica o caminho e o nome do módulo no qual esse cmdlet salva o módulo gerado de comandos proxy.
Este cmdlet copia um módulo binário, manifesto do módulo e 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.
| Tipo: | String |
| Position: | 1 |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-ResourceNameMapping
Especifica uma tabela hash que contém mapeamentos que permitem personalizar os cmdlets gerados. Nesta tabela hash, o nome da coleção de recursos é a chave. O substantivo do cmdlet desejado é o valor.
Por exemplo, na tabela hash @{Products = 'Merchandise'}, Produtos é o nome da coleção de recursos que serve de chave. Merchandise é 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 encorajadas.
| Tipo: | Hashtable |
| Position: | 7 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-UpdateRequestMethod
Especifica o método de solicitação de atualização. Os valores aceitáveis para este parâmetro são: PUT, POST e PATCH.
| Tipo: | String |
| Valores aceites: | Put, Post, Patch |
| Position: | 5 |
| Default value: | None |
| Necessário: | False |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-Uri
Especifica o URI do ponto de extremidade.
| Tipo: | String |
| Position: | 0 |
| Default value: | None |
| Necessário: | True |
| Aceitar entrada de pipeline: | True |
| Aceitar carateres universais: | False |
-WhatIf
Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Necessário: | False |
| Aceitar entrada de pipeline: | False |
| Aceitar carateres universais: | False |
