Partilhar 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 (Predefinição) 

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:10
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:11
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-CmdletAdapter

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Valores aceites:ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:6
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-CreateRequestMethod

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Valores aceites:Put, Post, Patch
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:4
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos: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 dos parâmetros

Tipo:PSCredential
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:3
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-CustomData

Especifica uma tabela de hash de dados personalizados.

Propriedades dos parâmetros

Tipo:Hashtable
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:9
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Force

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:8
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Headers

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

Propriedades dos parâmetros

Tipo:Hashtable
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:12
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-MetadataUri

Especifica o URI dos metadados do ponto de extremidade.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-ResourceNameMapping

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

Por exemplo, na tabela de hash @{Products = 'Merchandise'}, Produtos é 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 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.

Propriedades dos parâmetros

Tipo:Hashtable
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Valores aceites:Put, Post, Patch
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:5
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Uri

Especifica o URI do ponto de extremidade.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.