Bagikan melalui

az apic metadata

Note

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

 Extension GA
az apic metadata delete

Hapus skema metadata yang ditentukan.

 Extension GA
az apic metadata export

Mengekspor skema metadata.

 Extension GA
az apic metadata list

Mencantumkan kumpulan skema metadata.

 Extension GA
az apic metadata show

Dapatkan detail skema metadata.

 Extension GA
az apic metadata update

Perbarui skema metadata yang ada.

 Extension 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

--assignments

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.

Properti Nilai
Grup parameter: Properties Arguments
--metadata-name

Nama skema metadata.

--resource-group -g

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

--schema

Skema JSON yang menentukan jenisnya.

Properti Nilai
Grup parameter: Properties Arguments
--service-name -n

Nama layanan Azure API Center.

Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

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"

Hapus skema

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--ids

Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

Properti Nilai
Grup parameter: Resource Id Arguments
--metadata-name

Nama skema metadata.

Properti Nilai
Grup parameter: Resource Id Arguments
--resource-group -g

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

Properti Nilai
Grup parameter: Resource Id Arguments
--service-name -n

Nama layanan Azure API Center.

Properti Nilai
Grup parameter: Resource Id Arguments
--subscription

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

Properti Nilai
Grup parameter: Resource Id Arguments
--yes -y

Jangan meminta konfirmasi.

Properti Nilai
Nilai default: False
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

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

--assignments

Entitas yang diminta oleh skema metadata.

Properti Nilai
Grup parameter: Payload Arguments
Nilai yang diterima: api, deployment, environment
--file-name

Nama file tempat mengekspor skema metadata.

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--custom-metadata-only

Ekspor hanya metadata kustom.

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

Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

Properti Nilai
Grup parameter: Resource Id Arguments
--no-wait

Jangan menunggu operasi jangka panjang selesai.

Properti Nilai
Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Properti Nilai
Grup parameter: Resource Id Arguments
--service-name -n

Nama layanan API Center.

Properti Nilai
Grup parameter: Resource Id Arguments
--subscription

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

Properti Nilai
Grup parameter: Resource Id Arguments
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

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

--resource-group -g

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

--service-name -n

Nama layanan Azure API Center.

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--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 argumen --next-token dari perintah berikutnya.

Properti Nilai
Grup parameter: Pagination Arguments
--next-token

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

Properti Nilai
Grup parameter: Pagination Arguments
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

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

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

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

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--ids

Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

Properti Nilai
Grup parameter: Resource Id Arguments
--metadata-name

Nama skema metadata.

Properti Nilai
Grup parameter: Resource Id Arguments
--resource-group -g

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

Properti Nilai
Grup parameter: Resource Id Arguments
--service-name -n

Nama layanan Azure API Center.

Properti Nilai
Grup parameter: Resource Id Arguments
--subscription

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

Properti Nilai
Grup parameter: Resource Id Arguments
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

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

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--add

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

Properti Nilai
Grup parameter: Generic Update Arguments
--assignments

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.

Properti Nilai
Grup parameter: Properties Arguments
--force-string

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

Properti Nilai
Grup parameter: Generic Update Arguments
Nilai yang diterima: 0, 1, f, false, n, no, t, true, y, yes
--ids

Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

Properti Nilai
Grup parameter: Resource Id Arguments
--metadata-name

Nama skema metadata.

Properti Nilai
Grup parameter: Resource Id Arguments
--remove

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

Properti Nilai
Grup parameter: Generic Update Arguments
--resource-group -g

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

Properti Nilai
Grup parameter: Resource Id Arguments
--schema

Skema YAML yang menentukan jenisnya.

Properti Nilai
Grup parameter: Properties Arguments
--service-name -n

Nama layanan Azure API Center.

Properti Nilai
Grup parameter: Resource Id Arguments
--set

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

Properti Nilai
Grup parameter: Generic Update Arguments
--subscription

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

Properti Nilai
Grup parameter: Resource Id Arguments
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

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

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False