az apic api definition

Referensi

Nota

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 definisi api az apic. Pelajari selengkapnya tentang ekstensi.

Perintah untuk mengelola definisi API di API Center.

Perintah

Nama	Deskripsi	Jenis	Status
az apic api definition create	Buat definisi API baru atau perbarui definisi API yang ada.	Ekstensi	GA
az apic api definition delete	Hapus definisi API yang ditentukan.	Ekstensi	GA
az apic api definition export-specification	Mengekspor spesifikasi API.	Ekstensi	GA
az apic api definition import-specification	Mengimpor spesifikasi API.	Ekstensi	GA
az apic api definition list	Mencantumkan kumpulan definisi API.	Ekstensi	GA
az apic api definition show	Dapatkan detail definisi API.	Ekstensi	GA
az apic api definition update	Perbarui definisi API yang ada.	Ekstensi	GA

az apic api definition create

Buat definisi API baru atau perbarui definisi API yang ada.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

Contoh

Membuat definisi API

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Parameter yang Diperlukan

--api-id

The id of the API.

--definition-id

Id definisi API.

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

--title

Versi API.

--version-id

Id versi API.

Parameter Opsional

--description

Deskripsi definisi API.

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan 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 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.

az apic api definition delete

Hapus definisi API yang ditentukan.

az apic api definition delete [--api-id]
                              [--definition-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--version-id]
                              [--yes]

Contoh

Menghapus definisi API

az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Parameter Opsional

--api-id

The id of the API.

--definition-id

Id definisi API.

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

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

--subscription

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

--version-id

Id versi API.

--yes -y

Jangan meminta konfirmasi.

Nilai default: False

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan 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 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.

az apic api definition export-specification

Mengekspor spesifikasi API.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Contoh

Spesifikasi Ekspor

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

Parameter yang Diperlukan

--file-name

Nama file tempat mengekspor spesifikasi.

Parameter Opsional

--api-id

The id of the API.

--definition-id

Id definisi API.

--ids

--no-wait

Jangan menunggu operasi jangka panjang selesai.

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

--service-name -n

Nama layanan Azure API Center.

--subscription

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

--version-id

Id versi API.

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan 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 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.

az apic api definition import-specification

Mengimpor spesifikasi API.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Contoh

Contoh spesifikasi impor 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

Contoh spesifikasi impor 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://petstore3.swagger.io/api/v3/openapi.json' --specification '{"name":"openapi","version":"3.0.0"}'

Impor spesifikasi dari contoh file

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json'

Parameter yang Diperlukan

--format

Format sumber spesifikasi API.

Nilai yang diterima: inline, link

--specification

Detail spesifikasi API. Mendukung shorthand-sintaks, json-file dan yaml-file. Coba "??" untuk menunjukkan lebih banyak.

--value

Nilai sumber spesifikasi API.

Parameter Opsional

--api-id

The id of the API.

--definition-id

Id definisi API.

--ids

--no-wait

Jangan menunggu operasi jangka panjang selesai.

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

--service-name -n

Nama layanan Azure API Center.

--subscription

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

--version-id

Id versi API.

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan 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 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.

az apic api definition list

Mencantumkan kumpulan definisi API.

az apic api definition list --api-id
                            --resource-group
                            --service-name
                            --version-id
                            [--filter]
                            [--max-items]
                            [--next-token]

Contoh

Mencantumkan definisi API

az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

Parameter yang Diperlukan

--api-id

The id of the API.

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

--version-id

Id versi API.

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

--next-token

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

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan 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 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.

az apic api definition show

Dapatkan detail definisi API.

az apic api definition show [--api-id]
                            [--definition-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]
                            [--version-id]

Contoh

Tampilkan detail definisi API

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

Parameter Opsional

--api-id

The id of the API.

--definition-id

Id definisi API.

--ids

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

--subscription

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

--version-id

Id versi API.

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan 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 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.

az apic api definition update

Perbarui definisi API yang ada.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Contoh

Memperbarui definisi API

az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Parameter Opsional

--add

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

--api-id

The id of the API.

--definition-id

Id definisi API.

--description

Deskripsi definisi API.

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

--remove

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

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

--set

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

--subscription

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

--title

Judul versi API.

--version-id

Id versi API.

Parameter Global

--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan 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 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.

Bagikan melalui

az apic api definition

Perintah

az apic api definition create

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apic api definition delete

Contoh

Parameter Opsional

az apic api definition export-specification

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apic api definition import-specification

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apic api definition list

Contoh

Parameter yang Diperlukan

Parameter Opsional

az apic api definition show

Contoh

Parameter Opsional

az apic api definition update

Contoh

Parameter Opsional

Sumber Daya Tambahan: