Export-ODataEndpointProxy

  • Referensi
Modul:
Microsoft.PowerShell.ODataUtils

Menghasilkan modul yang berisi cmdlet untuk mengelola titik akhir OData.

Sintaks

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

Deskripsi

Export-ODataEndpointProxy Cmdlet menggunakan metadata titik akhir OData untuk menghasilkan modul yang berisi cmdlet yang dapat Anda gunakan untuk mengelola titik akhir OData tersebut. Modul didasarkan pada CDXML. Setelah cmdlet ini menghasilkan modul, cmdlet menyimpan modul tersebut ke jalur dan nama file yang ditentukan oleh parameter OutputModule .

Export-ODataEndpointProxy menghasilkan cmdlet untuk operasi buat, baca, perbarui, dan hapus (CRUD), tindakan non-CRUD, dan manipulasi asosiasi.

Export-ODataEndpointProxy menghasilkan satu file CDXML per sumber daya titik akhir. Anda dapat mengedit file CDXML ini setelah modul dibuat. Misalnya, jika Anda ingin mengubah nama kata benda atau kata kerja cmdlet agar selaras dengan panduan penamaan cmdlet Windows PowerShell, Anda dapat memodifikasi file.

Setiap cmdlet dalam modul yang dihasilkan harus menyertakan parameter Koneksi ionURI untuk terhubung ke titik akhir yang dikelola modul.

Contoh

Contoh 1: Membuat modul untuk mengelola titik akhir layanan web ritel

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'}

Perintah ini menghasilkan modul untuk mengelola titik akhir layanan ritel. Perintah menentukan URI titik akhir dan URI metadata titik akhir. Perintah ini juga menyediakan jalur output dan nama modul skrip sebagai nilai parameter OutputModule . Untuk nilai parameter ResourceNameMapping , perintah menyediakan hashtable yang memetakan nama koleksi sumber daya ke kata benda yang diinginkan untuk set cmdlet. Dalam contoh ini, Produk adalah nama koleksi sumber daya dan Merchandise adalah kata benda. Untuk mengizinkan koneksi ke situs non-SSL, HTTP, dibandingkan dengan HTTPS, tambahkan parameter AllowUnsecure Koneksi ion.

Parameter

-AllowClobber

Menunjukkan bahwa cmdlet ini menggantikan modul yang ada.

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

-AllowUnsecureConnection

Menunjukkan bahwa modul ini dapat terhubung ke URI yang tidak diamankan SSL. Modul ini dapat mengelola situs HTTP selain situs HTTPS.

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

-CmdletAdapter

Menentukan adaptor cmdlet. Nilai yang dapat diterima untuk parameter ini adalah: ODataAdapter dan NetworkControllerAdapter.

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

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

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

-CreateRequestMethod

Menentukan metode permintaan. Nilai yang dapat diterima untuk parameter ini adalah: PUT, POST, dan PATCH.

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

-Credential

Menentukan akun pengguna yang memiliki akses ke titik akhir OData. Nilai defaultnya adalah pengguna saat ini. Jika komputer jarak jauh menjalankan Windows Vista atau rilis sistem operasi Windows yang lebih baru, cmdlet akan meminta kredensial kepada Anda.

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

-CustomData

Menentukan tabel hash data kustom.

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

-Force

Menunjukkan bahwa cmdlet ini menimpa modul yang dihasilkan yang ada dengan nama yang sama di folder yang ada Modules .

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

-Headers

Menentukan header permintaan web. Masukkan tabel hash atau kamus.

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

-MetadataUri

Menentukan URI metadata titik akhir.

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

-OutputModule

Menentukan jalur dan nama modul tempat cmdlet ini menyimpan modul perintah proksi yang dihasilkan.

Cmdlet ini menyalin modul biner, manifes modul, dan file pemformatan, jika berlaku, ke folder yang ditentukan. Jika Anda hanya menentukan nama modul, Export-ODataEndpointProxy simpan modul di $HOME\Documents\WindowsPowerShell\Modules folder . Jika Anda menentukan jalur, cmdlet akan membuat folder modul di jalur tersebut.

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

-ResourceNameMapping

Menentukan hashtable yang berisi pemetaan yang memungkinkan Anda menyesuaikan cmdlet yang dihasilkan. Dalam hashtable ini, nama kumpulan sumber daya adalah kuncinya. Kata benda cmdlet yang diinginkan adalah nilainya.

Misalnya, dalam tabel @{Products = 'Merchandise'}hash , Produk adalah nama koleksi sumber daya yang berfungsi sebagai kunci. Barang dagangan adalah kata benda cmdlet yang dihasilkan. Nama cmdlet yang dihasilkan mungkin tidak selaras dengan panduan penamaan cmdlet Windows PowerShell. Anda dapat mengubah file CDXML sumber daya untuk mengubah nama cmdlet setelah cmdlet ini membuat modul. Untuk informasi selengkapnya, lihat Panduan Pengembangan yang Sangat Didorong.

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

-UpdateRequestMethod

Menentukan metode permintaan pembaruan. Nilai yang dapat diterima untuk parameter ini adalah: PUT, POST, dan PATCH.

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

-Uri

Menentukan URI titik akhir.

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

-WhatIf

Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.

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