Export-ODataEndpointProxy
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 ConnectionURI untuk menyambungkan 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 AllowUnsecureConnection .
Parameter
-AllowClobber
Menunjukkan bahwa cmdlet ini menggantikan modul yang ada.
Jenis: | SwitchParameter |
Position: | 10 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-AllowUnsecureConnection
Menunjukkan bahwa modul ini dapat terhubung ke URI yang tidak diamankan SSL. Modul ini dapat mengelola situs HTTP selain situs HTTPS.
Jenis: | SwitchParameter |
Position: | 11 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-CmdletAdapter
Menentukan adaptor cmdlet. Nilai yang dapat diterima untuk parameter ini adalah: ODataAdapter dan NetworkControllerAdapter.
Jenis: | String |
Nilai yang diterima: | ODataAdapter, NetworkControllerAdapter, ODataV4Adapter |
Position: | 6 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-Confirm
Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.
Jenis: | SwitchParameter |
Alias: | cf |
Position: | Named |
Nilai default: | False |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-CreateRequestMethod
Menentukan metode permintaan. Nilai yang dapat diterima untuk parameter ini adalah: PUT, POST, dan PATCH.
Jenis: | String |
Nilai yang diterima: | Put, Post, Patch |
Position: | 4 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | 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.
Jenis: | PSCredential |
Position: | 3 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-CustomData
Menentukan tabel hash data kustom.
Jenis: | Hashtable |
Position: | 9 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-Force
Menunjukkan bahwa cmdlet ini menimpa modul yang dihasilkan yang ada dengan nama yang sama di folder yang ada Modules
.
Jenis: | SwitchParameter |
Position: | 8 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-Headers
Menentukan header permintaan web. Masukkan tabel hash atau kamus.
Jenis: | Hashtable |
Position: | 12 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-MetadataUri
Menentukan URI metadata titik akhir.
Jenis: | String |
Position: | 2 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | 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.
Jenis: | String |
Position: | 1 |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | True |
Terima karakter wildcard: | 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.
Jenis: | Hashtable |
Position: | 7 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-UpdateRequestMethod
Menentukan metode permintaan pembaruan. Nilai yang dapat diterima untuk parameter ini adalah: PUT, POST, dan PATCH.
Jenis: | String |
Nilai yang diterima: | Put, Post, Patch |
Position: | 5 |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | True |
Terima karakter wildcard: | False |
-Uri
Menentukan URI titik akhir.
Jenis: | String |
Position: | 0 |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | True |
Terima karakter wildcard: | False |
-WhatIf
Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.
Jenis: | SwitchParameter |
Alias: | wi |
Position: | Named |
Nilai default: | False |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |