az apic environment
Catatan
Referensi ini adalah bagian dari ekstensi apic-extension untuk Azure CLI (versi 2.57.0 atau yang lebih tinggi). Ekstensi akan secara otomatis menginstal pertama kali Anda menjalankan perintah lingkungan az apic. Pelajari lebih lanjut tentang ekstensi.
Perintah untuk mengelola lingkungan di API Center.
Perintah
Nama | Deskripsi | Jenis | Status |
---|---|---|---|
az apic environment create |
Buat lingkungan baru atau perbarui lingkungan yang sudah ada. |
Ekstensi | GA |
az apic environment delete |
Hapus lingkungan. |
Ekstensi | GA |
az apic environment list |
Mencantumkan kumpulan lingkungan. |
Ekstensi | GA |
az apic environment show |
Dapatkan detail lingkungan. |
Ekstensi | GA |
az apic environment update |
Perbarui lingkungan yang ada. |
Ekstensi | GA |
az apic environment create
Buat lingkungan baru atau perbarui lingkungan yang sudah ada.
az apic environment create --environment-id
--resource-group
--service-name
--title
--type {development, production, staging, testing}
[--custom-properties]
[--description]
[--onboarding]
[--server]
Contoh
Membuat lingkungan
az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"
Parameter yang Diperlukan
Id lingkungan.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Judul lingkungan.
Jenis lingkungan.
Parameter Opsional
Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.
Deskripsi lingkungan.
Berikan dokumentasi onboarding yang terkait dengan lingkungan Anda, misalnya {developerPortalUri:['https://developer.contoso.com'],instruksi:'petunjuk markdown'} Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Informasi server lingkungan. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
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 apic environment delete
Hapus lingkungan.
az apic environment delete [--environment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--yes]
Contoh
Menghapus lingkungan
az apic environment delete -g api-center-test -n contosoeuap --environment-id public
Parameter Opsional
Id lingkungan.
Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
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 apic environment list
Mencantumkan kumpulan lingkungan.
az apic environment list --resource-group
--service-name
[--filter]
[--max-items]
[--next-token]
Contoh
Membuat daftar lingkungan
az apic environment list -g api-center-test -n contosoeuap
Parameter yang Diperlukan
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Parameter Opsional
Parameter filter OData.
Jumlah total item yang akan dikembalikan dalam output perintah. Jika jumlah total item yang tersedia lebih dari nilai yang ditentukan, token disediakan dalam output perintah. Untuk melanjutkan penomoran halaman, berikan nilai token dalam --next-token
argumen perintah berikutnya.
Token untuk menentukan tempat untuk memulai paginating. Ini adalah nilai token dari respons yang dipotong sebelumnya.
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 apic environment show
Dapatkan detail lingkungan.
az apic environment show [--environment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
Contoh
Tampilkan detail lingkungan
az apic environment show -g api-center-test -n contosoeuap --environment-id public
Parameter Opsional
Id lingkungan.
Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan Azure API Center.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
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 apic environment update
Perbarui lingkungan yang ada.
az apic environment update [--add]
[--custom-properties]
[--description]
[--environment-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--onboarding]
[--remove]
[--resource-group]
[--server]
[--service-name]
[--set]
[--subscription]
[--title]
[--type {development, production, staging, testing}]
Contoh
Memperbarui lingkungan
az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"
Parameter Opsional
Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string, atau string JSON>.
Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.
Deskripsi.
Id lingkungan.
Saat menggunakan 'set' atau 'add', pertahankan literal string alih-alih mencoba mengonversi ke JSON.
Satu atau beberapa ID sumber daya (dibatasi ruang). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.
{developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Menghapus properti atau elemen dari daftar. Contoh: --remove property.list OR --remove propertyToRemove.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Informasi server lingkungan. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Nama layanan Azure API Center.
Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=.
Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID
.
Judul lingkungan.
Jenis lingkungan.
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.