Export-ODataEndpointProxy

Modul:

Microsoft.PowerShell.ODataUtils Module

Menghasilkan modul yang berisi cmdlet untuk mengelola titik akhir OData.

Sintaks

Default (Default)

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

cmdlet Export-ODataEndpointProxy 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 kumpulan 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.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	10
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-AllowUnsecureConnection

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

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	11
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-CmdletAdapter

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

Properti parameter

Jenis:	String
Nilai default:	None
Nilai yang diterima:	ODataAdapter, NetworkControllerAdapter, ODataV4Adapter
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	6
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False
Alias:	Cf

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

-CreateRequestMethod

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

Properti parameter

Jenis:	String
Nilai default:	None
Nilai yang diterima:	Put, Post, Patch
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	4
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	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.

Properti parameter

Jenis:	PSCredential
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	3
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-CustomData

Menentukan tabel hash data kustom.

Properti parameter

Jenis:	Hashtable
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	9
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Force

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

Properti parameter

Jenis:	SwitchParameter
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	8
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Headers

Menentukan header permintaan web. Inputkan tabel hash atau kamus.

Properti parameter

Jenis:	Hashtable
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	12
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-MetadataUri

Menentukan URI metadata titik akhir.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	2
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	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 menyimpan modul di folder $HOME\Documents\WindowsPowerShell\Modules. Jika Anda menentukan jalur, cmdlet akan membuat folder modul di jalur tersebut.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	1
Wajib:	True
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	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 hash @{Products = 'Merchandise'}, Products adalah nama kumpulan sumber daya yang berfungsi sebagai kunci. Merchandise 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.

Properti parameter

Jenis:	Hashtable
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	7
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-UpdateRequestMethod

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

Properti parameter

Jenis:	String
Nilai default:	None
Nilai yang diterima:	Put, Post, Patch
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	5
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-Uri

Menentukan URI titik akhir.

Properti parameter

Jenis:	String
Nilai default:	None
Mendukung wildcard:	False
DontShow:	False

Kumpulan parameter

(All)

Position:	0
Wajib:	True
Nilai dari alur:	True
Nilai dari alur berdasarkan nama properti:	True
Nilai dari argumen yang tersisa:	False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:	SwitchParameter
Nilai default:	False
Mendukung wildcard:	False
DontShow:	False
Alias:	wi

Kumpulan parameter

(All)

Position:	Named
Wajib:	False
Nilai dari alur:	False
Nilai dari alur berdasarkan nama properti:	False
Nilai dari argumen yang tersisa:	False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Link Terkait

• Pustaka OData
• Apa itu Protokol OData?
• Invoke-RestMethod