az apim product
Mengelola Produk Azure API Management.
Perintah
Nama | Deskripsi | Jenis | Status |
---|---|---|---|
az apim product api |
Mengelola API Produk Azure API Management. |
Inti | GA |
az apim product api add |
Tambahkan API ke produk yang ditentukan. |
Inti | GA |
az apim product api check |
Memeriksa apakah entitas API yang ditentukan oleh pengidentifikasi dikaitkan dengan entitas Produk. |
Inti | GA |
az apim product api delete |
Menghapus API yang ditentukan dari produk yang ditentukan. |
Inti | GA |
az apim product api list |
Mencantumkan kumpulan API yang terkait dengan produk. |
Inti | GA |
az apim product create |
Membuat produk. |
Inti | GA |
az apim product delete |
Menghapus produk. |
Inti | GA |
az apim product list |
Mencantumkan kumpulan produk dalam contoh layanan yang ditentukan. |
Inti | GA |
az apim product show |
Mendapatkan detail produk yang ditentukan oleh pengidentifikasinya. |
Inti | GA |
az apim product update |
Perbarui detail produk yang ada. |
Inti | GA |
az apim product wait |
Tempatkan CLI dalam status tunggu sampai kondisi produk apim terpenuhi. |
Inti | GA |
az apim product create
Membuat produk.
az apim product create --product-name
--resource-group
--service-name
[--approval-required {false, true}]
[--description]
[--legal-terms]
[--no-wait]
[--product-id]
[--state {notPublished, published}]
[--subscription-required {false, true}]
[--subscriptions-limit]
Contoh
Membuat produk.
az apim product create --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"
Parameter yang Diperlukan
Nama produk.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama instans layanan api management.
Parameter Opsional
Apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
Deskripsi produk. Mungkin menyertakan tag pemformatan HTML.
Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan.
Jangan menunggu operasi jangka panjang selesai.
Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.
Apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan. Nilai yang mungkin termasuk: 'notPublished', 'published'.
Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini.
Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az apim product delete
Menghapus produk.
az apim product delete --product-id
--resource-group
--service-name
[--delete-subscriptions]
[--if-match]
[--no-wait]
[--yes]
Contoh
Hapus produk dengan semua langganan produk ini.
az apim product delete --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID --delete-subscriptions true
Parameter yang Diperlukan
Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama instans layanan api management.
Parameter Opsional
Hapus langganan yang sudah ada yang terkait dengan produk atau tidak.
ETag Entitas.
Jangan menunggu operasi jangka panjang selesai.
Jangan meminta konfirmasi.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az apim product list
Mencantumkan kumpulan produk dalam contoh layanan yang ditentukan.
az apim product list --resource-group
--service-name
Contoh
Cantumkan semua produk untuk instans APIM ini.
az apim product list --resource-group MyResourceGroup --service-name MyServiceName
Parameter yang Diperlukan
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama instans layanan api management.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az apim product show
Mendapatkan detail produk yang ditentukan oleh pengidentifikasinya.
az apim product show --product-id
--resource-group
--service-name
Contoh
Mendapatkan detail produk yang ditentukan oleh pengidentifikasinya.
az apim product show --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID
Parameter yang Diperlukan
Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama instans layanan api management.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az apim product update
Perbarui detail produk yang ada.
az apim product update --product-id
--resource-group
--service-name
[--add]
[--approval-required {false, true}]
[--description]
[--force-string]
[--if-match]
[--legal-terms]
[--no-wait]
[--product-name]
[--remove]
[--set]
[--state {notPublished, published}]
[--subscription-required {false, true}]
[--subscriptions-limit]
Contoh
Perbarui detail produk yang ada.
az apim product update --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"
Parameter yang Diperlukan
Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama instans layanan api management.
Parameter Opsional
Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>
.
Apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
Deskripsi produk. Mungkin menyertakan tag pemformatan HTML.
Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.
ETag Entitas.
Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan.
Jangan menunggu operasi jangka panjang selesai.
Nama produk.
Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove>
ATAU --remove propertyToRemove
.
Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>
.
Apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan. Nilai yang mungkin termasuk: 'notPublished', 'published'.
Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini.
Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.
az apim product wait
Tempatkan CLI dalam status tunggu sampai kondisi produk apim terpenuhi.
az apim product wait --product-id
--resource-group
--service-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Contoh
Tempatkan CLI dalam status tunggu sampai kondisi apim terpenuhi. (dibuat otomatis)
az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID
Parameter yang Diperlukan
Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama instans layanan api management.
Parameter Opsional
Tunggu hingga dibuat dengan 'provisioningState' di 'Berhasil'.
Tunggu hingga kondisi memenuhi kueri JMESPath kustom. Misalnya provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Tunggu hingga dihapus.
Tunggu hingga sumber daya ada.
Interval polling dalam hitungan detik.
Tunggu maksimum dalam detik.
Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.
Parameter Global
Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.
Menampilkan pesan bantuan ini dan keluar.
Hanya menampilkan kesalahan, menyembunyikan peringatan.
Format output.
String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.