Bagikan melalui

az apim product

  • Referensi

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

Edit

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

--product-name

Nama produk.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan api management.

Parameter Opsional

--approval-required

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.

Nilai yang diterima: false, true
--description

Deskripsi produk. Mungkin menyertakan tag pemformatan HTML.

--legal-terms

Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Nilai default: False
--product-id

Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.

--state

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

Nilai yang diterima: notPublished, published
--subscription-required -s

Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini.

Nilai yang diterima: false, true
--subscriptions-limit

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

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim product delete

Edit

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

--product-id

Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan api management.

Parameter Opsional

--delete-subscriptions

Hapus langganan yang sudah ada yang terkait dengan produk atau tidak.

--if-match

ETag Entitas.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Nilai default: False
--yes -y

Jangan meminta konfirmasi.

Nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim product list

Edit

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

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan api management.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim product show

Edit

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

--product-id

Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan api management.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim product update

Edit

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

--product-id

Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan api management.

Parameter Opsional

--add

Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>.

Nilai default: []
--approval-required

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.

Nilai yang diterima: false, true
--description

Deskripsi produk. Mungkin menyertakan tag pemformatan HTML.

--force-string

Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.

Nilai default: False
--if-match

ETag Entitas.

--legal-terms

Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Nilai default: False
--product-name

Nama produk.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove> ATAU --remove propertyToRemove.

Nilai default: []
--set

Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>.

Nilai default: []
--state

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

Nilai yang diterima: notPublished, published
--subscription-required -s

Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini.

Nilai yang diterima: false, true
--subscriptions-limit

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

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim product wait

Edit

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

--product-id

Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan api management.

Parameter Opsional

--created

Tunggu hingga dibuat dengan 'provisioningState' di 'Berhasil'.

Nilai default: False
--custom

Tunggu hingga kondisi memenuhi kueri JMESPath kustom. Misalnya provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Tunggu hingga dihapus.

Nilai default: False
--exists

Tunggu hingga sumber daya ada.

Nilai default: False
--interval

Interval polling dalam hitungan detik.

Nilai default: 30
--timeout

Tunggu maksimum dalam detik.

Nilai default: 3600
--updated

Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.

Nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.