az apim
Mengelola layanan Azure API Management.
Perintah
Nama | Deskripsi | Jenis | Status |
---|---|---|---|
az apim api |
Mengelola API Management Azure API. |
Inti | GA |
az apim api create |
Buat API Management API. |
Inti | GA |
az apim api delete |
Menghapus API Management. |
Inti | GA |
az apim api export |
Mengekspor API Management API. |
Inti | GA |
az apim api import |
Mengimpor API Management. |
Inti | GA |
az apim api list |
Mencantumkan API Management API. |
Inti | GA |
az apim api operation |
Mengelola Operasi API Api Management Azure. |
Inti | GA |
az apim api operation create |
Membuat operasi baru di API. |
Inti | GA |
az apim api operation delete |
Menghapus operasi yang ditentukan di API. |
Inti | GA |
az apim api operation list |
Mencantumkan kumpulan operasi untuk API yang ditentukan. |
Inti | GA |
az apim api operation show |
Mendapatkan detail Operasi API yang ditentukan oleh pengidentifikasinya. |
Inti | GA |
az apim api operation update |
Memperbarui detail operasi dalam API yang ditentukan oleh pengidentifikasinya. |
Inti | GA |
az apim api release |
Mengelola Rilis API Api Management Azure. |
Inti | GA |
az apim api release create |
Membuat Rilis baru untuk API. |
Inti | GA |
az apim api release delete |
Menghapus rilis yang ditentukan di API. |
Inti | GA |
az apim api release list |
Mencantumkan semua rilis API. |
Inti | GA |
az apim api release show |
Mengembalikan detail rilis API. |
Inti | GA |
az apim api release update |
Memperbarui detail rilis API yang ditentukan oleh pengidentifikasinya. |
Inti | GA |
az apim api revision |
Mengelola Revisi API Api Management Azure. |
Inti | GA |
az apim api revision create |
Buat revisi API. |
Inti | GA |
az apim api revision list |
Mencantumkan semua revisi API. |
Inti | GA |
az apim api schema |
Mengelola Skema API Api Management Azure. |
Inti | GA |
az apim api schema create |
Buat Skema API Management API. |
Inti | GA |
az apim api schema delete |
Menghapus Skema API Management API. |
Inti | GA |
az apim api schema get-etag |
Dapatkan etag skema API Management API. |
Inti | GA |
az apim api schema list |
Mencantumkan skema API Management API. |
Inti | GA |
az apim api schema show |
Menampilkan detail Skema API Management API. |
Inti | GA |
az apim api schema wait |
Tempatkan CLI dalam status menunggu sampai kondisi skema apim api terpenuhi. |
Inti | GA |
az apim api show |
Menampilkan detail API Management. |
Inti | GA |
az apim api update |
Perbarui API Management API. |
Inti | GA |
az apim api versionset |
Mengelola Set Versi API Management Azure. |
Inti | GA |
az apim api versionset create |
Membuat Set Versi Api. |
Inti | GA |
az apim api versionset delete |
Menghapus Kumpulan Versi Api tertentu. |
Inti | GA |
az apim api versionset list |
Mencantumkan kumpulan Versi API dalam instans layanan yang ditentukan. |
Inti | GA |
az apim api versionset show |
Mendapatkan detail Set Versi Api yang ditentukan oleh pengidentifikasinya. |
Inti | GA |
az apim api versionset update |
Memperbarui detail Api VersionSet yang ditentukan oleh pengidentifikasinya. |
Inti | GA |
az apim api wait |
Tempatkan CLI dalam status tunggu hingga kondisi apim terpenuhi. |
Inti | GA |
az apim apply-network-updates |
Perbarui sumber daya API Management yang berjalan di jaringan virtual untuk memilih pengaturan jaringan yang diperbarui. |
Inti | GA |
az apim backup |
Membuat cadangan layanan API Management ke Akun Azure Storage yang diberikan. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan. |
Inti | GA |
az apim check-name |
Memeriksa untuk melihat apakah nama layanan tersedia untuk digunakan. |
Inti | GA |
az apim create |
Buat sebuah instans layanan API Management. |
Inti | GA |
az apim delete |
Menghapus layanan API Management. |
Inti | GA |
az apim deletedservice |
Mengelola layanan Azure API Management yang dihapus sementara. |
Inti | GA |
az apim deletedservice list |
Cantumkan semua instans layanan Api Management yang dihapus sementara yang tersedia untuk batal dihapus untuk langganan yang diberikan. |
Inti | GA |
az apim deletedservice purge |
Hapus menyeluruh instans layanan Api Management yang dihapus sementara (menghapusnya tanpa opsi untuk membatalkan penghapusan). |
Inti | GA |
az apim deletedservice show |
Dapatkan instans layanan Api Management yang dihapus sementara yang tersedia untuk membatalkan penghapusan berdasarkan nama. |
Inti | GA |
az apim graphql |
Mengelola API Azure API Management GraphQL API. |
Inti | GA |
az apim graphql resolver |
Mengelola Pemecah Masalah API Azure API Management GraphQL. |
Inti | GA |
az apim graphql resolver create |
Buat resolver baru di GraphQL API atau perbarui yang sudah ada. |
Inti | GA |
az apim graphql resolver delete |
Hapus resolver yang ditentukan di GraphQL API. |
Inti | GA |
az apim graphql resolver list |
Mencantumkan kumpulan resolver untuk API GraphQL yang ditentukan. |
Inti | GA |
az apim graphql resolver policy |
Mengelola Kebijakan Pemecah Masalah API Azure API Management GraphQL. |
Inti | GA |
az apim graphql resolver policy create |
Membuat atau memperbarui konfigurasi kebijakan untuk tingkat Pemecah Masalah GraphQL API. |
Inti | GA |
az apim graphql resolver policy delete |
Hapus konfigurasi kebijakan di GraphQL Api Resolver. |
Inti | GA |
az apim graphql resolver policy list |
Dapatkan daftar konfigurasi kebijakan di tingkat Pemecah Masalah GraphQL API. |
Inti | GA |
az apim graphql resolver policy show |
Dapatkan konfigurasi kebijakan di tingkat Pemecah Masalah GraphQL API. |
Inti | GA |
az apim graphql resolver show |
Dapatkan detail Resolver API GraphQL yang ditentukan oleh pengidentifikasinya. |
Inti | GA |
az apim list |
Mencantumkan instans layanan API Management. |
Inti | GA |
az apim nv |
Mengelola Nilai Bernama Azure API Management. |
Inti | GA |
az apim nv create |
Buat API Management Bernama Value. |
Inti | GA |
az apim nv delete |
Menghapus Nilai Bernama API Management. |
Inti | GA |
az apim nv list |
Mencantumkan Nilai Bernama API Management. |
Inti | GA |
az apim nv show |
Tampilkan detail API Management Bernama Value. |
Inti | GA |
az apim nv show-secret |
Mendapatkan rahasia API Management Named Value. |
Inti | GA |
az apim nv update |
Perbarui Nilai Bernama API Management. |
Inti | GA |
az apim nv wait |
Tempatkan CLI dalam status tunggu hingga kondisi apim bernama value terpenuhi. |
Inti | GA |
az apim product |
Mengelola Produk Azure API Management. |
Inti | GA |
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 restore |
Memulihkan cadangan layanan API Management yang dibuat menggunakan operasi ApiManagementService_Backup pada layanan saat ini. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan. |
Inti | GA |
az apim show |
Menampilkan detail instans layanan API Management. |
Inti | GA |
az apim update |
Perbarui instans layanan API Management. |
Inti | GA |
az apim wait |
Tempatkan CLI dalam status menunggu hingga kondisi apim terpenuhi. |
Inti | GA |
az apim apply-network-updates
Perbarui sumber daya API Management yang berjalan di jaringan virtual untuk memilih pengaturan jaringan yang diperbarui.
az apim apply-network-updates --name
--resource-group
[--location]
[--no-wait]
Contoh
Memperbarui pengaturan jaringan virtual instans layanan API Management
az apim apply-network-updates --name MyApim -g MyResourceGroup
Parameter yang Diperlukan
Nama instans layanan api management.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Parameter Opsional
Lokasi. Nilai dari: az account list-locations
. Anda dapat mengonfigurasi lokasi default menggunakan az configure --defaults location=<location>
.
Jangan menunggu operasi jangka panjang selesai.
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 backup
Membuat cadangan layanan API Management ke Akun Azure Storage yang diberikan. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan.
az apim backup --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Contoh
Membuat cadangan instans layanan API Management
az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Parameter yang Diperlukan
Nama file cadangan yang akan dibuat.
Nama kontainer akun penyimpanan yang digunakan untuk menempatkan cadangan.
Nama instans layanan api management.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Kunci akses akun penyimpanan yang digunakan untuk menempatkan cadangan.
Nama akun penyimpanan yang digunakan untuk menempatkan cadangan.
Parameter Opsional
Jangan menunggu operasi jangka panjang selesai.
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 check-name
Memeriksa untuk melihat apakah nama layanan tersedia untuk digunakan.
az apim check-name --name
Parameter yang Diperlukan
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 create
Buat sebuah instans layanan API Management.
az apim create --name
--publisher-email
--publisher-name
--resource-group
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--location]
[--no-wait]
[--public-network-access {false, true}]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Contoh
Buat layanan API Management tingkat Pengembang.
az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft
Buat layanan API Management tingkat Konsumsi.
az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
--publisher-email email@mydomain.com --publisher-name Microsoft
Parameter yang Diperlukan
Nama unik instans layanan yang akan dibuat.
Nama harus unik secara global karena akan disertakan sebagai nama host gateway seperti' https://my-api-servicename.azure-api.net'. Lihat contoh.
Alamat email untuk menerima semua pemberitahuan sistem.
Nama organisasi Anda untuk digunakan di portal pengembang dan pemberitahuan email.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Parameter Opsional
Nonaktifkan gateway di wilayah master. Hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi.
Memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway dan juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.
Buat identitas terkelola untuk layanan API Management untuk mengakses sumber daya Azure lainnya. Hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi.
Lokasi. Nilai dari: az account list-locations
. Anda dapat mengonfigurasi lokasi default menggunakan az configure --defaults location=<location>
.
Jangan menunggu operasi jangka panjang selesai.
Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Jika diatur ke true, titik akhir privat adalah metode akses eksklusif.
Jumlah unit SKU yang disebarkan.
Sku instans manajemen api.
Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.
Jenis jaringan virtual.
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 delete
Menghapus layanan API Management.
az apim delete --name
--resource-group
[--no-wait]
[--yes]
Contoh
Menghapus layanan API Management.
az apim delete -n MyApim -g MyResourceGroup
Parameter yang Diperlukan
Nama instans layanan api management.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Parameter Opsional
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 list
Mencantumkan instans layanan API Management.
az apim list [--resource-group]
Parameter Opsional
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
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 restore
Memulihkan cadangan layanan API Management yang dibuat menggunakan operasi ApiManagementService_Backup pada layanan saat ini. Ini adalah operasi jangka panjang dan bisa memakan waktu beberapa menit untuk diselesaikan.
az apim restore --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
Contoh
Memulihkan cadangan instans layanan API Management
az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
Parameter yang Diperlukan
Nama file cadangan yang akan dipulihkan.
Nama kontainer akun penyimpanan yang digunakan untuk mengambil cadangan.
Nama instans layanan api management.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Kunci akses akun penyimpanan yang digunakan untuk mengambil cadangan.
Nama akun penyimpanan yang digunakan untuk mengambil cadangan.
Parameter Opsional
Jangan menunggu operasi jangka panjang selesai.
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 show
Menampilkan detail instans layanan API Management.
az apim show --name
--resource-group
Parameter yang Diperlukan
Nama instans layanan api management.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
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 update
Perbarui instans layanan API Management.
az apim update --name
--resource-group
[--add]
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--force-string]
[--no-wait]
[--public-network-access {false, true}]
[--publisher-email]
[--publisher-name]
[--remove]
[--set]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
Parameter yang Diperlukan
Nama instans layanan api management.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Parameter Opsional
Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>
.
Nonaktifkan gateway di wilayah master. Hanya berlaku untuk layanan Api Management yang disebarkan di beberapa lokasi.
Memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway dan juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.
Buat identitas terkelola untuk layanan API Management untuk mengakses sumber daya Azure lainnya. Hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi.
Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.
Jangan menunggu operasi jangka panjang selesai.
Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Jika diatur ke true, titik akhir privat adalah metode akses eksklusif.
Alamat email untuk menerima semua pemberitahuan sistem.
Nama organisasi Anda untuk digunakan di portal pengembang dan pemberitahuan email.
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>
.
Jumlah unit SKU yang disebarkan.
Sku instans manajemen api.
Tag yang dipisahkan spasi: key[=value] [key[=value] ...]. Gunakan "" untuk menghapus tag yang ada.
Jenis jaringan virtual.
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 wait
Tempatkan CLI dalam status menunggu hingga kondisi apim terpenuhi.
az apim wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Contoh
Tempatkan CLI dalam status tunggu sampai kondisi apim terpenuhi. (dibuat otomatis)
az apim wait --created --name MyApim --resource-group MyResourceGroup
Parameter yang Diperlukan
Nama instans layanan api management.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
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.