az apic metadata
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 metadata az apic. Pelajari lebih lanjut tentang ekstensi.
Perintah untuk mengelola skema metadata di API Center.
Perintah
Nama | Deskripsi | Jenis | Status |
---|---|---|---|
az apic metadata create |
Buat skema metadata baru atau perbarui skema metadata yang ada. |
Ekstensi | GA |
az apic metadata delete |
Hapus skema metadata yang ditentukan. |
Ekstensi | GA |
az apic metadata export |
Mengekspor skema metadata. |
Ekstensi | GA |
az apic metadata list |
Mencantumkan kumpulan skema metadata. |
Ekstensi | GA |
az apic metadata show |
Dapatkan detail skema metadata. |
Ekstensi | GA |
az apic metadata update |
Perbarui skema metadata yang ada. |
Ekstensi | GA |
az apic metadata create
Buat skema metadata baru atau perbarui skema metadata yang ada.
az apic metadata create --assignments
--metadata-name
--resource-group
--schema
--service-name
Contoh
Membuat contoh metadata 1
az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'
Membuat contoh metadata 2
az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'
Membuat metadata menggunakan skema file json dan contoh penugasan
az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'
Parameter yang Diperlukan
Menentukan cakupan penugasan untuk metadata kustom, misalnya "[{entity:api,required:true,deprecated:false}]". Nilai entitas yang tersedia adalah: api, penyebaran, lingkungan. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
Nama skema metadata.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Skema JSON yang menentukan jenisnya.
Nama layanan Azure API Center.
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 metadata delete
Hapus skema metadata yang ditentukan.
az apic metadata delete [--ids]
[--metadata-name]
[--resource-group]
[--service-name]
[--subscription]
[--yes]
Contoh
Menghapus Skema Metadata
az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"
Menghapus skema
az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"
Parameter Opsional
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 skema metadata.
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 metadata export
Mengekspor skema metadata.
az apic metadata export --assignments {api, deployment, environment}
--file-name
[--custom-metadata-only {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service-name]
[--subscription]
Contoh
Ekspor Skema Metadata yang ditetapkan ke api
az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json
Ekspor Skema Metadata yang ditetapkan untuk penyebaran
az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json
Mengekspor Skema Metadata yang ditetapkan ke lingkungan
az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json
Ekspor Skema Metadata Kustom Saja
az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json --custom-metadata-only
Parameter yang Diperlukan
Entitas yang diminta oleh skema metadata.
Nama file tempat mengekspor skema metadata.
Parameter Opsional
Ekspor hanya metadata kustom.
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.
Jangan menunggu operasi jangka panjang selesai.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Nama layanan 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 metadata list
Mencantumkan kumpulan skema metadata.
az apic metadata list --resource-group
--service-name
[--filter]
[--max-items]
[--next-token]
Contoh
Mencantumkan skema
az apic metadata 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 metadata show
Dapatkan detail skema metadata.
az apic metadata show [--ids]
[--metadata-name]
[--resource-group]
[--service-name]
[--subscription]
Contoh
Perlihatkan detail skema 1
az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver
Perlihatkan detail skema 2
az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"
Parameter Opsional
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 skema metadata.
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 metadata update
Perbarui skema metadata yang ada.
az apic metadata update [--add]
[--assignments]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--metadata-name]
[--remove]
[--resource-group]
[--schema]
[--service-name]
[--set]
[--subscription]
Contoh
Memperbarui skema
az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'
Memperbarui skema menggunakan file json skema
az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'
Parameter Opsional
Tambahkan objek ke daftar objek dengan menentukan jalur dan pasangan nilai kunci. Contoh: --add property.listProperty <key=value, string or JSON string>
.
Menentukan cakupan penugasan untuk metadata kustom, misalnya "[{entity:api,required:true,deprecated:false}]". Nilai entitas yang tersedia adalah: api, penyebaran, lingkungan. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.
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.
Nama skema metadata.
Menghapus properti atau elemen dari daftar. Contoh: --remove property.list <indexToRemove>
ATAU --remove propertyToRemove
.
Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>
.
Skema YAML yang menentukan jenisnya.
Nama layanan Azure API Center.
Perbarui objek dengan menentukan jalur properti dan nilai yang akan diatur. Contoh: --set property1.property2=<value>
.
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.