az apic environment

  • Referensi

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
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Contoh

Membuat lingkungan

az apic environment create -g api-center-test -s contosoeuap --environment-id public --title "Public cloud" --type "development"

Parameter yang Diperlukan

--environment-id

Id lingkungan.

--resource-group -g

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

--service --service-name -s

Nama layanan API Center.

--title

Judul lingkungan.

--type

Jenis lingkungan.

nilai yang diterima: development, production, staging, testing

Parameter Opsional

--custom-properties

Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.

--description

Deskripsi lingkungan.

--onboarding

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.

--server

Informasi server lingkungan. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

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 apic environment delete

Hapus lingkungan.

az apic environment delete [--environment-id]
                           [--ids]
                           [--resource-group]
                           [--service]
                           [--subscription]
                           [--yes]

Contoh

Menghapus lingkungan

az apic environment delete -g api-center-test -s contosoeuap --environment-id public

Parameter Opsional

--environment-id

Id lingkungan.

--ids

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.

--resource-group -g

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

--service --service-name -s

Nama layanan API Center.

--subscription

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

--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 apic environment list

Mencantumkan kumpulan lingkungan.

az apic environment list --resource-group
                         --service
                         [--filter]
                         [--max-items]
                         [--next-token]

Contoh

Membuat daftar lingkungan

az apic environment list -g api-center-test -s contosoeuap

Parameter yang Diperlukan

--resource-group -g

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

--service --service-name -s

Nama layanan API Center.

Parameter Opsional

--filter

Parameter filter OData.

--max-items

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.

--next-token

Token untuk menentukan tempat untuk memulai paginating. Ini adalah nilai token dari respons yang dipotong sebelumnya.

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 apic environment show

Dapatkan detail lingkungan.

az apic environment show [--environment-id]
                         [--ids]
                         [--resource-group]
                         [--service]
                         [--subscription]

Contoh

Tampilkan detail lingkungan

az apic environment show -g api-center-test -s contosoeuap --environment-id public

Parameter Opsional

--environment-id

Id lingkungan.

--ids

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.

--resource-group -g

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

--service --service-name -s

Nama layanan API Center.

--subscription

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

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 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]
                           [--set]
                           [--subscription]
                           [--title]
                           [--type {development, production, staging, testing}]

Contoh

Memperbarui lingkungan

az apic environment update -g api-center-test -s contosoeuap --environment-id public --title "Public cloud"

Parameter Opsional

--add

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

--custom-properties

Metadata kustom yang ditentukan untuk entitas katalog API. Mendukung json-file dan yaml-file.

--description

Deskripsi.

--environment-id

Id lingkungan.

--force-string

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

nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

--onboarding

{developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--remove

Menghapus properti atau elemen dari daftar. Contoh: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--server

Informasi server lingkungan. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--service --service-name -s

Nama layanan API Center.

--set

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

--subscription

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

--title

Judul lingkungan.

--type

Jenis lingkungan.

nilai yang diterima: development, production, staging, testing
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.